From 45f4e3d6a346581cbc90b8fe2d713277c1362873 Mon Sep 17 00:00:00 2001 From: John DiSanti Date: Fri, 2 Jul 2021 10:21:07 -0700 Subject: [PATCH] Update AWS SDK models (#575) --- aws/sdk/aws-models/accessanalyzer.json | 2 +- aws/sdk/aws-models/amp.json | 2 +- aws/sdk/aws-models/amplifybackend.json | 264 +- aws/sdk/aws-models/appmesh.json | 2 +- aws/sdk/aws-models/autoscaling.json | 45 +- aws/sdk/aws-models/braket.json | 2 +- aws/sdk/aws-models/chime.json | 165 +- aws/sdk/aws-models/cloud9.json | 104 +- aws/sdk/aws-models/cloudformation.json | 1396 ++++++++++- aws/sdk/aws-models/cloudfront.json | 4 + aws/sdk/aws-models/cloudsearch.json | 74 +- aws/sdk/aws-models/codebuild.json | 303 ++- aws/sdk/aws-models/codeguru-reviewer.json | 465 +++- aws/sdk/aws-models/codeguruprofiler.json | 2 +- aws/sdk/aws-models/connect.json | 510 +++- aws/sdk/aws-models/databrew.json | 259 +- aws/sdk/aws-models/dax.json | 55 +- aws/sdk/aws-models/docdb.json | 364 ++- aws/sdk/aws-models/ec2.json | 1264 ++++++++-- aws/sdk/aws-models/elasticache.json | 282 ++- aws/sdk/aws-models/elasticbeanstalk.json | 72 +- aws/sdk/aws-models/elasticloadbalancing.json | 88 + .../aws-models/elasticloadbalancingv2.json | 148 ++ aws/sdk/aws-models/email.json | 136 ++ aws/sdk/aws-models/eventbridge.json | 318 ++- aws/sdk/aws-models/events.json | 318 ++- aws/sdk/aws-models/glue.json | 380 +-- aws/sdk/aws-models/greengrassv2.json | 394 ++- aws/sdk/aws-models/groundstation.json | 2 +- aws/sdk/aws-models/iam.json | 108 + aws/sdk/aws-models/iotanalytics.json | 135 +- aws/sdk/aws-models/kendra.json | 351 ++- aws/sdk/aws-models/kms.json | 542 ++++- aws/sdk/aws-models/license-manager.json | 112 +- aws/sdk/aws-models/location.json | 2 +- aws/sdk/aws-models/lookoutmetrics.json | 14 +- aws/sdk/aws-models/mediaconnect.json | 58 + aws/sdk/aws-models/mediaconvert.json | 1189 +++++++++- aws/sdk/aws-models/medialive.json | 111 +- aws/sdk/aws-models/mediapackage-vod.json | 7 + aws/sdk/aws-models/mediatailor.json | 80 + aws/sdk/aws-models/mgn.json | 2 +- aws/sdk/aws-models/models.lex.v2.json | 52 +- aws/sdk/aws-models/monitoring.json | 68 +- aws/sdk/aws-models/mwaa.json | 2 +- aws/sdk/aws-models/neptune.json | 252 ++ aws/sdk/aws-models/proton.json | 302 ++- aws/sdk/aws-models/quicksight.json | 1895 +++++++++++++-- aws/sdk/aws-models/rds-data.json | 2 +- aws/sdk/aws-models/rds.json | 944 ++++++-- aws/sdk/aws-models/redshift-data.json | 67 +- aws/sdk/aws-models/redshift.json | 479 ++++ aws/sdk/aws-models/route53.json | 17 + aws/sdk/aws-models/runtime.lex.v2.json | 209 +- aws/sdk/aws-models/sagemaker.json | 772 ++++-- aws/sdk/aws-models/securityhub.json | 2113 +++++++++++++++-- aws/sdk/aws-models/servicediscovery.json | 579 ++++- aws/sdk/aws-models/snowball.json | 270 ++- aws/sdk/aws-models/sns.json | 104 + aws/sdk/aws-models/sqs.json | 126 +- aws/sdk/aws-models/ssm-contacts.json | 23 +- aws/sdk/aws-models/ssm-incidents.json | 2 +- aws/sdk/aws-models/sts.json | 58 +- aws/sdk/aws-models/transfer.json | 151 +- aws/sdk/aws-models/wafv2.json | 647 ++--- 65 files changed, 16552 insertions(+), 2713 deletions(-) diff --git a/aws/sdk/aws-models/accessanalyzer.json b/aws/sdk/aws-models/accessanalyzer.json index b26107128..f2a87af9d 100644 --- a/aws/sdk/aws-models/accessanalyzer.json +++ b/aws/sdk/aws-models/accessanalyzer.json @@ -4823,4 +4823,4 @@ } } } -} +} \ No newline at end of file diff --git a/aws/sdk/aws-models/amp.json b/aws/sdk/aws-models/amp.json index 84043fdc5..cd66167b6 100644 --- a/aws/sdk/aws-models/amp.json +++ b/aws/sdk/aws-models/amp.json @@ -935,4 +935,4 @@ } } } -} +} \ No newline at end of file diff --git a/aws/sdk/aws-models/amplifybackend.json b/aws/sdk/aws-models/amplifybackend.json index 75e48e3d8..574fafd0a 100644 --- a/aws/sdk/aws-models/amplifybackend.json +++ b/aws/sdk/aws-models/amplifybackend.json @@ -107,6 +107,9 @@ { "target": "com.amazonaws.amplifybackend#GetToken" }, + { + "target": "com.amazonaws.amplifybackend#ImportBackendAuth" + }, { "target": "com.amazonaws.amplifybackend#ListBackendJobs" }, @@ -166,21 +169,21 @@ "CognitoUserPoolId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

The Amazon Cognito user pool ID, if Amazon Cognito is used as an authentication setting to access your data models.

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

The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

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

The API key description for API_KEY, if it is used as an authentication mechanism to access your data models.

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

The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

", "smithy.api#jsonName": "description" } }, "ExpirationTime": { "target": "com.amazonaws.amplifybackend#__double", "traits": { - "smithy.api#documentation": "

The API key expiration time for API_KEY, if it is used as an authentication mechanism to access your data models.

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

The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

", "smithy.api#jsonName": "expirationTime" } }, @@ -194,7 +197,7 @@ "OpenIDClientId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

The clientID for openID, if openID is used as an authentication setting to access your data models.

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

The clientID for openID, if openID was used as an authentication setting to access your data models.

", "smithy.api#jsonName": "openIDClientId" } }, @@ -208,14 +211,14 @@ "OpenIDIssueURL": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

The openID issuer URL, if openID is used as an authentication setting to access your data models.

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

The openID issuer URL, if openID was used as an authentication setting to access your data models.

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

The openID provider name, if openID is used as an authentication mechanism to access your data models.

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

The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

", "smithy.api#jsonName": "openIDProviderName" } } @@ -258,7 +261,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the conflict resolution configuration for the data model configured in your Amplify project.

" + "smithy.api#documentation": "

Describes the conflict resolution configuration for your data model configured in your Amplify project.

" } }, "com.amazonaws.amplifybackend#BackendAPIResourceConfig": { @@ -274,7 +277,7 @@ "ApiName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

The API name used to interact with the data model, configured as a part of the Amplify project.

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

The API name used to interact with the data model, configured as a part of the amplify project.

", "smithy.api#jsonName": "apiName" } }, @@ -308,7 +311,7 @@ } }, "traits": { - "smithy.api#documentation": "

The resource configuration for the data model, configured as a part of the Amplify project.

" + "smithy.api#documentation": "

The resource config for the data model, configured as a part of the Amplify project.

" } }, "com.amazonaws.amplifybackend#BackendAuthSocialProviderConfig": { @@ -317,14 +320,14 @@ "ClientId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

Describes the client_id that can be obtained from the third-party social federation provider.

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

Describes the client_id which can be obtained from the third-party social federation provider.

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

Describes the client_secret that can be obtained from third-party social federation providers.

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

Describes the client_secret which can be obtained from third-party social federation providers.

", "smithy.api#jsonName": "client_secret" } } @@ -362,7 +365,7 @@ "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

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

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, @@ -499,7 +502,7 @@ "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

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

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, @@ -648,7 +651,7 @@ "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

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

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, @@ -712,7 +715,7 @@ "DeliveryMethod": { "target": "com.amazonaws.amplifybackend#DeliveryMethod", "traits": { - "smithy.api#documentation": "

Describes which method to use (either SMS or email) to deliver messages to app users that want to recover their password.

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

Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.

", "smithy.api#jsonName": "deliveryMethod", "smithy.api#required": {} } @@ -742,7 +745,7 @@ "IdentityPoolName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

Name of the identity pool used for authorization.

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

Name of the Amazon Cognito identity pool used for authorization.

", "smithy.api#jsonName": "identityPoolName", "smithy.api#required": {} } @@ -766,7 +769,7 @@ "MFAMode": { "target": "com.amazonaws.amplifybackend#MFAMode", "traits": { - "smithy.api#documentation": "

Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.

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

Describes whether MFA should be [ON, OFF, OPTIONAL] for authentication in your Amplify project.

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

Describes whether to apply multi-factor authentication (MFA) policies for your Amazon Cognito user pool that's configured as a part of your Amplify project.

" + "smithy.api#documentation": "

Describes whether multi-factor authentication policies should be applied for your Amazon Cognito user pool configured as a part of your Amplify project.

" } }, "com.amazonaws.amplifybackend#CreateBackendAuthOAuthConfig": { @@ -803,7 +806,7 @@ "OAuthScopes": { "target": "com.amazonaws.amplifybackend#ListOfOAuthScopesElement", "traits": { - "smithy.api#documentation": "

List of OAuth-related flows that allow your app users to authenticate from your Amplify app.

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

List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.

", "smithy.api#jsonName": "oAuthScopes", "smithy.api#required": {} } @@ -819,7 +822,7 @@ "RedirectSignOutURIs": { "target": "com.amazonaws.amplifybackend#ListOf__string", "traits": { - "smithy.api#documentation": "

Redirect URLs that OAuth uses when a user signs out of an Amplify app.

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

Redirect URLs used by OAuth when a user signs out of an Amplify app.

", "smithy.api#jsonName": "redirectSignOutURIs", "smithy.api#required": {} } @@ -827,7 +830,7 @@ "SocialProviderSettings": { "target": "com.amazonaws.amplifybackend#SocialProviderSettings", "traits": { - "smithy.api#documentation": "

The settings for using social identity providers for access to your Amplify app.

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

The settings for using social providers to access your Amplify app.

", "smithy.api#jsonName": "socialProviderSettings" } } @@ -856,7 +859,7 @@ } }, "traits": { - "smithy.api#documentation": "

The password policy configuration for the backend of your Amplify project.

" + "smithy.api#documentation": "

The password policy configuration for the backend to your Amplify project.

" } }, "com.amazonaws.amplifybackend#CreateBackendAuthRequest": { @@ -913,7 +916,7 @@ "IdentityPoolConfigs": { "target": "com.amazonaws.amplifybackend#CreateBackendAuthIdentityPoolConfig", "traits": { - "smithy.api#documentation": "

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of the auth resource in your Amplify project.

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

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.

", "smithy.api#jsonName": "identityPoolConfigs" } }, @@ -928,7 +931,7 @@ "UserPoolConfigs": { "target": "com.amazonaws.amplifybackend#CreateBackendAuthUserPoolConfig", "traits": { - "smithy.api#documentation": "

Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of the auth resource in your Amplify project.

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

Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.

", "smithy.api#jsonName": "userPoolConfigs", "smithy.api#required": {} } @@ -958,7 +961,7 @@ "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

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

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, @@ -998,7 +1001,7 @@ "Mfa": { "target": "com.amazonaws.amplifybackend#CreateBackendAuthMFAConfig", "traits": { - "smithy.api#documentation": "

Describes whether to apply multi-factor authentication (MFA) policies for your Amazon Cognito user pool that's configured as a part of your Amplify project.

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

Describes whether multi-factor authentication policies should be applied for your Amazon Cognito user pool configured as a part of your Amplify project.

", "smithy.api#jsonName": "mfa" } }, @@ -1019,7 +1022,7 @@ "RequiredSignUpAttributes": { "target": "com.amazonaws.amplifybackend#ListOfRequiredSignUpAttributesElement", "traits": { - "smithy.api#documentation": "

The required attributes to sign up new users in the Amazon Cognito user pool.

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

The required attributes to sign up new users in the user pool.

", "smithy.api#jsonName": "requiredSignUpAttributes", "smithy.api#required": {} } @@ -1027,7 +1030,7 @@ "SignInMethod": { "target": "com.amazonaws.amplifybackend#SignInMethod", "traits": { - "smithy.api#documentation": "

Describes the sign-in methods that your Amplify app users to log in using the Amazon Cognito user pool that's configured as a part of your Amplify project.

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

Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.

", "smithy.api#jsonName": "signInMethod", "smithy.api#required": {} } @@ -1162,7 +1165,7 @@ "ResourceConfig": { "target": "com.amazonaws.amplifybackend#ResourceConfig", "traits": { - "smithy.api#documentation": "

The resource configuration for the backend creation request.

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

The resource configuration for the create backend request.

", "smithy.api#jsonName": "resourceConfig" } }, @@ -1198,7 +1201,7 @@ "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

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

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, @@ -1423,7 +1426,7 @@ "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

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

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, @@ -1533,7 +1536,7 @@ "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

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

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, @@ -1601,7 +1604,7 @@ "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

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

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, @@ -1829,7 +1832,7 @@ "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

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

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, @@ -1987,7 +1990,7 @@ "Models": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

Stringified JSON of the DataStore model.

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

Stringified JSON of the datastore model.

", "smithy.api#jsonName": "models" } }, @@ -2059,7 +2062,7 @@ "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

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

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, @@ -2102,7 +2105,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets backend auth details.

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

Gets a backend auth details.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/auth/{BackendEnvironmentName}/details", @@ -2162,7 +2165,7 @@ "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

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

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, @@ -2269,7 +2272,7 @@ "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

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

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, @@ -2332,7 +2335,7 @@ "AmplifyMetaConfig": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

A stringified version of the current configurations for your Amplify project.

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

A stringified version of the current configs for your Amplify project.

", "smithy.api#jsonName": "amplifyMetaConfig" } }, @@ -2458,6 +2461,139 @@ } } }, + "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 current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, "com.amazonaws.amplifybackend#ListBackendJobs": { "type": "operation", "input": { @@ -2615,7 +2751,7 @@ "AwsCognitoIdentityPoolId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

The Amazon Cognito identity pool ID used for Amplify Admin UI login authorization.

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

The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.

", "smithy.api#jsonName": "aws_cognito_identity_pool_id" } }, @@ -2708,14 +2844,14 @@ "Message": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

An error message to inform that the request failed.

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

An error message to inform that the request has failed.

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

The type of resource that wasn't found.

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

The type of resource that is not found.

", "smithy.api#jsonName": "resourceType" } } @@ -2835,7 +2971,7 @@ "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

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

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, @@ -2885,7 +3021,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the AWS resources that are required to access the Amplify Admin UI.

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

Removes the AWS resources required to access the Amplify Admin UI.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/config/remove", @@ -2912,7 +3048,7 @@ "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

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

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } } @@ -3139,13 +3275,13 @@ "Message": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

An error message to inform that the request failed.

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

An error message to inform that the request has failed.

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

An error that is returned when a limit of a specific type is exceeded.

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

An error that is returned when a limit of a specific type has been exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -3240,7 +3376,7 @@ "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

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

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, @@ -3304,7 +3440,7 @@ "DeliveryMethod": { "target": "com.amazonaws.amplifybackend#DeliveryMethod", "traits": { - "smithy.api#documentation": "

Describes which method to use (either SMS or email) to deliver messages to app users that want to recover their password.

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

Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.

", "smithy.api#jsonName": "deliveryMethod" } }, @@ -3333,7 +3469,7 @@ "UnauthenticatedLogin": { "target": "com.amazonaws.amplifybackend#__boolean", "traits": { - "smithy.api#documentation": "

A Boolean value that you can set to allow or disallow guest-level authorization into your Amplify app.

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

A boolean value which can be set to allow or disallow guest-level authorization into your Amplify app.

", "smithy.api#jsonName": "unauthenticatedLogin" } } @@ -3390,14 +3526,14 @@ "RedirectSignInURIs": { "target": "com.amazonaws.amplifybackend#ListOf__string", "traits": { - "smithy.api#documentation": "

Redirect URLs that OAuth uses when a user signs in to an Amplify app.

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

Redirect URLs used by OAuth when a user signs in to an Amplify app.

", "smithy.api#jsonName": "redirectSignInURIs" } }, "RedirectSignOutURIs": { "target": "com.amazonaws.amplifybackend#ListOf__string", "traits": { - "smithy.api#documentation": "

Redirect URLs that OAuth uses when a user signs out of an Amplify app.

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

Redirect URLs used by OAuth when a user signs out of an Amplify app.

", "smithy.api#jsonName": "redirectSignOutURIs" } }, @@ -3419,7 +3555,7 @@ "AdditionalConstraints": { "target": "com.amazonaws.amplifybackend#ListOfAdditionalConstraintsElement", "traits": { - "smithy.api#documentation": "

Describes additional constrains on the password requirements to sign in to the auth resource, configured as a part of your Amplify project.

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

Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project.

", "smithy.api#jsonName": "additionalConstraints" } }, @@ -3432,7 +3568,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the password policy for your Amazon Cognito user pool that's configured as a part of your Amplify project.

" + "smithy.api#documentation": "

Describes the password policy for your Amazon Cognito user pool configured as a part of your Amplify project.

" } }, "com.amazonaws.amplifybackend#UpdateBackendAuthRequest": { @@ -3489,7 +3625,7 @@ "IdentityPoolConfigs": { "target": "com.amazonaws.amplifybackend#UpdateBackendAuthIdentityPoolConfig", "traits": { - "smithy.api#documentation": "

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of the auth resource in your Amplify project.

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

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.

", "smithy.api#jsonName": "identityPoolConfigs" } }, @@ -3504,7 +3640,7 @@ "UserPoolConfigs": { "target": "com.amazonaws.amplifybackend#UpdateBackendAuthUserPoolConfig", "traits": { - "smithy.api#documentation": "

Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of the auth resource in your Amplify project.

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

Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.

", "smithy.api#jsonName": "userPoolConfigs", "smithy.api#required": {} } @@ -3534,7 +3670,7 @@ "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

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

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, @@ -3574,7 +3710,7 @@ "Mfa": { "target": "com.amazonaws.amplifybackend#UpdateBackendAuthMFAConfig", "traits": { - "smithy.api#documentation": "

Describes whether to apply multi-factor authentication (MFA) policies for your Amazon Cognito user pool that's configured as a part of your Amplify project.

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

Describes whether multi-factor authentication policies should be applied for your Amazon Cognito user pool configured as a part of your Amplify project.

", "smithy.api#jsonName": "mfa" } }, @@ -3594,7 +3730,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the Amazon Cognito user pool configuration to configure the authorization resource for your Amplify project on an update.

" + "smithy.api#documentation": "

Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.

" } }, "com.amazonaws.amplifybackend#UpdateBackendConfig": { @@ -3620,7 +3756,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the AWS resources that are required to access the Amplify Admin UI.

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

Updates the AWS resources required to access the Amplify Admin UI.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/config/update", @@ -3671,7 +3807,7 @@ "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

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

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, @@ -3745,7 +3881,7 @@ "Operation": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

Filters the list of response objects to include only those with the specified operation name.

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

Filters the list of response objects to only include those with the specified operation name.

", "smithy.api#jsonName": "operation" } }, @@ -3788,7 +3924,7 @@ "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

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

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, diff --git a/aws/sdk/aws-models/appmesh.json b/aws/sdk/aws-models/appmesh.json index 9273d629e..9b2500c5a 100644 --- a/aws/sdk/aws-models/appmesh.json +++ b/aws/sdk/aws-models/appmesh.json @@ -8671,4 +8671,4 @@ } } } -} +} \ No newline at end of file diff --git a/aws/sdk/aws-models/autoscaling.json b/aws/sdk/aws-models/autoscaling.json index 65f6194ea..8e6d4d4bf 100644 --- a/aws/sdk/aws-models/autoscaling.json +++ b/aws/sdk/aws-models/autoscaling.json @@ -565,6 +565,12 @@ "traits": { "smithy.api#documentation": "

The current size of the warm pool.

" } + }, + "Context": { + "target": "com.amazonaws.autoscaling#Context", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } } }, "traits": { @@ -960,7 +966,7 @@ "name": "autoscaling" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "Amazon EC2 Auto Scaling\n \n \n \n \n \n \n

Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances\n based on user-defined scaling policies, scheduled actions, and health checks.

\n

For more information about Amazon EC2 Auto Scaling, see the Amazon EC2 Auto Scaling User Guide. For information about granting IAM users required\n permissions for calls to Amazon EC2 Auto Scaling, see Granting\n IAM users required permissions for Amazon EC2 Auto Scaling resources in the\n Amazon EC2 Auto Scaling API Reference.

", + "smithy.api#documentation": "Amazon EC2 Auto Scaling\n \n \n \n \n \n\n \n

Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances\n based on user-defined scaling policies, scheduled actions, and health checks.

\n

For more information about Amazon EC2 Auto Scaling, see the Amazon EC2 Auto Scaling User Guide. For information about granting IAM users required\n permissions for calls to Amazon EC2 Auto Scaling, see Granting\n IAM users required permissions for Amazon EC2 Auto Scaling resources in the\n Amazon EC2 Auto Scaling API Reference.

", "smithy.api#title": "Auto Scaling", "smithy.api#xmlNamespace": { "uri": "http://autoscaling.amazonaws.com/doc/2011-01-01/" @@ -1183,7 +1189,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels an instance refresh operation in progress. Cancellation does not roll back any\n replacements that have already been completed, but it prevents new replacements from\n being started.

\n

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

" + "smithy.api#documentation": "

Cancels an instance refresh operation in progress. Cancellation does not roll back any\n replacements that have already been completed, but it prevents new replacements from\n being started.

\n

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

" } }, "com.amazonaws.autoscaling#CancelInstanceRefreshAnswer": { @@ -1318,6 +1324,9 @@ } } }, + "com.amazonaws.autoscaling#Context": { + "type": "string" + }, "com.amazonaws.autoscaling#Cooldown": { "type": "integer", "traits": { @@ -1482,7 +1491,7 @@ "ServiceLinkedRoleARN": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other Amazon Web Services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role\n named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more\n information, see Service-linked\n roles in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other Amazon Web Services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role\n named AWSServiceRoleForAutoScaling, which it creates if it does not exist.\n For more information, see Service-linked\n roles in the Amazon EC2 Auto Scaling User Guide.

" } }, "MaxInstanceLifetime": { @@ -1490,6 +1499,12 @@ "traits": { "smithy.api#documentation": "

The maximum amount of time, in seconds, that an instance can be in service. The\n default is null. If specified, the value must be either 0 or a number equal to or\n greater than 86,400 seconds (1 day). For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the\n Amazon EC2 Auto Scaling User Guide.

" } + }, + "Context": { + "target": "com.amazonaws.autoscaling#Context", + "traits": { + "smithy.api#documentation": "

Reserved.

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

Describes the current Amazon EC2 Auto Scaling resource quotas for your account.

\n

For information about requesting an increase, see Amazon EC2 Auto Scaling service\n quotas in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Describes the current Amazon EC2 Auto Scaling resource quotas for your account.

\n

When you establish an account, the account has initial quotas on the maximum\n number of Auto Scaling groups and launch configurations that you can create in a given Region.\n For more information, see Amazon EC2 Auto Scaling service\n quotas in the Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#DescribeAccountLimitsAnswer": { @@ -2244,7 +2259,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

\n

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

\n

To help you determine the status of an instance refresh, this operation returns\n information about the instance refreshes you previously initiated, including their\n status, end time, the percentage of the instance refresh that is complete, and the\n number of instances remaining to update before the instance refresh is complete.

\n

The following are the possible statuses:

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

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

\n

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

\n

To help you determine the status of an instance refresh, this operation returns\n information about the instance refreshes you previously initiated, including their\n status, end time, the percentage of the instance refresh that is complete, and the\n number of instances remaining to update before the instance refresh is complete.

\n

The following are the possible statuses:

\n " } }, "com.amazonaws.autoscaling#DescribeInstanceRefreshesAnswer": { @@ -3156,13 +3171,13 @@ "Iops": { "target": "com.amazonaws.autoscaling#BlockDeviceEbsIops", "traits": { - "smithy.api#documentation": "

The number of input/output (I/O) operations per second (IOPS) to provision for the\n volume. For gp3 and io1 volumes, this represents the number of\n IOPS that are provisioned for the volume. For gp2 volumes, this represents\n the baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.

\n

The following are the supported values for each volume type:

\n \n\n

For io1 volumes, we guarantee 64,000 IOPS only for Instances\n built on the Nitro System. Other instance families guarantee performance up\n to 32,000 IOPS.

\n

\n Iops is supported when the volume type is gp3 or\n io1 and required only when the volume type is io1. (Not\n used with standard, gp2, st1, or sc1\n volumes.)

" + "smithy.api#documentation": "

The number of input/output (I/O) operations per second (IOPS) to provision for the\n volume. For gp3 and io1 volumes, this represents the number of\n IOPS that are provisioned for the volume. For gp2 volumes, this represents\n the baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.

\n

The following are the supported values for each volume type:

\n \n\n

For io1 volumes, we guarantee 64,000 IOPS only for Instances\n built on the Nitro System. Other instance families guarantee performance up\n to 32,000 IOPS.

\n

\n Iops is supported when the volume type is gp3 or\n io1 and required only when the volume type is io1. (Not\n used with standard, gp2, st1, or sc1\n volumes.)

" } }, "Encrypted": { "target": "com.amazonaws.autoscaling#BlockDeviceEbsEncrypted", "traits": { - "smithy.api#documentation": "

Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be\n attached to instances that support Amazon EBS encryption. For more information, see\n Supported Instance Types. If your AMI uses encrypted volumes, you can also\n only launch it on supported instance types.

\n \n

If you are creating a volume from a snapshot, you cannot specify an encryption\n value. Volumes that are created from encrypted snapshots are automatically\n encrypted, and volumes that are created from unencrypted snapshots are automatically\n unencrypted. By default, encrypted snapshots use the AWS managed CMK that is used\n for EBS encryption, but you can specify a custom CMK when you create the snapshot.\n The ability to encrypt a snapshot during copying also allows you to apply a new CMK\n to an already-encrypted snapshot. Volumes restored from the\n resulting copy are only accessible using the new CMK.

\n

Enabling encryption by default results in all EBS volumes being encrypted with\n the AWS managed CMK or a customer managed CMK, whether or not the snapshot was\n encrypted.

\n \n

For more information, see Using Encryption with EBS-Backed\n AMIs in the Amazon EC2 User Guide for Linux Instances and Required\n CMK key policy for use with encrypted volumes in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be\n attached to instances that support Amazon EBS encryption. For more information, see\n Supported Instance Types. If your AMI uses encrypted volumes, you can also\n only launch it on supported instance types.

\n \n

If you are creating a volume from a snapshot, you cannot specify an encryption\n value. Volumes that are created from encrypted snapshots are automatically\n encrypted, and volumes that are created from unencrypted snapshots are automatically\n unencrypted. By default, encrypted snapshots use the Amazon Web Services managed CMK that is used\n for EBS encryption, but you can specify a custom CMK when you create the snapshot.\n The ability to encrypt a snapshot during copying also allows you to apply a new CMK\n to an already-encrypted snapshot. Volumes restored from the\n resulting copy are only accessible using the new CMK.

\n

Enabling encryption by default results in all EBS volumes being encrypted with\n the Amazon Web Services managed CMK or a customer managed CMK, whether or not the snapshot was\n encrypted.

\n \n

For more information, see Using Encryption with EBS-Backed\n AMIs in the Amazon EC2 User Guide for Linux Instances and Required\n CMK key policy for use with encrypted volumes in the\n Amazon EC2 Auto Scaling User Guide.

" } }, "Throughput": { @@ -5074,7 +5089,7 @@ "ResourceLabel": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", "traits": { - "smithy.api#documentation": "

Identifies the resource associated with the metric type. You can't specify a resource\n label unless the metric type is ALBRequestCountPerTarget and there is a\n target group attached to the Auto Scaling group.

\n

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

\n \n

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

\n

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

" + "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group\n from which to determine the average request count served by your Auto Scaling group. You can't\n specify a resource label unless the target group is attached to the Auto Scaling group.

\n

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

\n

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

\n

Where:

\n \n

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

" } } }, @@ -5248,7 +5263,7 @@ "ResourceLabel": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", "traits": { - "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target \n group from which to determine the request count served by your Auto Scaling group. You can't specify a resource label \n unless the target group is attached to the Auto Scaling group.

\n

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

\n

\n app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

\n

Where:

\n \n

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

" + "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the request count served by your Auto Scaling group. You can't specify a resource label\n unless the target group is attached to the Auto Scaling group.

\n

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

\n

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

\n

Where:

\n \n

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

" } } }, @@ -5269,7 +5284,7 @@ "ResourceLabel": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", "traits": { - "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target \n group from which to determine the request count served by your Auto Scaling group. You can't specify a resource label \n unless the target group is attached to the Auto Scaling group.

\n

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

\n

\n app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

\n

Where:

\n \n

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

" + "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the total and average request count served by your Auto Scaling group. You can't specify a\n resource label unless the target group is attached to the Auto Scaling group.

\n

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

\n

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

\n

Where:

\n \n

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

" } } }, @@ -5290,7 +5305,7 @@ "ResourceLabel": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", "traits": { - "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target \n group from which to determine the request count served by your Auto Scaling group. You can't specify a resource label \n unless the target group is attached to the Auto Scaling group.

\n

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

\n

\n app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

\n

Where:

\n \n

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

" + "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the average request count served by your Auto Scaling group. You can't specify a resource\n label unless the target group is attached to the Auto Scaling group.

\n

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

\n

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

\n

Where:

\n \n

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

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

Starts a new instance refresh operation, which triggers a rolling replacement of\n previously launched instances in the Auto Scaling group with a new group of instances.

\n

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

\n

If the call succeeds, it creates a new instance refresh request with a unique ID that\n you can use to track its progress. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that\n have already run, call the DescribeInstanceRefreshes API. To cancel an\n instance refresh operation in progress, use the CancelInstanceRefresh\n API.

" + "smithy.api#documentation": "

Starts a new instance refresh operation, which triggers a rolling replacement of\n previously launched instances in the Auto Scaling group with a new group of instances.

\n

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

\n

If the call succeeds, it creates a new instance refresh request with a unique ID that\n you can use to track its progress. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that\n have already run, call the DescribeInstanceRefreshes API. To cancel an\n instance refresh operation in progress, use the CancelInstanceRefresh\n API.

" } }, "com.amazonaws.autoscaling#StartInstanceRefreshAnswer": { @@ -6945,6 +6960,12 @@ "traits": { "smithy.api#documentation": "

Enables or disables Capacity Rebalancing. For more information, see Amazon EC2 Auto Scaling Capacity Rebalancing in the\n Amazon EC2 Auto Scaling User Guide.

" } + }, + "Context": { + "target": "com.amazonaws.autoscaling#Context", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } } } }, diff --git a/aws/sdk/aws-models/braket.json b/aws/sdk/aws-models/braket.json index c89e12506..209a8dadc 100644 --- a/aws/sdk/aws-models/braket.json +++ b/aws/sdk/aws-models/braket.json @@ -1404,4 +1404,4 @@ } } } -} +} \ No newline at end of file diff --git a/aws/sdk/aws-models/chime.json b/aws/sdk/aws-models/chime.json index 761fb1753..1564a5dce 100644 --- a/aws/sdk/aws-models/chime.json +++ b/aws/sdk/aws-models/chime.json @@ -72,7 +72,7 @@ "AccountType": { "target": "com.amazonaws.chime#AccountType", "traits": { - "smithy.api#documentation": "

The Amazon Chime account type. For more information about different account types, see Managing Your\n Amazon Chime Accounts in the Amazon Chime Administration\n Guide.

" + "smithy.api#documentation": "

The Amazon Chime account type. For more information about different account types, see \n Managing Your Amazon Chime Accounts in the Amazon Chime Administration\n Guide.

" } }, "CreatedTimestamp": { @@ -132,12 +132,12 @@ "EnableDialOut": { "target": "com.amazonaws.chime#Boolean", "traits": { - "smithy.api#documentation": "

Setting that allows meeting participants to choose the Call me at a\n phone number option. For more information, see Join a Meeting\n without the Amazon Chime App.

" + "smithy.api#documentation": "

Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see \n Join a Meeting without the Amazon Chime App.

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

Settings related to the Amazon Chime account. This includes settings that start or stop\n remote control of shared screens, or start or stop the dial-out option in the Amazon\n Chime web application. For more information about these settings, see Use the Policies\n Page in the Amazon Chime Administration Guide.

" + "smithy.api#documentation": "

Settings related to the Amazon Chime account. This includes settings that start or stop\n remote control of shared screens, or start or stop the dial-out option in the Amazon Chime web application. For more information about these settings, see \n Use the Policies Page in the Amazon Chime Administration Guide.

" } }, "com.amazonaws.chime#AccountType": { @@ -1060,7 +1060,7 @@ "ChimeBearer": { "target": "com.amazonaws.chime#ChimeArn", "traits": { - "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

\n

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

The AppInstanceUserArn of the user that makes the API call.

", "smithy.api#httpHeader": "x-amz-chime-bearer" } } @@ -1257,7 +1257,7 @@ } ], "traits": { - "smithy.api#documentation": "

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime\n account. For more information about different account types, see Managing Your\n Amazon Chime Accounts in the Amazon Chime Administration\n Guide.

\n\n

Users suspended from a Team account are disassociated from the account,but they\n can continue to use Amazon Chime as free users. To remove the suspension from suspended\n Team account users, invite them to the Team account again.\n You can use the InviteUsers action to do so.

\n\n

Users suspended from an EnterpriseLWA account are immediately signed out of\n Amazon Chime and can no longer sign in. To remove the suspension from suspended\n EnterpriseLWA account users, use the BatchUnsuspendUser action.

\n\n

\nTo sign out users without suspending them, use the \nLogoutUser\naction.\n

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

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime\n account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration\n Guide.

\n\n

Users suspended from a Team account are disassociated from the account,but they\n can continue to use Amazon Chime as free users. To remove the suspension from suspended\n Team account users, invite them to the Team account again.\n You can use the InviteUsers action to do so.

\n\n

Users suspended from an EnterpriseLWA account are immediately signed out of\n Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.

\n\n

\nTo sign out users without suspending them, use the \nLogoutUser\naction.\n

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/users?operation=suspend", @@ -1328,7 +1328,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the suspension from up to 50 previously suspended users for the specified Amazon\n Chime EnterpriseLWA account. Only users on EnterpriseLWA\n accounts can be unsuspended using this action. For more information about different\n account types, see Managing Your Amazon Chime Accounts in the\n Amazon Chime Administration Guide.

\n\n

\nPreviously suspended users who are unsuspended using this action are returned to \nRegistered\nstatus. Users who are not previously suspended are ignored.\n

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

Removes the suspension from up to 50 previously suspended users for the specified Amazon\n Chime EnterpriseLWA account. Only users on EnterpriseLWA\n accounts can be unsuspended using this action. For more information about different account types, see \n \n Managing Your Amazon Chime Accounts\n in the account types, in the Amazon Chime Administration Guide.\n

\n\n

\nPreviously suspended users who are unsuspended using this action are returned to \nRegistered\nstatus. Users who are not previously suspended are ignored.\n

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/users?operation=unsuspend", @@ -2332,7 +2332,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon Chime account under the administrator's AWS account. Only Team\n account types are currently supported for this action. For more information about\n different account types, see Managing Your Amazon Chime Accounts in the\n Amazon Chime Administration Guide.

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

Creates an Amazon Chime account under the administrator's AWS account. Only Team\n account types are currently supported for this action. For more information about different account types, see \n Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

", "smithy.api#http": { "method": "POST", "uri": "/accounts", @@ -3351,7 +3351,7 @@ "JoinToken": { "target": "com.amazonaws.chime#JoinTokenString", "traits": { - "smithy.api#documentation": "

Token used by the Amazon Chime SDK attendee. Call the \n CreateAttendee action to \n get a join token.

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

Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.

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

Moves the specified phone number into the Deletion\n queue. A phone number must be disassociated from any\n users or Amazon Chime Voice Connectors before it can be deleted.

\n\n

Deleted phone numbers remain in the \nDeletion queue\nfor 7 days before they are deleted permanently.

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

Moves the specified phone number into the Deletion queue. A\n phone number must be disassociated from any users or Amazon Chime Voice Connectors\n before it can be deleted.

\n\n

Deleted phone numbers remain in the \nDeletion queue\nfor 7 days before they are deleted permanently.

", "smithy.api#http": { "method": "DELETE", "uri": "/phone-numbers/{PhoneNumberId}", @@ -6274,7 +6274,7 @@ "ChannelBan": { "target": "com.amazonaws.chime#ChannelBan", "traits": { - "smithy.api#documentation": "

The details of\n the ban.

" + "smithy.api#documentation": "

The details of the ban.

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

Returns the full details of a user's channel membership.

\n\n \n\n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Returns the full details of a user's channel membership.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -6551,7 +6551,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the full details of a single ChannelModerator.

\n\n \n\n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Returns the full details of a single ChannelModerator.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -6664,7 +6664,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates the primary provisioned phone number from the specified Amazon Chime\n user.

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

Disassociates the primary provisioned phone number from the specified Amazon Chime user.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/users/{UserId}?operation=disassociate-phone-number", @@ -7229,7 +7229,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves account settings for the specified Amazon Chime account ID, such as remote control\n and dialout settings. For more information about these settings, see Use the Policies\n Page in the Amazon Chime Administration Guide.

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

Retrieves account settings for the specified Amazon Chime account ID, such as remote control\n and dialout settings. For more information about these settings, see \n Use the Policies Page in the Amazon Chime Administration Guide.\n

", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AccountId}/settings", @@ -8146,7 +8146,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nGets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see \nManaging Chat Retention Policies\nin the \nAmazon Chime Administration Guide\n.\n

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

\nGets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see \nManaging Chat Retention Policies in the Amazon Chime Administration Guide.\n

", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AccountId}/retention-settings", @@ -8480,7 +8480,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.

\n\n

\nTo retrieve user details with an email address instead of a user ID, use the \nListUsers\naction, and then filter by email address.\n

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

Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.

\n\n

\nTo retrieve user details with an email address instead of a user ID, use the \nListUsers action, and then filter by email address.\n

", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AccountId}/users/{UserId}", @@ -8728,7 +8728,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nRetrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated \nVoiceConnectorItems\n.\n

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

\nRetrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.

", "smithy.api#http": { "method": "GET", "uri": "/voice-connector-groups/{VoiceConnectorGroupId}", @@ -9850,7 +9850,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nLists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see \nUsing the Amazon Chime SDK\nin the \nAmazon Chime Developer Guide\n.\n

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

\nLists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see \nUsing the Amazon Chime SDK\nin the Amazon Chime Developer Guide.\n

", "smithy.api#http": { "method": "GET", "uri": "/meetings/{MeetingId}/attendees", @@ -10331,7 +10331,7 @@ } ], "traits": { - "smithy.api#documentation": "

List all the messages in a channel. Returns a paginated list of ChannelMessages.\n By default, sorted by creation timestamp in descending\n order.

\n\n \n

Redacted messages appear in the results as empty, since they are only redacted, not deleted.\n Deleted messages do not appear in the results. This action always returns the latest\n version of an edited message.

\n

Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the \n value in the header.

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

List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.

\n \n

Redacted messages appear in the results as empty, since they are only redacted, not deleted.\n Deleted messages do not appear in the results. This action always returns the latest\n version of an edited message.

\n

Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the \n value in the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -10818,7 +10818,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nLists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see \nUsing the Amazon Chime SDK\nin the \nAmazon Chime Developer Guide\n.\n

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

\nLists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see \nUsing the Amazon Chime SDK\nin the Amazon Chime Developer Guide.

", "smithy.api#http": { "method": "GET", "uri": "/meetings", @@ -12087,6 +12087,12 @@ "traits": { "smithy.api#documentation": "

The turn control URL.

" } + }, + "EventIngestionUrl": { + "target": "com.amazonaws.chime#UriType", + "traits": { + "smithy.api#documentation": "

The event ingestion URL.

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

\nPuts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see \nLogging Amazon Chime API Calls with AWS CloudTrail\nin the \nAmazon Chime Administration Guide\n.\n

\n\n

\nTo turn off existing retention settings, remove the number of days from the corresponding \nRetentionDays\nfield in the \nRetentionSettings\nobject. For more information about retention settings, see \nManaging Chat Retention Policies\nin the \nAmazon Chime Administration Guide\n.\n

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

\nPuts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see \nLogging Amazon Chime API Calls with AWS CloudTrail\nin the Amazon Chime Administration Guide.

\n\n

\nTo turn off existing retention settings, remove the number of days from the corresponding \nRetentionDays\nfield in the \nRetentionSettings\nobject. For more information about retention settings, see \nManaging Chat Retention Policies\nin the Amazon Chime Administration Guide.

", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AccountId}/retention-settings", @@ -13666,7 +13672,7 @@ } ], "traits": { - "smithy.api#documentation": "

Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.

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

Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for \n the Amazon Chime Voice Connector before emergency calling can be configured.

", "smithy.api#http": { "method": "PUT", "uri": "/voice-connectors/{VoiceConnectorId}/emergency-calling-configuration", @@ -14786,6 +14792,21 @@ "smithy.api#documentation": "

The retention settings that determine how long to retain chat-room messages for an Amazon Chime Enterprise account.

" } }, + "com.amazonaws.chime#SMAUpdateCallArgumentsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.chime#SensitiveString" + }, + "value": { + "target": "com.amazonaws.chime#SensitiveString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, "com.amazonaws.chime#SearchAvailablePhoneNumbers": { "type": "operation", "input": { @@ -14818,7 +14839,7 @@ } ], "traits": { - "smithy.api#documentation": "

Searches for phone numbers that can be ordered. For\n US\n numbers, provide at least one of the following search filters: AreaCode,\n City, State, or TollFreePrefix. If you\n provide City, you must also provide State. Numbers outside the\n US\n only support the PhoneNumberType filter, which you must use.

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

Searches for phone numbers that can be ordered. For US numbers, provide at least one of\n the following search filters: AreaCode, City,\n State, or TollFreePrefix. If you provide\n City, you must also provide State. Numbers outside the US only\n support the PhoneNumberType filter, which you must use.

", "smithy.api#http": { "method": "GET", "uri": "/search?type=phone-numbers", @@ -14837,42 +14858,42 @@ "AreaCode": { "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The area code used to filter results. Only applies to the\n US.

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

The area code used to filter results. Only applies to the US.

", "smithy.api#httpQuery": "area-code" } }, "City": { "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The city used to filter results. Only applies to the\n US.

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

The city used to filter results. Only applies to the US.

", "smithy.api#httpQuery": "city" } }, "Country": { "target": "com.amazonaws.chime#Alpha2CountryCode", "traits": { - "smithy.api#documentation": "

The country used to filter results. Defaults to the\n US\n Format: ISO 3166-1 alpha-2.

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

The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.

", "smithy.api#httpQuery": "country" } }, "State": { "target": "com.amazonaws.chime#String", "traits": { - "smithy.api#documentation": "

The state used to filter results. Required only if you provide City. Only\n applies to the\n US.

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

The state used to filter results. Required only if you provide City. Only applies to the US.

", "smithy.api#httpQuery": "state" } }, "TollFreePrefix": { "target": "com.amazonaws.chime#TollFreePrefix", "traits": { - "smithy.api#documentation": "

The toll-free prefix that you use to filter results. Only applies to the\n US.

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

The toll-free prefix that you use to filter results. Only applies to the US.

", "smithy.api#httpQuery": "toll-free-prefix" } }, "PhoneNumberType": { "target": "com.amazonaws.chime#PhoneNumberType", "traits": { - "smithy.api#documentation": "

The phone number type used to filter results. Required for\n non-US\n numbers.

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

The phone number type used to filter results. Required for non-US numbers.

", "smithy.api#httpQuery": "phone-number-type" } }, @@ -16322,6 +16343,9 @@ { "target": "com.amazonaws.chime#UpdateSipMediaApplication" }, + { + "target": "com.amazonaws.chime#UpdateSipMediaApplicationCall" + }, { "target": "com.amazonaws.chime#UpdateSipRule" }, @@ -17710,6 +17734,85 @@ } } }, + "com.amazonaws.chime#UpdateSipMediaApplicationCall": { + "type": "operation", + "input": { + "target": "com.amazonaws.chime#UpdateSipMediaApplicationCallRequest" + }, + "output": { + "target": "com.amazonaws.chime#UpdateSipMediaApplicationCallResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chime#BadRequestException" + }, + { + "target": "com.amazonaws.chime#ForbiddenException" + }, + { + "target": "com.amazonaws.chime#NotFoundException" + }, + { + "target": "com.amazonaws.chime#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chime#ServiceFailureException" + }, + { + "target": "com.amazonaws.chime#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chime#ThrottledClientException" + }, + { + "target": "com.amazonaws.chime#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Allows you to trigger a Lambda function at any time while a call is active, and replace the current actions with new actions returned by the invocation.

", + "smithy.api#http": { + "method": "POST", + "uri": "/sip-media-applications/{SipMediaApplicationId}/calls/{TransactionId}", + "code": 202 + } + } + }, + "com.amazonaws.chime#UpdateSipMediaApplicationCallRequest": { + "type": "structure", + "members": { + "SipMediaApplicationId": { + "target": "com.amazonaws.chime#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the SIP media application handling the call.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TransactionId": { + "target": "com.amazonaws.chime#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the call transaction.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Arguments": { + "target": "com.amazonaws.chime#SMAUpdateCallArgumentsMap", + "traits": { + "smithy.api#documentation": "

Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED event. Can contain 0-20 key-value pairs.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chime#UpdateSipMediaApplicationCallResponse": { + "type": "structure", + "members": { + "SipMediaApplicationCall": { + "target": "com.amazonaws.chime#SipMediaApplicationCall" + } + } + }, "com.amazonaws.chime#UpdateSipMediaApplicationRequest": { "type": "structure", "members": { @@ -17867,7 +17970,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nUpdates user details for a specified user ID. Currently, only \nLicenseType\nupdates are supported for this action.\n

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

Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AccountId}/users/{UserId}", @@ -18334,7 +18437,7 @@ } }, "traits": { - "smithy.api#documentation": "

The list of errors returned when errors are encountered during the BatchSuspendUser, BatchUnsuspendUser, or BatchUpdateUser actions. This includes user IDs, error codes, and error\n messages.

" + "smithy.api#documentation": "

The list of errors returned when errors are encountered during the BatchSuspendUser, BatchUnsuspendUser, or \n BatchUpdateUser actions. This includes user IDs, error codes, and error messages.

" } }, "com.amazonaws.chime#UserErrorList": { diff --git a/aws/sdk/aws-models/cloud9.json b/aws/sdk/aws-models/cloud9.json index cb1b625ee..0c85dbf66 100644 --- a/aws/sdk/aws-models/cloud9.json +++ b/aws/sdk/aws-models/cloud9.json @@ -85,7 +85,7 @@ "name": "cloud9" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "AWS Cloud9\n

AWS Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.

\n

For more information about AWS Cloud9, see the AWS Cloud9 User Guide.

\n

AWS Cloud9 supports these operations:

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

Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and\n release software in the cloud.

\n

For more information about Cloud9, see the Cloud9 User Guide.

\n

Cloud9 supports these operations:

\n ", "smithy.api#title": "AWS Cloud9" } }, @@ -131,7 +131,7 @@ "com.amazonaws.cloud9#ClientRequestToken": { "type": "string", "traits": { - "smithy.api#pattern": "[\\x20-\\x7E]{10,128}" + "smithy.api#pattern": "^[\\x20-\\x7E]{10,128}$" } }, "com.amazonaws.cloud9#ConcurrentAccessException": { @@ -217,7 +217,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.

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

Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and\n then connects from the instance to the environment.

", "smithy.api#idempotent": {} } }, @@ -227,7 +227,7 @@ "name": { "target": "com.amazonaws.cloud9#EnvironmentName", "traits": { - "smithy.api#documentation": "

The name of the environment to create.

\n

This name is visible to other AWS IAM users in the same AWS account.

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

The name of the environment to create.

\n

This name is visible to other IAM users in the same Amazon Web Services account.

", "smithy.api#required": {} } }, @@ -240,50 +240,50 @@ "clientRequestToken": { "target": "com.amazonaws.cloud9#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive string that helps AWS Cloud9 to ensure this operation completes no more than one time.

\n

For more information, see Client Tokens in the Amazon EC2 API Reference.

" + "smithy.api#documentation": "

A unique, case-sensitive string that helps Cloud9 to ensure this operation completes no\n more than one time.

\n

For more information, see Client Tokens in the\n Amazon EC2 API Reference.

" } }, "instanceType": { "target": "com.amazonaws.cloud9#InstanceType", "traits": { - "smithy.api#documentation": "

The type of instance to connect to the environment (for example, t2.micro).

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

The type of instance to connect to the environment (for example,\n t2.micro).

", "smithy.api#required": {} } }, "subnetId": { "target": "com.amazonaws.cloud9#SubnetId", "traits": { - "smithy.api#documentation": "

The ID of the subnet in Amazon VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance.

" + "smithy.api#documentation": "

The ID of the subnet in Amazon VPC that Cloud9 will use to communicate with the Amazon EC2\n instance.

" } }, "imageId": { "target": "com.amazonaws.cloud9#ImageId", "traits": { - "smithy.api#documentation": "

The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. To choose an AMI for the instance, you must specify a valid AMI alias or a valid AWS Systems Manager (SSM) path.

\n

The default AMI is used if the parameter isn't explicitly assigned a value in the request. \n

\n

\n AMI aliases \n

\n \n \n

\n SSM paths\n

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

The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.\n To choose an AMI for the instance, you must specify a valid AMI alias or a valid Amazon EC2 Systems Manager (SSM)\n path.

\n

The default AMI is used if the parameter isn't explicitly assigned a value in the request.\n Because Amazon Linux AMI has ended standard support as of December 31, 2020, we recommend you\n choose Amazon Linux 2, which includes long term support through 2023.

\n

\n AMI aliases \n

\n \n

\n SSM paths\n

\n " } }, "automaticStopTimeMinutes": { "target": "com.amazonaws.cloud9#AutomaticStopTimeMinutes", "traits": { - "smithy.api#documentation": "

The number of minutes until the running instance is shut down after the environment has last been used.

" + "smithy.api#documentation": "

The number of minutes until the running instance is shut down after the environment has\n last been used.

" } }, "ownerArn": { "target": "com.amazonaws.cloud9#UserArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any AWS IAM principal. If this value is not specified, the ARN defaults to this environment's creator.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any\n IAM principal. If this value is not specified, the ARN defaults to this environment's\n creator.

" } }, "tags": { "target": "com.amazonaws.cloud9#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.

" + "smithy.api#documentation": "

An array of key-value pairs that will be associated with the new Cloud9 development\n environment.

" } }, "connectionType": { "target": "com.amazonaws.cloud9#ConnectionType", "traits": { - "smithy.api#documentation": "

The connection type used for connecting to an Amazon EC2 environment. Valid values are CONNECT_SSH (default) and CONNECT_SSM (connected through AWS Systems Manager).

\n

For more information, see Accessing no-ingress EC2 instances with AWS Systems Manager in the AWS Cloud9 User Guide.

" + "smithy.api#documentation": "

The connection type used for connecting to an Amazon EC2 environment. Valid values are\n CONNECT_SSH (default) and CONNECT_SSM (connected through\n Amazon EC2 Systems Manager).

\n

For more information, see Accessing no-ingress EC2 instances with\n Amazon EC2 Systems Manager in the Cloud9 User Guide.

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

Adds an environment member to an AWS Cloud9 development environment.

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

Adds an environment member to an Cloud9 development environment.

", "smithy.api#idempotent": {} } }, @@ -355,7 +355,7 @@ "permissions": { "target": "com.amazonaws.cloud9#MemberPermissions", "traits": { - "smithy.api#documentation": "

The type of environment member permissions you want to associate with this environment member. Available values include:

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

The type of environment member permissions you want to associate with this environment\n member. Available values include:

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

Deletes an AWS Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.

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

Deletes an Cloud9 development environment. If an Amazon EC2 instance is connected to the\n environment, also terminates the instance.

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

Deletes an environment member from an AWS Cloud9 development environment.

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

Deletes an environment member from an Cloud9 development environment.

", "smithy.api#idempotent": {} } }, @@ -458,7 +458,7 @@ "userArn": { "target": "com.amazonaws.cloud9#UserArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the environment member to delete from the environment.

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

The Amazon Resource Name (ARN) of the environment member to delete from the\n environment.

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

Gets information about environment members for an AWS Cloud9 development environment.

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

Gets information about environment members for an Cloud9 development environment.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -530,7 +530,7 @@ "userArn": { "target": "com.amazonaws.cloud9#UserArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an individual environment member to get information\n about. If no value is specified, information about all environment members are\n returned.

" } }, "environmentId": { @@ -542,13 +542,13 @@ "permissions": { "target": "com.amazonaws.cloud9#PermissionsList", "traits": { - "smithy.api#documentation": "

The type of environment member permissions to get information about. Available values include:

\n \n

If no value is specified, information about all environment members are returned.

" + "smithy.api#documentation": "

The type of environment member permissions to get information about. Available values\n include:

\n \n

If no value is specified, information about all environment members are returned.

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

During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

" + "smithy.api#documentation": "

During a previous call, if there are more than 25 items in the list, only the first 25\n items are returned, along with a unique string called a next token. To\n get the next batch of items in the list, call this operation again, adding the next token to\n the call. To get all of the items in the list, keep calling this operation with each\n subsequent next token that is returned, until no more next tokens are returned.

" } }, "maxResults": { @@ -571,7 +571,7 @@ "nextToken": { "target": "com.amazonaws.cloud9#String", "traits": { - "smithy.api#documentation": "

If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

" + "smithy.api#documentation": "

If there are more than 25 items in the list, only the first 25 items are returned, along\n with a unique string called a next token. To get the next batch of items\n in the list, call this operation again, adding the next token to the call.

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

Gets status information for an AWS Cloud9 development environment.

" + "smithy.api#documentation": "

Gets status information for an Cloud9 development environment.

" } }, "com.amazonaws.cloud9#DescribeEnvironmentStatusRequest": { @@ -674,7 +674,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about AWS Cloud9 development environments.

" + "smithy.api#documentation": "

Gets information about Cloud9 development environments.

" } }, "com.amazonaws.cloud9#DescribeEnvironmentsRequest": { @@ -731,7 +731,7 @@ "connectionType": { "target": "com.amazonaws.cloud9#ConnectionType", "traits": { - "smithy.api#documentation": "

The connection type used for connecting to an Amazon EC2 environment. CONNECT_SSH is selected by default.

" + "smithy.api#documentation": "

The connection type used for connecting to an Amazon EC2 environment. CONNECT_SSH\n is selected by default.

" } }, "arn": { @@ -757,18 +757,18 @@ "managedCredentialsStatus": { "target": "com.amazonaws.cloud9#ManagedCredentialsStatus", "traits": { - "smithy.api#documentation": "

Describes the status of AWS managed temporary credentials for the AWS Cloud9 environment. Available values\n are:

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

Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment.\n Available values are:

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

Information about an AWS Cloud9 development environment.

" + "smithy.api#documentation": "

Information about an Cloud9 development environment.

" } }, "com.amazonaws.cloud9#EnvironmentArn": { "type": "string", "traits": { - "smithy.api#pattern": "arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):cloud9:([a-z]{2}-[a-z]+-\\d{1}):[0-9]{12}:environment:[a-zA-Z0-9]{8,32}" + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):cloud9:([a-z]{2}-[a-z]+-\\d{1}):[0-9]{12}:environment:[a-zA-Z0-9]{8,32}$" } }, "com.amazonaws.cloud9#EnvironmentDescription": { @@ -811,12 +811,12 @@ "failureResource": { "target": "com.amazonaws.cloud9#String", "traits": { - "smithy.api#documentation": "

If the environment failed to delete, the Amazon Resource Name (ARN) of the related AWS resource.

" + "smithy.api#documentation": "

If the environment failed to delete, the Amazon Resource Name (ARN) of the related Amazon Web Services\n resource.

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

Information about the current creation or deletion lifecycle state of an AWS Cloud9 development environment.

" + "smithy.api#documentation": "

Information about the current creation or deletion lifecycle state of an Cloud9 development\n environment.

" } }, "com.amazonaws.cloud9#EnvironmentLifecycleStatus": { @@ -858,14 +858,14 @@ "permissions": { "target": "com.amazonaws.cloud9#Permissions", "traits": { - "smithy.api#documentation": "

The type of environment member permissions associated with this environment member. Available values include:

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

The type of environment member permissions associated with this environment member.\n Available values include:

\n ", "smithy.api#required": {} } }, "userId": { "target": "com.amazonaws.cloud9#String", "traits": { - "smithy.api#documentation": "

The user ID in AWS Identity and Access Management (AWS IAM) of the environment member.

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

The user ID in Identity and Access Management (IAM) of the environment member.

", "smithy.api#required": {} } }, @@ -886,12 +886,12 @@ "lastAccess": { "target": "com.amazonaws.cloud9#Timestamp", "traits": { - "smithy.api#documentation": "

The time, expressed in epoch time format, when the environment member last opened the environment.

" + "smithy.api#documentation": "

The time, expressed in epoch time format, when the environment member last opened the\n environment.

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

Information about an environment member for an AWS Cloud9 development environment.

" + "smithy.api#documentation": "

Information about an environment member for an Cloud9 development environment.

" } }, "com.amazonaws.cloud9#EnvironmentMembersList": { @@ -1067,7 +1067,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of AWS Cloud9 development environment identifiers.

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

Gets a list of Cloud9 development environment identifiers.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -1081,7 +1081,7 @@ "nextToken": { "target": "com.amazonaws.cloud9#String", "traits": { - "smithy.api#documentation": "

During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

" + "smithy.api#documentation": "

During a previous call, if there are more than 25 items in the list, only the first 25\n items are returned, along with a unique string called a next token. To\n get the next batch of items in the list, call this operation again, adding the next token to\n the call. To get all of the items in the list, keep calling this operation with each\n subsequent next token that is returned, until no more next tokens are returned.

" } }, "maxResults": { @@ -1098,7 +1098,7 @@ "nextToken": { "target": "com.amazonaws.cloud9#String", "traits": { - "smithy.api#documentation": "

If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

" + "smithy.api#documentation": "

If there are more than 25 items in the list, only the first 25 items are returned, along\n with a unique string called a next token. To get the next batch of items\n in the list, call this operation again, adding the next token to the call.

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

Gets a list of the tags associated with an AWS Cloud9 development environment.

" + "smithy.api#documentation": "

Gets a list of the tags associated with an Cloud9 development environment.

" } }, "com.amazonaws.cloud9#ListTagsForResourceRequest": { @@ -1138,7 +1138,7 @@ "ResourceARN": { "target": "com.amazonaws.cloud9#EnvironmentArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to get the tags for.

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

The Amazon Resource Name (ARN) of the Cloud9 development environment to get the tags\n for.

", "smithy.api#required": {} } } @@ -1150,7 +1150,7 @@ "Tags": { "target": "com.amazonaws.cloud9#TagList", "traits": { - "smithy.api#documentation": "

The list of tags associated with the AWS Cloud9 development environment.

" + "smithy.api#documentation": "

The list of tags associated with the Cloud9 development environment.

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

Metadata that is associated with AWS resources. In particular, a name-value pair that can be associated with an AWS Cloud9 development environment. There are two types of tags: user tags and system tags. A user tag is created by the user. A system tag is automatically created by AWS services. A system tag is prefixed with \"aws:\" and cannot be modified by the user.

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

Metadata that is associated with Amazon Web Services resources. In particular, a name-value pair that\n can be associated with an Cloud9 development environment. There are two types of tags:\n user tags and system tags. A user tag is created\n by the user. A system tag is automatically created by Amazon Web Services services. A system tag is prefixed\n with \"aws:\" and cannot be modified by the user.

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

Adds tags to an AWS Cloud9 development environment.

\n \n

Tags that you add to an AWS Cloud9 environment by using this method will NOT be automatically propagated to underlying resources.

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

Adds tags to an Cloud9 development environment.

\n \n

Tags that you add to an Cloud9 environment by using this method will NOT be\n automatically propagated to underlying resources.

\n " } }, "com.amazonaws.cloud9#TagResourceRequest": { @@ -1378,14 +1378,14 @@ "ResourceARN": { "target": "com.amazonaws.cloud9#EnvironmentArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to add tags to.

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

The Amazon Resource Name (ARN) of the Cloud9 development environment to add tags\n to.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.cloud9#TagList", "traits": { - "smithy.api#documentation": "

The list of tags to add to the given AWS Cloud9 development environment.

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

The list of tags to add to the given Cloud9 development environment.

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

Removes tags from an AWS Cloud9 development environment.

" + "smithy.api#documentation": "

Removes tags from an Cloud9 development environment.

" } }, "com.amazonaws.cloud9#UntagResourceRequest": { @@ -1458,14 +1458,14 @@ "ResourceARN": { "target": "com.amazonaws.cloud9#EnvironmentArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to remove tags from.

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

The Amazon Resource Name (ARN) of the Cloud9 development environment to remove tags\n from.

", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.cloud9#TagKeyList", "traits": { - "smithy.api#documentation": "

The tag names of the tags to remove from the given AWS Cloud9 development environment.

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

The tag names of the tags to remove from the given Cloud9 development\n environment.

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

Changes the settings of an existing AWS Cloud9 development environment.

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

Changes the settings of an existing Cloud9 development environment.

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

Changes the settings of an existing environment member for an AWS Cloud9 development environment.

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

Changes the settings of an existing environment member for an Cloud9 development\n environment.

", "smithy.api#idempotent": {} } }, @@ -1553,21 +1553,21 @@ "environmentId": { "target": "com.amazonaws.cloud9#EnvironmentId", "traits": { - "smithy.api#documentation": "

The ID of the environment for the environment member whose settings you want to change.

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

The ID of the environment for the environment member whose settings you want to\n change.

", "smithy.api#required": {} } }, "userArn": { "target": "com.amazonaws.cloud9#UserArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the environment member whose settings you want to change.

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

The Amazon Resource Name (ARN) of the environment member whose settings you want to\n change.

", "smithy.api#required": {} } }, "permissions": { "target": "com.amazonaws.cloud9#MemberPermissions", "traits": { - "smithy.api#documentation": "

The replacement type of environment member permissions you want to associate with this environment member. Available values include:

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

The replacement type of environment member permissions you want to associate with this\n environment member. Available values include:

\n ", "smithy.api#required": {} } } diff --git a/aws/sdk/aws-models/cloudformation.json b/aws/sdk/aws-models/cloudformation.json index 407ee644a..c40463554 100644 --- a/aws/sdk/aws-models/cloudformation.json +++ b/aws/sdk/aws-models/cloudformation.json @@ -29,6 +29,12 @@ ] }, "shapes": { + "com.amazonaws.cloudformation#AcceptTermsAndConditions": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.cloudformation#Account": { "type": "string", "traits": { @@ -116,7 +122,101 @@ "min": 1, "max": 5120 }, - "smithy.api#pattern": "(s3://|http(s?)://).+" + "smithy.api#pattern": "^(s3://|http(s?)://).+$" + } + }, + "com.amazonaws.cloudformation#ActivateType": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#ActivateTypeInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#ActivateTypeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#CFNRegistryException" + }, + { + "target": "com.amazonaws.cloudformation#TypeNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the CloudFormation User Guide.

\n

Once you have activated a public third-party extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudformation#ActivateTypeInput": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.cloudformation#ThirdPartyType", + "traits": { + "smithy.api#documentation": "

The extension type.

\n

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

" + } + }, + "PublicTypeArn": { + "target": "com.amazonaws.cloudformation#ThirdPartyTypeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the public extension.

\n

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

" + } + }, + "PublisherId": { + "target": "com.amazonaws.cloudformation#PublisherId", + "traits": { + "smithy.api#documentation": "

The ID of the extension publisher.

\n

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

" + } + }, + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "

The name of the extension.

\n

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

" + } + }, + "TypeNameAlias": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "

An alias to assign to the public extension, in this account and region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

\n

An extension alias must be unique within a given account and region. You can activate the same public resource multiple times in the same account and region, using different type name aliases.

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

Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.

\n

The default is true.

" + } + }, + "LoggingConfig": { + "target": "com.amazonaws.cloudformation#LoggingConfig" + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.cloudformation#RoleARN2", + "traits": { + "smithy.api#documentation": "

The name of the IAM execution role to use to activate the extension.

" + } + }, + "VersionBump": { + "target": "com.amazonaws.cloudformation#VersionBump", + "traits": { + "smithy.api#documentation": "

Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdate.

\n " + } + }, + "MajorVersion": { + "target": "com.amazonaws.cloudformation#MajorVersion", + "traits": { + "smithy.api#documentation": "

The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected.

\n

You can specify MajorVersion or VersionBump, but not both.

" + } + } + } + }, + "com.amazonaws.cloudformation#ActivateTypeOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.cloudformation#PrivateTypeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the activated extension, in this account and region.

" + } + } } }, "com.amazonaws.cloudformation#AllowedValue": { @@ -136,6 +236,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "AlreadyExistsException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The resource with the name requested already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -170,6 +274,96 @@ "smithy.api#box": {} } }, + "com.amazonaws.cloudformation#AutoUpdate": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.cloudformation#BatchDescribeTypeConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#CFNRegistryException" + }, + { + "target": "com.amazonaws.cloudformation#TypeConfigurationNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and region.

\n

For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

" + } + }, + "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.cloudformation#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.cloudformation#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message.

" + } + }, + "TypeConfigurationIdentifier": { + "target": "com.amazonaws.cloudformation#TypeConfigurationIdentifier" + } + }, + "traits": { + "smithy.api#documentation": "

Detailed information concerning an error generated during the setting of configuration data for a CloudFormation extension.

" + } + }, + "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsError" + } + }, + "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsInput": { + "type": "structure", + "members": { + "TypeConfigurationIdentifiers": { + "target": "com.amazonaws.cloudformation#TypeConfigurationIdentifiers", + "traits": { + "smithy.api#documentation": "

The list of identifiers for the desired extension configurations.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsOutput": { + "type": "structure", + "members": { + "Errors": { + "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsErrors", + "traits": { + "smithy.api#documentation": "

A list of information concerning any errors generated during the setting of the specified configurations.

" + } + }, + "UnprocessedTypeConfigurations": { + "target": "com.amazonaws.cloudformation#UnprocessedTypeConfigurations", + "traits": { + "smithy.api#documentation": "

A list of any of the specified extension configurations that CloudFormation could not process for any reason.

" + } + }, + "TypeConfigurations": { + "target": "com.amazonaws.cloudformation#TypeConfigurationDetailsList", + "traits": { + "smithy.api#documentation": "

A list of any of the specified extension configurations from the CloudFormation registry.

" + } + } + } + }, "com.amazonaws.cloudformation#BoxedInteger": { "type": "integer", "traits": { @@ -194,6 +388,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "CFNRegistryException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

An error occurred during a CloudFormation registry operation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -277,6 +475,29 @@ ] } }, + "com.amazonaws.cloudformation#Category": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "REGISTERED", + "name": "REGISTERED" + }, + { + "value": "ACTIVATED", + "name": "ACTIVATED" + }, + { + "value": "THIRD_PARTY", + "name": "THIRD_PARTY" + }, + { + "value": "AWS_TYPES", + "name": "AWS_TYPES" + } + ] + } + }, "com.amazonaws.cloudformation#CausingEntity": { "type": "string" }, @@ -333,7 +554,7 @@ "smithy.api#length": { "min": 1 }, - "smithy.api#pattern": "arn:[-a-zA-Z0-9:/]*" + "smithy.api#pattern": "^arn:[-a-zA-Z0-9:/]*$" } }, "com.amazonaws.cloudformation#ChangeSetName": { @@ -343,7 +564,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[a-zA-Z][-a-zA-Z0-9]*" + "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*$" } }, "com.amazonaws.cloudformation#ChangeSetNameOrId": { @@ -353,7 +574,7 @@ "min": 1, "max": 1600 }, - "smithy.api#pattern": "[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*" + "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*$" } }, "com.amazonaws.cloudformation#ChangeSetNotFoundException": { @@ -364,6 +585,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ChangeSetNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified change set name or ID doesn't exit. To view valid change sets for a\n stack, use the ListChangeSets action.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -567,7 +792,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[a-zA-Z0-9][-a-zA-Z0-9]*" + "smithy.api#pattern": "^[a-zA-Z0-9][-a-zA-Z0-9]*$" } }, "com.amazonaws.cloudformation#ClientToken": { @@ -583,6 +808,12 @@ "type": "service", "version": "2010-05-15", "operations": [ + { + "target": "com.amazonaws.cloudformation#ActivateType" + }, + { + "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurations" + }, { "target": "com.amazonaws.cloudformation#CancelUpdateStack" }, @@ -601,6 +832,9 @@ { "target": "com.amazonaws.cloudformation#CreateStackSet" }, + { + "target": "com.amazonaws.cloudformation#DeactivateType" + }, { "target": "com.amazonaws.cloudformation#DeleteChangeSet" }, @@ -622,6 +856,9 @@ { "target": "com.amazonaws.cloudformation#DescribeChangeSet" }, + { + "target": "com.amazonaws.cloudformation#DescribePublisher" + }, { "target": "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatus" }, @@ -715,15 +952,24 @@ { "target": "com.amazonaws.cloudformation#ListTypeVersions" }, + { + "target": "com.amazonaws.cloudformation#PublishType" + }, { "target": "com.amazonaws.cloudformation#RecordHandlerProgress" }, + { + "target": "com.amazonaws.cloudformation#RegisterPublisher" + }, { "target": "com.amazonaws.cloudformation#RegisterType" }, { "target": "com.amazonaws.cloudformation#SetStackPolicy" }, + { + "target": "com.amazonaws.cloudformation#SetTypeConfiguration" + }, { "target": "com.amazonaws.cloudformation#SetTypeDefaultVersion" }, @@ -733,6 +979,9 @@ { "target": "com.amazonaws.cloudformation#StopStackSetOperation" }, + { + "target": "com.amazonaws.cloudformation#TestType" + }, { "target": "com.amazonaws.cloudformation#UpdateStack" }, @@ -768,6 +1017,26 @@ } } }, + "com.amazonaws.cloudformation#ConfigurationSchema": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60000 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.cloudformation#ConnectionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+$" + } + }, "com.amazonaws.cloudformation#ContinueUpdateRollback": { "type": "operation", "input": { @@ -1357,6 +1626,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "CreatedButModifiedException", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

The specified resource exists, but has been changed.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -1365,6 +1638,54 @@ "com.amazonaws.cloudformation#CreationTime": { "type": "timestamp" }, + "com.amazonaws.cloudformation#DeactivateType": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DeactivateTypeInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DeactivateTypeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#CFNRegistryException" + }, + { + "target": "com.amazonaws.cloudformation#TypeNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deactivates a public extension that was previously activated in this account and region.

\n

Once deactivated, an extension cannot be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions are not automatically updated if a new version of the extension is released.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudformation#DeactivateTypeInput": { + "type": "structure", + "members": { + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "

The type name of the extension, in this account and region. If you specified a type name alias when enabling the extension, use the type name alias.

\n

Conditional: You must specify either Arn, or TypeName and Type.

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

The extension type.

\n

Conditional: You must specify either Arn, or TypeName and Type.

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

The Amazon Resource Name (ARN) for the extension, in this account and region.

\n

Conditional: You must specify either Arn, or TypeName and Type.

" + } + } + } + }, + "com.amazonaws.cloudformation#DeactivateTypeOutput": { + "type": "structure", + "members": {} + }, "com.amazonaws.cloudformation#DeleteChangeSet": { "type": "operation", "input": { @@ -1911,6 +2232,64 @@ "smithy.api#documentation": "

The output for the DescribeChangeSet action.

" } }, + "com.amazonaws.cloudformation#DescribePublisher": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DescribePublisherInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DescribePublisherOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#CFNRegistryException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a CloudFormation extension publisher.

\n

If you do not supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.

\n

For more information on registering as a publisher, see:

\n ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudformation#DescribePublisherInput": { + "type": "structure", + "members": { + "PublisherId": { + "target": "com.amazonaws.cloudformation#PublisherId", + "traits": { + "smithy.api#documentation": "

The ID of the extension publisher.

\n

If you do not supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.

" + } + } + } + }, + "com.amazonaws.cloudformation#DescribePublisherOutput": { + "type": "structure", + "members": { + "PublisherId": { + "target": "com.amazonaws.cloudformation#PublisherId", + "traits": { + "smithy.api#documentation": "

The ID of the extension publisher.

" + } + }, + "PublisherStatus": { + "target": "com.amazonaws.cloudformation#PublisherStatus", + "traits": { + "smithy.api#documentation": "

Whether the publisher is verified. Currently, all registered publishers are verified.

" + } + }, + "IdentityProvider": { + "target": "com.amazonaws.cloudformation#IdentityProvider", + "traits": { + "smithy.api#documentation": "

The type of account used as the identity provider when registering this publisher with CloudFormation.

" + } + }, + "PublisherProfile": { + "target": "com.amazonaws.cloudformation#PublisherProfile", + "traits": { + "smithy.api#documentation": "

The URL to the publisher's profile with the identity provider.

" + } + } + } + }, "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatus": { "type": "operation", "input": { @@ -2477,9 +2856,21 @@ "traits": { "smithy.api#documentation": "

The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

\n

If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

" } - } - } - }, + }, + "PublisherId": { + "target": "com.amazonaws.cloudformation#PublisherId", + "traits": { + "smithy.api#documentation": "

The publisher ID of the extension publisher.

\n

Extensions provided by Amazon are not assigned a publisher ID.

" + } + }, + "PublicVersionNumber": { + "target": "com.amazonaws.cloudformation#PublicVersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of a public third-party extension.

" + } + } + } + }, "com.amazonaws.cloudformation#DescribeTypeOutput": { "type": "structure", "members": { @@ -2498,25 +2889,37 @@ "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The name of the registered extension.

" + "smithy.api#documentation": "

The name of the extension.

\n

If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType.

" } }, "DefaultVersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "

The ID of the default version of the extension. The default version is used when the extension version is not specified.

\n

To set the default version of an extension, use \n SetTypeDefaultVersion\n .

" + "smithy.api#documentation": "

The ID of the default version of the extension. The default version is used when the extension version is not specified.

\n

This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns null. For more information, see RegisterType.

\n

To set the default version of an extension, use \n SetTypeDefaultVersion\n .

" } }, "IsDefaultVersion": { "target": "com.amazonaws.cloudformation#IsDefaultVersion", "traits": { - "smithy.api#documentation": "

Whether the specified extension version is set as the default version.

" + "smithy.api#documentation": "

Whether the specified extension version is set as the default version.

\n

This applies only to private extensions you have registered in your account, and extensions published by Amazon. For public third-party extensions, whether or not they are activated in your account, CloudFormation returns null.

" + } + }, + "TypeTestsStatus": { + "target": "com.amazonaws.cloudformation#TypeTestsStatus", + "traits": { + "smithy.api#documentation": "

The contract test status of the registered extension version. To return the extension test status of a specifc extension version, you must specify VersionId.

\n

This applies only to registered private extension versions. CloudFormation does not return this information for public extensions, whether or not they are activated in your account.

\n " + } + }, + "TypeTestsStatusDescription": { + "target": "com.amazonaws.cloudformation#TypeTestsStatusDescription", + "traits": { + "smithy.api#documentation": "

The description of the test status. To return the extension test status of a specifc extension version, you must specify VersionId.

\n

This applies only to registered private extension versions. CloudFormation does not return this information for public extensions, whether or not they are activated in your account.

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

The description of the registered extension.

" + "smithy.api#documentation": "

The description of the extension.

" } }, "Schema": { @@ -2528,31 +2931,37 @@ "ProvisioningType": { "target": "com.amazonaws.cloudformation#ProvisioningType", "traits": { - "smithy.api#documentation": "

The provisioning behavior of the extension. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

\n

Valid values include:

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

For resource type extensions, the provisioning behavior of the resource type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

\n

Valid values include:

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

The deprecation status of the extension version.

\n

Valid values include:

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

The deprecation status of the extension version.

\n

Valid values include:

\n \n

For public third-party extensions, CloudFormation returns null.

" } }, "LoggingConfig": { "target": "com.amazonaws.cloudformation#LoggingConfig", "traits": { - "smithy.api#documentation": "

Contains logging configuration information for an extension.

" + "smithy.api#documentation": "

Contains logging configuration information for private extensions. This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns null. For more information, see RegisterType.

" + } + }, + "RequiredActivatedTypes": { + "target": "com.amazonaws.cloudformation#RequiredActivatedTypes", + "traits": { + "smithy.api#documentation": "

For extensions that are modules, the public third-party extensions that must be activated in your account in order for the module itself to be activated.

" } }, "ExecutionRoleArn": { "target": "com.amazonaws.cloudformation#RoleARN2", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. If your resource type calls AWS APIs in any of its handlers, you must create an\n \n IAM execution\n role\n that includes the necessary permissions to call those\n AWS APIs, and provision that execution role in your account. CloudFormation then\n assumes that execution role to provide your extension with the appropriate\n credentials.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see RegisterType.

\n

\n

If the registered extension calls any AWS APIs, you must create an \n IAM execution\n role\n that includes the necessary permissions to call those\n AWS APIs, and provision that execution role in your account. CloudFormation then\n assumes that execution role to provide your extension with the appropriate\n credentials.

" } }, "Visibility": { "target": "com.amazonaws.cloudformation#Visibility", "traits": { - "smithy.api#documentation": "

The scope at which the extension is visible and usable in CloudFormation operations.

\n

Valid values include:

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

The scope at which the extension is visible and usable in CloudFormation operations.

\n

Valid values include:

\n " } }, "SourceUrl": { @@ -2570,13 +2979,61 @@ "LastUpdated": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

When the specified extension version was registered.

" + "smithy.api#documentation": "

When the specified extension version was registered. This applies only to:

\n " } }, "TimeCreated": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

When the specified extension version was registered.

" + "smithy.api#documentation": "

When the specified private extension version was registered or activated in your account.

" + } + }, + "ConfigurationSchema": { + "target": "com.amazonaws.cloudformation#ConfigurationSchema", + "traits": { + "smithy.api#documentation": "

A JSON string that represent the current configuration data for the extension in this account and region.

\n

To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

" + } + }, + "PublisherId": { + "target": "com.amazonaws.cloudformation#PublisherId", + "traits": { + "smithy.api#documentation": "

The publisher ID of the extension publisher.

\n

This applies only to public third-party extensions. For private registered extensions, and extensions provided by Amazon, CloudFormation returns null.

" + } + }, + "OriginalTypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "

For public extensions that have been activated for this account and region, the type name of the public extension.

\n

If you specified a TypeNameAlias when enabling the extension in this account and region, CloudFormation treats that alias as the extension's type name within the account and region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.

" + } + }, + "OriginalTypeArn": { + "target": "com.amazonaws.cloudformation#TypeArn", + "traits": { + "smithy.api#documentation": "

For public extensions that have been activated for this account and region, the Amazon Resource Name (ARN) of the public extension.

" + } + }, + "PublicVersionNumber": { + "target": "com.amazonaws.cloudformation#PublicVersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of a public third-party extension.

\n

This applies only if you specify a public extension you have activated in your account, or specify a public extension without specifying a version. For all other extensions, CloudFormation returns null.

" + } + }, + "LatestPublicVersion": { + "target": "com.amazonaws.cloudformation#PublicVersionNumber", + "traits": { + "smithy.api#documentation": "

The latest version of a public extension that is available for use.

\n

This only applies if you specify a public extension, and you do not specify a version. For all other requests, CloudFormation returns null.

" + } + }, + "IsActivated": { + "target": "com.amazonaws.cloudformation#IsActivated", + "traits": { + "smithy.api#documentation": "

Whether or not the extension is activated in the account and region.

\n

This only applies to public third-party extensions. For all other extensions, CloudFormation returns null.

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

Whether CloudFormation automatically updates the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Activating public extensions for use in your account in the AWS CloudFormation User Guide.

" } } } @@ -2863,6 +3320,15 @@ "smithy.api#box": {} } }, + "com.amazonaws.cloudformation#ErrorCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 3 + } + } + }, "com.amazonaws.cloudformation#ErrorMessage": { "type": "string", "traits": { @@ -3009,7 +3475,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[a-zA-Z_0-9+=,.@-]+" + "smithy.api#pattern": "^[a-zA-Z_0-9+=,.@-]+$" } }, "com.amazonaws.cloudformation#ExecutionStatus": { @@ -3184,7 +3650,7 @@ "TemplateStage": { "target": "com.amazonaws.cloudformation#TemplateStage", "traits": { - "smithy.api#documentation": "

For templates that include transforms, the stage of the template that AWS\n CloudFormation returns. To get the user-submitted template, specify Original.\n To get the template after AWS CloudFormation has processed all transforms, specify\n Processed.

\n

If the template doesn't include transforms, Original and\n Processed return the same template. By default, AWS CloudFormation\n specifies Original.

" + "smithy.api#documentation": "

For templates that include transforms, the stage of the template that AWS\n CloudFormation returns. To get the user-submitted template, specify Original.\n To get the template after AWS CloudFormation has processed all transforms, specify\n Processed.

\n

If the template doesn't include transforms, Original and\n Processed return the same template. By default, AWS CloudFormation\n specifies Processed.

" } } }, @@ -3388,6 +3854,29 @@ { "value": "InternalFailure", "name": "InternalFailure" + }, + { + "value": "InvalidTypeConfiguration", + "name": "InvalidTypeConfiguration" + } + ] + } + }, + "com.amazonaws.cloudformation#IdentityProvider": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS_Marketplace", + "name": "AWS_Marketplace" + }, + { + "value": "GitHub", + "name": "GitHub" + }, + { + "value": "Bitbucket", + "name": "Bitbucket" } ] } @@ -3428,6 +3917,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientCapabilitiesException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The template contains resources with capabilities that weren't specified in the\n Capabilities parameter.

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

The specified change set can't be used to update the stack. For example, the change\n set status might be CREATE_IN_PROGRESS, or the stack status might be\n UPDATE_IN_PROGRESS.

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

The specified operation isn't valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3467,11 +3968,27 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidStateTransition", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Error reserved for use by the CloudFormation CLI. CloudFormation does not return this error to users.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudformation#IsActivated": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.cloudformation#IsDefaultConfiguration": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.cloudformation#IsDefaultVersion": { "type": "boolean", "traits": { @@ -3492,6 +4009,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "LimitExceededException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The quota for the resource has already been reached.

\n

For information on resource and stack limitations, see Limits in\n the AWS CloudFormation User Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -4198,7 +4719,7 @@ } }, "Arn": { - "target": "com.amazonaws.cloudformation#PrivateTypeArn", + "target": "com.amazonaws.cloudformation#TypeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension for which you want version summary information.

\n

Conditional: You must specify either TypeName and Type, or Arn.

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

The deprecation status of the extension versions that you want to get summary information about.

\n

Valid values include:

\n \n

The default is LIVE.

" } + }, + "PublisherId": { + "target": "com.amazonaws.cloudformation#PublisherId", + "traits": { + "smithy.api#documentation": "

The publisher ID of the extension publisher.

\n

Extensions published by Amazon are not assigned a publisher ID.

" + } } } }, @@ -4259,6 +4786,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "TypeSummaries", "pageSize": "MaxResults" } } @@ -4269,13 +4797,13 @@ "Visibility": { "target": "com.amazonaws.cloudformation#Visibility", "traits": { - "smithy.api#documentation": "

The scope at which the extension is visible and usable in CloudFormation operations.

\n

Valid values include:

\n \n

The default is PRIVATE.

" + "smithy.api#documentation": "

The scope at which the extensions are visible and usable in CloudFormation operations.

\n

Valid values include:

\n \n

The default is PRIVATE.

" } }, "ProvisioningType": { "target": "com.amazonaws.cloudformation#ProvisioningType", "traits": { - "smithy.api#documentation": "

The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

\n

Valid values include:

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

For resource types, the provisioning behavior of the resource type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

\n

Valid values include:

\n \n

The default is FULLY_MUTABLE.

" } }, "DeprecatedStatus": { @@ -4290,6 +4818,12 @@ "smithy.api#documentation": "

The type of extension.

" } }, + "Filters": { + "target": "com.amazonaws.cloudformation#TypeFilters", + "traits": { + "smithy.api#documentation": "

Filter criteria to use in determining which extensions to return.

\n

If you specify a filter, CloudFormation ignores any specified Visibility value when returning the list of types.

" + } + }, "MaxResults": { "target": "com.amazonaws.cloudformation#MaxResults", "traits": { @@ -4328,7 +4862,7 @@ "min": 1, "max": 512 }, - "smithy.api#pattern": "[\\.\\-_/#A-Za-z0-9]+" + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" } }, "com.amazonaws.cloudformation#LoggingConfig": { @@ -4344,13 +4878,13 @@ "LogGroupName": { "target": "com.amazonaws.cloudformation#LogGroupName", "traits": { - "smithy.api#documentation": "

The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.

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

The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the extension's handlers.

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

Contains logging configuration information for a type.

" + "smithy.api#documentation": "

Contains logging configuration information for an extension.

" } }, "com.amazonaws.cloudformation#LogicalIdHierarchy": { @@ -4371,6 +4905,16 @@ } } }, + "com.amazonaws.cloudformation#MajorVersion": { + "type": "long", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100000 + } + } + }, "com.amazonaws.cloudformation#MaxConcurrentCount": { "type": "integer", "traits": { @@ -4441,6 +4985,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "NameAlreadyExistsException", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

The specified name is already in use.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -4503,6 +5051,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "OperationIdAlreadyExistsException", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

The specified operation ID already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -4516,6 +5068,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "OperationInProgressException", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

Another operation is currently in progress for this stack set. Only one operation can\n be performed for a stack set at a given time.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -4529,6 +5085,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "OperationNotFoundException", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified ID refers to an operation that doesn't exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -4565,6 +5125,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ConditionalCheckFailed", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Error reserved for use by the CloudFormation CLI. CloudFormation does not return this error to users.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -4805,7 +5369,7 @@ "min": 0, "max": 1024 }, - "smithy.api#pattern": "arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+" + "smithy.api#pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+$" } }, "com.amazonaws.cloudformation#Properties": { @@ -4881,6 +5445,121 @@ ] } }, + "com.amazonaws.cloudformation#PublicVersionNumber": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5 + }, + "smithy.api#pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(.*)$" + } + }, + "com.amazonaws.cloudformation#PublishType": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#PublishTypeInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#PublishTypeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#CFNRegistryException" + }, + { + "target": "com.amazonaws.cloudformation#TypeNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Publishes the specified extension to the CloudFormation registry as a public extension in this region. Public extensions are available for use by all CloudFormation users. For more information on publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.

\n

To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudformation#PublishTypeInput": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.cloudformation#ThirdPartyType", + "traits": { + "smithy.api#documentation": "

The type of the extension.

\n

Conditional: You must specify Arn, or TypeName and Type.

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

The Amazon Resource Number (ARN) of the extension.

\n

Conditional: You must specify Arn, or TypeName and Type.

" + } + }, + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "

The name of the extension.

\n

Conditional: You must specify Arn, or TypeName and Type.

" + } + }, + "PublicVersionNumber": { + "target": "com.amazonaws.cloudformation#PublicVersionNumber", + "traits": { + "smithy.api#documentation": "

The version number to assign to this version of the extension.

\n

Use the following format, and adhere to semantic versioning when assigning a version number to your extension:

\n

\n MAJOR.MINOR.PATCH\n

\n

For more information, see Semantic Versioning 2.0.0.

\n

If you do not specify a version number, CloudFormation increments the version number by one minor version release.

" + } + } + } + }, + "com.amazonaws.cloudformation#PublishTypeOutput": { + "type": "structure", + "members": { + "PublicTypeArn": { + "target": "com.amazonaws.cloudformation#TypeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) assigned to the public extension upon publication.

" + } + } + } + }, + "com.amazonaws.cloudformation#PublisherId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + }, + "smithy.api#pattern": "^[0-9a-zA-Z]{12,40}$" + } + }, + "com.amazonaws.cloudformation#PublisherName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.cloudformation#PublisherProfile": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^(http:|https:)+[^\\s]+[\\w]$" + } + }, + "com.amazonaws.cloudformation#PublisherStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VERIFIED", + "name": "VERIFIED" + }, + { + "value": "UNVERIFIED", + "name": "UNVERIFIED" + } + ] + } + }, "com.amazonaws.cloudformation#Reason": { "type": "string" }, @@ -4985,6 +5664,52 @@ "target": "com.amazonaws.cloudformation#Region" } }, + "com.amazonaws.cloudformation#RegisterPublisher": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#RegisterPublisherInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#RegisterPublisherOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#CFNRegistryException" + } + ], + "traits": { + "smithy.api#documentation": "

Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all AWS regions.

\n

For information on requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.

\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudformation#RegisterPublisherInput": { + "type": "structure", + "members": { + "AcceptTermsAndConditions": { + "target": "com.amazonaws.cloudformation#AcceptTermsAndConditions", + "traits": { + "smithy.api#documentation": "

Whether you accept the terms and conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry.

\n

The default is false.

" + } + }, + "ConnectionArn": { + "target": "com.amazonaws.cloudformation#ConnectionArn", + "traits": { + "smithy.api#documentation": "

If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.

\n

For more information, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.

" + } + } + } + }, + "com.amazonaws.cloudformation#RegisterPublisherOutput": { + "type": "structure", + "members": { + "PublisherId": { + "target": "com.amazonaws.cloudformation#PublisherId", + "traits": { + "smithy.api#documentation": "

The ID assigned this account by CloudFormation for publishing extensions.

" + } + } + } + }, "com.amazonaws.cloudformation#RegisterType": { "type": "operation", "input": { @@ -4999,7 +5724,7 @@ } ], "traits": { - "smithy.api#documentation": "

Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your AWS account, and includes:

\n \n

For more information on how to develop extensions and ready them for registeration, see Creating Resource Providers in the CloudFormation CLI User Guide.

\n

You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary.

\n

Once you have initiated a registration request using \n RegisterType\n , you can use \n DescribeTypeRegistration\n to monitor the progress of the registration request.

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

Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your AWS account, and includes:

\n \n

For more information on how to develop extensions and ready them for registeration, see Creating Resource Providers in the CloudFormation CLI User Guide.

\n

You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary.

\n

Once you have initiated a registration request using \n RegisterType\n , you can use \n DescribeTypeRegistration\n to monitor the progress of the registration request.

\n

Once you have registered a private extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

", "smithy.api#idempotent": {} } }, @@ -5015,7 +5740,7 @@ "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The name of the extension being registered.

\n \n

We recommend that extension names adhere to the following pattern: company_or_organization::service::type.

\n \n

The following organization namespaces are reserved and cannot be used in your extension names:

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

The name of the extension being registered.

\n

We recommend that extension names adhere to the following patterns:

\n \n \n \n

The following organization namespaces are reserved and cannot be used in your extension names:

\n \n ", "smithy.api#required": {} } }, @@ -5035,7 +5760,7 @@ "ExecutionRoleArn": { "target": "com.amazonaws.cloudformation#RoleARN2", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension. If your extension calls AWS APIs in any of its handlers, you must create an\n \n IAM execution\n role\n that includes the necessary permissions to call those\n AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the extension handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the extension handler, thereby supplying your extension with the appropriate credentials.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

\n

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information on adding trust relationships, see Modifying a role trust policy in the AWS Identity and Access Management User Guide.

\n

If your extension calls AWS APIs in any of its handlers, you must create an\n \n IAM execution\n role\n that includes the necessary permissions to call those\n AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

" } }, "ClientRequestToken": { @@ -5083,7 +5808,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[a-zA-Z0-9][-a-zA-Z0-9]*" + "smithy.api#pattern": "^[a-zA-Z0-9][-a-zA-Z0-9]*$" } }, "com.amazonaws.cloudformation#RegistrationTokenList": { @@ -5133,7 +5858,45 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[a-zA-Z0-9][-a-zA-Z0-9]*" + "smithy.api#pattern": "^[a-zA-Z0-9][-a-zA-Z0-9]*$" + } + }, + "com.amazonaws.cloudformation#RequiredActivatedType": { + "type": "structure", + "members": { + "TypeNameAlias": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "

An alias assigned to the public extension, in this account and region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

" + } + }, + "OriginalTypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "

The type name of the public extension.

\n

If you specified a TypeNameAlias when enabling the extension in this account and region, CloudFormation treats that alias as the extension's type name within the account and region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.

" + } + }, + "PublisherId": { + "target": "com.amazonaws.cloudformation#PublisherId", + "traits": { + "smithy.api#documentation": "

The publisher ID of the extension publisher.

" + } + }, + "SupportedMajorVersions": { + "target": "com.amazonaws.cloudformation#SupportedMajorVersions", + "traits": { + "smithy.api#documentation": "

A list of the major versions of the extension type that the macro supports.

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

For extensions that are modules, a public third-party extension that must be activated in your account in order for the module itself to be activated.

\n

For more information, see Activating public modules for use in your account in the AWS CloudFormation User Guide.

" + } + }, + "com.amazonaws.cloudformation#RequiredActivatedTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#RequiredActivatedType" } }, "com.amazonaws.cloudformation#RequiresRecreation": { @@ -5525,7 +6288,7 @@ "com.amazonaws.cloudformation#ResourceToSkip": { "type": "string", "traits": { - "smithy.api#pattern": "[a-zA-Z0-9]+|[a-zA-Z][-a-zA-Z0-9]*\\.[a-zA-Z0-9]+" + "smithy.api#pattern": "^[a-zA-Z0-9]+|[a-zA-Z][-a-zA-Z0-9]*\\.[a-zA-Z0-9]+$" } }, "com.amazonaws.cloudformation#ResourceType": { @@ -5598,7 +6361,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "arn:.+:iam::[0-9]{12}:role/.+" + "smithy.api#pattern": "^arn:.+:iam::[0-9]{12}:role/.+$" } }, "com.amazonaws.cloudformation#RollbackConfiguration": { @@ -5655,6 +6418,16 @@ } } }, + "com.amazonaws.cloudformation#S3Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, "com.amazonaws.cloudformation#S3Url": { "type": "string", "traits": { @@ -5706,13 +6479,13 @@ "smithy.api#documentation": "

The input for the SetStackPolicy action.

" } }, - "com.amazonaws.cloudformation#SetTypeDefaultVersion": { + "com.amazonaws.cloudformation#SetTypeConfiguration": { "type": "operation", "input": { - "target": "com.amazonaws.cloudformation#SetTypeDefaultVersionInput" + "target": "com.amazonaws.cloudformation#SetTypeConfigurationInput" }, "output": { - "target": "com.amazonaws.cloudformation#SetTypeDefaultVersionOutput" + "target": "com.amazonaws.cloudformation#SetTypeConfigurationOutput" }, "errors": [ { @@ -5723,15 +6496,82 @@ } ], "traits": { - "smithy.api#documentation": "

Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.

", - "smithy.api#idempotent": {} + "smithy.api#documentation": "

Specifies the configuration data for a registered CloudFormation extension, in the given account and region.

\n

To view the current configuration data for an extension, refer to the ConfigurationSchema element of DescribeType. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

\n \n

It is strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values in the AWS CloudFormation User Guide.

\n " } }, - "com.amazonaws.cloudformation#SetTypeDefaultVersionInput": { + "com.amazonaws.cloudformation#SetTypeConfigurationInput": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.cloudformation#PrivateTypeArn", + "TypeArn": { + "target": "com.amazonaws.cloudformation#TypeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the extension, in this account and region.

\n

For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.

\n

Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.

" + } + }, + "Configuration": { + "target": "com.amazonaws.cloudformation#TypeConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration data for the extension, in this account and region.

\n

The configuration data must be formatted as JSON, and validate against the schema returned in the ConfigurationSchema response element of API_DescribeType. For more information, see Defining account-level configuration data for an extension in the CloudFormation CLI User Guide.

", + "smithy.api#required": {} + } + }, + "ConfigurationAlias": { + "target": "com.amazonaws.cloudformation#TypeConfigurationAlias", + "traits": { + "smithy.api#documentation": "

An alias by which to refer to this extension configuration data.

\n

Conditional: Specifying a configuration alias is required when setting a configuration for a resource type extension.

" + } + }, + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "

The name of the extension.

\n

Conditional: You must specify ConfigurationArn, or Type and TypeName.

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

The type of extension.

\n

Conditional: You must specify ConfigurationArn, or Type and TypeName.

" + } + } + } + }, + "com.amazonaws.cloudformation#SetTypeConfigurationOutput": { + "type": "structure", + "members": { + "ConfigurationArn": { + "target": "com.amazonaws.cloudformation#TypeConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the configuration data, in this account and region.

\n

Conditional: You must specify ConfigurationArn, or Type and TypeName.

" + } + } + } + }, + "com.amazonaws.cloudformation#SetTypeDefaultVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#SetTypeDefaultVersionInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#SetTypeDefaultVersionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#CFNRegistryException" + }, + { + "target": "com.amazonaws.cloudformation#TypeNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudformation#SetTypeDefaultVersionInput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.cloudformation#PrivateTypeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension for which you want version summary information.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" } @@ -6310,6 +7150,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "StackInstanceNotFoundException", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified stack instance doesn't exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -6417,7 +7261,7 @@ "smithy.api#length": { "min": 1 }, - "smithy.api#pattern": "([a-zA-Z][-a-zA-Z0-9]*)|(arn:\\b(aws|aws-us-gov|aws-cn)\\b:[-a-zA-Z0-9:/._+]*)" + "smithy.api#pattern": "^([a-zA-Z][-a-zA-Z0-9]*)|(arn:\\b(aws|aws-us-gov|aws-cn)\\b:[-a-zA-Z0-9:/._+]*)$" } }, "com.amazonaws.cloudformation#StackPolicyBody": { @@ -7064,7 +7908,7 @@ "com.amazonaws.cloudformation#StackSetNameOrId": { "type": "string", "traits": { - "smithy.api#pattern": "[a-zA-Z][-a-zA-Z0-9]*(?::[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12})?" + "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*(?::[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12})?$" } }, "com.amazonaws.cloudformation#StackSetNotEmptyException": { @@ -7075,6 +7919,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "StackSetNotEmptyException", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

You can't yet delete this stack set, because it still contains one or more stack\n instances. Delete all stack instances from the stack set before deleting the stack\n set.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -7088,6 +7936,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "StackSetNotFoundException", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified stack set doesn't exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -7214,25 +8066,25 @@ "FailureToleranceCount": { "target": "com.amazonaws.cloudformation#FailureToleranceCount", "traits": { - "smithy.api#documentation": "

The number of accounts, per Region, for which this operation can fail before AWS\n CloudFormation stops the operation in that Region. If the operation is stopped in a Region,\n AWS CloudFormation doesn't attempt the operation in any subsequent Regions.

\n

Conditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage (but not both).

" + "smithy.api#documentation": "

The number of accounts, per Region, for which this operation can fail before AWS\n CloudFormation stops the operation in that Region. If the operation is stopped in a Region,\n AWS CloudFormation doesn't attempt the operation in any subsequent Regions.

\n

Conditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage (but not both).

\n

By default, 0 is specified.

" } }, "FailureTolerancePercentage": { "target": "com.amazonaws.cloudformation#FailureTolerancePercentage", "traits": { - "smithy.api#documentation": "

The percentage of accounts, per Region, for which this stack operation can fail\n before AWS CloudFormation stops the operation in that Region. If the operation is stopped\n in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent\n Regions.

\n

When calculating the number of accounts based on the specified percentage, AWS\n CloudFormation rounds down to the next whole number.

\n

Conditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.

" + "smithy.api#documentation": "

The percentage of accounts, per Region, for which this stack operation can fail\n before AWS CloudFormation stops the operation in that Region. If the operation is stopped\n in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent\n Regions.

\n

When calculating the number of accounts based on the specified percentage, AWS\n CloudFormation rounds down to the next whole number.

\n

Conditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.

\n

By default, 0 is specified.

" } }, "MaxConcurrentCount": { "target": "com.amazonaws.cloudformation#MaxConcurrentCount", "traits": { - "smithy.api#documentation": "

The maximum number of accounts in which to perform this operation at one time. This\n is dependent on the value of\n FailureToleranceCount. MaxConcurrentCount is at most one more\n than the FailureToleranceCount.

\n

Note that this setting lets you specify the maximum for\n operations. For large deployments, under certain circumstances the actual number of\n accounts acted upon concurrently may be lower due to service throttling.

\n

Conditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.

" + "smithy.api#documentation": "

The maximum number of accounts in which to perform this operation at one time. This\n is dependent on the value of\n FailureToleranceCount. MaxConcurrentCount is at most one more\n than the FailureToleranceCount.

\n

Note that this setting lets you specify the maximum for\n operations. For large deployments, under certain circumstances the actual number of\n accounts acted upon concurrently may be lower due to service throttling.

\n

Conditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.

\n

By default, 1 is specified.

" } }, "MaxConcurrentPercentage": { "target": "com.amazonaws.cloudformation#MaxConcurrentPercentage", "traits": { - "smithy.api#documentation": "

The maximum percentage of accounts in which to perform this operation at one\n time.

\n

When calculating the number of accounts based on the specified percentage, AWS\n CloudFormation rounds down to the next whole number. This is true except in cases where\n rounding down would result is zero. In this case, CloudFormation sets the number as one\n instead.

\n

Note that this setting lets you specify the maximum for\n operations. For large deployments, under certain circumstances the actual number of\n accounts acted upon concurrently may be lower due to service throttling.

\n

Conditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.

" + "smithy.api#documentation": "

The maximum percentage of accounts in which to perform this operation at one\n time.

\n

When calculating the number of accounts based on the specified percentage, AWS\n CloudFormation rounds down to the next whole number. This is true except in cases where\n rounding down would result is zero. In this case, CloudFormation sets the number as one\n instead.

\n

Note that this setting lets you specify the maximum for\n operations. For large deployments, under certain circumstances the actual number of\n accounts acted upon concurrently may be lower due to service throttling.

\n

Conditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.

\n

By default, 1 is specified.

" } } }, @@ -7676,6 +8528,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "StaleRequestException", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

Another operation has been performed on this stack set since the specified operation\n was performed.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -7742,6 +8598,22 @@ "type": "structure", "members": {} }, + "com.amazonaws.cloudformation#SupportedMajorVersion": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 65535 + } + } + }, + "com.amazonaws.cloudformation#SupportedMajorVersions": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#SupportedMajorVersion" + } + }, "com.amazonaws.cloudformation#Tag": { "type": "structure", "members": { @@ -7867,6 +8739,98 @@ } } }, + "com.amazonaws.cloudformation#TestType": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#TestTypeInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#TestTypeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#CFNRegistryException" + }, + { + "target": "com.amazonaws.cloudformation#TypeNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.

\n \n

For more information, see Testing your public extension prior to publishing in the CloudFormation CLI User Guide.

\n

If you do not specify a version, CloudFormation uses the default version of the extension in your account and region for testing.

\n

To perform testing, CloudFormation assumes the execution role specified when the test was registered. For more information, see RegisterType.

\n

Once you've initiated testing on an extension using TestType, you can use DescribeType to monitor the current test status and test status description for the extension.

\n

An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudformation#TestTypeInput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.cloudformation#TypeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the extension.

\n

Conditional: You must specify Arn, or TypeName and Type.

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

The type of the extension to test.

\n

Conditional: You must specify Arn, or TypeName and Type.

" + } + }, + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "

The name of the extension to test.

\n

Conditional: You must specify Arn, or TypeName and Type.

" + } + }, + "VersionId": { + "target": "com.amazonaws.cloudformation#TypeVersionId", + "traits": { + "smithy.api#documentation": "

The version of the extension to test.

\n

You can specify the version id with either Arn, or with TypeName and Type.

\n

If you do not specify a version, CloudFormation uses the default version of the extension in this account and region for testing.

" + } + }, + "LogDeliveryBucket": { + "target": "com.amazonaws.cloudformation#S3Bucket", + "traits": { + "smithy.api#documentation": "

The S3 bucket to which CloudFormation delivers the contract test execution logs.

\n

CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of PASSED or FAILED.

\n

The user calling TestType must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:

\n \n

For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access Management User Guide.

" + } + } + } + }, + "com.amazonaws.cloudformation#TestTypeOutput": { + "type": "structure", + "members": { + "TypeVersionArn": { + "target": "com.amazonaws.cloudformation#TypeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the extension.

" + } + } + } + }, + "com.amazonaws.cloudformation#ThirdPartyType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RESOURCE", + "name": "RESOURCE" + }, + { + "value": "MODULE", + "name": "MODULE" + } + ] + } + }, + "com.amazonaws.cloudformation#ThirdPartyTypeArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}::type/.+/[0-9a-zA-Z]{12,40}/.+$" + } + }, "com.amazonaws.cloudformation#TimeoutMinutes": { "type": "integer", "traits": { @@ -7887,6 +8851,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "TokenAlreadyExistsException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

A client request token already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7919,7 +8887,185 @@ "min": 0, "max": 1024 }, - "smithy.api#pattern": "arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+" + "smithy.api#pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+$" + } + }, + "com.amazonaws.cloudformation#TypeConfiguration": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 204800 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.cloudformation#TypeConfigurationAlias": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]{1,256}$" + } + }, + "com.amazonaws.cloudformation#TypeConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type-configuration/.+$" + } + }, + "com.amazonaws.cloudformation#TypeConfigurationDetails": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.cloudformation#TypeConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the configuration data, in this account and region.

" + } + }, + "Alias": { + "target": "com.amazonaws.cloudformation#TypeConfigurationAlias", + "traits": { + "smithy.api#documentation": "

The alias specified for this configuration, if one was specified when the configuration was set.

" + } + }, + "Configuration": { + "target": "com.amazonaws.cloudformation#TypeConfiguration", + "traits": { + "smithy.api#documentation": "

A JSON string specifying the configuration data for the extension, in this account and region.

\n

If a configuration has not been set for a specified extension, CloudFormation returns {}.

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

When the configuration data was last updated for this extension.

\n

If a configuration has not been set for a specified extension, CloudFormation returns null.

" + } + }, + "TypeArn": { + "target": "com.amazonaws.cloudformation#TypeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the extension, in this account and region.

\n

For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.

" + } + }, + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "

The name of the extension.

" + } + }, + "IsDefaultConfiguration": { + "target": "com.amazonaws.cloudformation#IsDefaultConfiguration", + "traits": { + "smithy.api#documentation": "

Whether or not this configuration data is the default configuration for the extension.

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

Detailed information concerning the specification of a CloudFormation extension in a given account and region.

\n

For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

" + } + }, + "com.amazonaws.cloudformation#TypeConfigurationDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#TypeConfigurationDetails" + } + }, + "com.amazonaws.cloudformation#TypeConfigurationIdentifier": { + "type": "structure", + "members": { + "TypeArn": { + "target": "com.amazonaws.cloudformation#TypeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the extension, in this account and region.

\n

For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.

" + } + }, + "TypeConfigurationAlias": { + "target": "com.amazonaws.cloudformation#TypeConfigurationAlias", + "traits": { + "smithy.api#documentation": "

The alias specified for this configuration, if one was specified when the configuration was set.

" + } + }, + "TypeConfigurationArn": { + "target": "com.amazonaws.cloudformation#TypeConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the configuration, in this account and region.

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

The type of extension.

" + } + }, + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "

The name of the extension type to which this configuration applies.

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

Identifying information for the configuration of a CloudFormation extension.

" + } + }, + "com.amazonaws.cloudformation#TypeConfigurationIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#TypeConfigurationIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudformation#TypeConfigurationNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TypeConfigurationNotFoundException", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified extension configuration cannot be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudformation#TypeFilters": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.cloudformation#Category", + "traits": { + "smithy.api#documentation": "

The category of extensions to return.

\n " + } + }, + "PublisherId": { + "target": "com.amazonaws.cloudformation#PublisherId", + "traits": { + "smithy.api#documentation": "

The id of the publisher of the extension.

\n

Extensions published by Amazon are not assigned a publisher ID. Use the AWS-TYPES category to specify a list of types published by Amazon.

" + } + }, + "TypeNamePrefix": { + "target": "com.amazonaws.cloudformation#TypeNamePrefix", + "traits": { + "smithy.api#documentation": "

A prefix to use as a filter for results.

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

Filter criteria to use in determining which extensions to return.

" } }, "com.amazonaws.cloudformation#TypeHierarchy": { @@ -7932,7 +9078,17 @@ "min": 10, "max": 204 }, - "smithy.api#pattern": "[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}" + "smithy.api#pattern": "^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}$" + } + }, + "com.amazonaws.cloudformation#TypeNamePrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 204 + }, + "smithy.api#pattern": "^([A-Za-z0-9]{2,64}::){0,2}([A-Za-z0-9]{2,64}:?){0,1}$" } }, "com.amazonaws.cloudformation#TypeNotFoundException": { @@ -7943,7 +9099,11 @@ } }, "traits": { - "smithy.api#documentation": "

The specified type does not exist in the CloudFormation registry.

", + "aws.protocols#awsQueryError": { + "code": "TypeNotFoundException", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified extension does not exist in the CloudFormation registry.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -7969,42 +9129,117 @@ "Type": { "target": "com.amazonaws.cloudformation#RegistryType", "traits": { - "smithy.api#documentation": "

The kind of type.

" + "smithy.api#documentation": "

The kind of extension.

" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The name of the type.

" + "smithy.api#documentation": "

The name of the extension.

\n

If you specified a TypeNameAlias when you activate this extension in your account and region, CloudFormation considers that alias as the type name.

" } }, "DefaultVersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "

The ID of the default version of the type. The default version is used when the type version is not specified.

\n

To set the default version of a type, use \n SetTypeDefaultVersion\n .

" + "smithy.api#documentation": "

The ID of the default version of the extension. The default version is used when the extension version is not specified.

\n

This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon and published by third parties, CloudFormation returns null. For more information, see RegisterType.

\n

To set the default version of an extension, use \n SetTypeDefaultVersion\n .

" } }, "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the type.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension.

" } }, "LastUpdated": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

When the current default version of the type was registered.

" + "smithy.api#documentation": "

When the specified extension version was registered. This applies only to:

\n \n

For all other extension types, CloudFormation returns null.

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

The description of the type.

" + "smithy.api#documentation": "

The description of the extension.

" + } + }, + "PublisherId": { + "target": "com.amazonaws.cloudformation#PublisherId", + "traits": { + "smithy.api#documentation": "

The ID of the extension publisher, if the extension is published by a third party. Extensions published by Amazon do not return a publisher ID.

" + } + }, + "OriginalTypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "

For public extensions that have been activated for this account and region, the type name of the public extension.

\n

If you specified a TypeNameAlias when enabling the extension in this account and region, CloudFormation treats that alias as the extension's type name within the account and region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.

" + } + }, + "PublicVersionNumber": { + "target": "com.amazonaws.cloudformation#PublicVersionNumber", + "traits": { + "smithy.api#documentation": "

For public extensions that have been activated for this account and region, the version of the public extension to be used for CloudFormation operations in this account and region.

\n

How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extention in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.

" + } + }, + "LatestPublicVersion": { + "target": "com.amazonaws.cloudformation#PublicVersionNumber", + "traits": { + "smithy.api#documentation": "

For public extensions that have been activated for this account and region, the latest version of the public extension that is available. For any extensions other than activated third-arty extensions, CloudFormation returns null.

\n

How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extention in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.

" + } + }, + "PublisherIdentity": { + "target": "com.amazonaws.cloudformation#IdentityProvider", + "traits": { + "smithy.api#documentation": "

The service used to verify the publisher identity.

\n

For more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.

" + } + }, + "PublisherName": { + "target": "com.amazonaws.cloudformation#PublisherName", + "traits": { + "smithy.api#documentation": "

The publisher name, as defined in the public profile for that publisher in the service used to verify the publisher identity.

" + } + }, + "IsActivated": { + "target": "com.amazonaws.cloudformation#IsActivated", + "traits": { + "smithy.api#documentation": "

Whether or not the extension is activated for this account and region.

\n

This applies only to third-party public extensions. Extensions published by Amazon are activated by default.

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

Contains summary information about the specified CloudFormation type.

" + "smithy.api#documentation": "

Contains summary information about the specified CloudFormation extension.

" + } + }, + "com.amazonaws.cloudformation#TypeTestsStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PASSED", + "name": "PASSED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "NOT_TESTED", + "name": "NOT_TESTED" + } + ] + } + }, + "com.amazonaws.cloudformation#TypeTestsStatusDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\s\\S]+$" } }, "com.amazonaws.cloudformation#TypeVersionId": { @@ -8014,7 +9249,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[A-Za-z0-9-]+" + "smithy.api#pattern": "^[A-Za-z0-9-]+$" } }, "com.amazonaws.cloudformation#TypeVersionSummaries": { @@ -8029,31 +9264,31 @@ "Type": { "target": "com.amazonaws.cloudformation#RegistryType", "traits": { - "smithy.api#documentation": "

The kind of type.

" + "smithy.api#documentation": "

The kind of extension.

" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The name of the type.

" + "smithy.api#documentation": "

The name of the extension.

" } }, "VersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "

The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.

" + "smithy.api#documentation": "

The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

" } }, "IsDefaultVersion": { "target": "com.amazonaws.cloudformation#IsDefaultVersion", "traits": { - "smithy.api#documentation": "

Whether the specified type version is set as the default version.

" + "smithy.api#documentation": "

Whether the specified extension version is set as the default version.

\n

This applies only to private extensions you have registered in your account, and extensions published by Amazon. For public third-party extensions, whether or not they are activated in your account, CloudFormation returns null.

" } }, "Arn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the type version.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension version.

" } }, "TimeCreated": { @@ -8065,12 +9300,24 @@ "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { - "smithy.api#documentation": "

The description of the type version.

" + "smithy.api#documentation": "

The description of the extension version.

" + } + }, + "PublicVersionNumber": { + "target": "com.amazonaws.cloudformation#PublicVersionNumber", + "traits": { + "smithy.api#documentation": "

For public extensions that have been activated for this account and region, the version of the public extension to be used for CloudFormation operations in this account and region. For any extensions other than activated third-arty extensions, CloudFormation returns null.

\n

How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically updates the extention in this account and region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the CloudFormation User Guide.

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

Contains summary information about a specific version of a CloudFormation type.

" + "smithy.api#documentation": "

Contains summary information about a specific version of a CloudFormation extension.

" + } + }, + "com.amazonaws.cloudformation#UnprocessedTypeConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#TypeConfigurationIdentifier" } }, "com.amazonaws.cloudformation#UpdateStack": { @@ -8602,6 +9849,21 @@ "com.amazonaws.cloudformation#Version": { "type": "string" }, + "com.amazonaws.cloudformation#VersionBump": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MAJOR", + "name": "MAJOR" + }, + { + "value": "MINOR", + "name": "MINOR" + } + ] + } + }, "com.amazonaws.cloudformation#Visibility": { "type": "string", "traits": { diff --git a/aws/sdk/aws-models/cloudfront.json b/aws/sdk/aws-models/cloudfront.json index 47e47be21..d1e9e760c 100644 --- a/aws/sdk/aws-models/cloudfront.json +++ b/aws/sdk/aws-models/cloudfront.json @@ -8595,6 +8595,10 @@ { "value": "TLSv1.2_2019", "name": "TLSv1_2_2019" + }, + { + "value": "TLSv1.2_2021", + "name": "TLSv1_2_2021" } ] } diff --git a/aws/sdk/aws-models/cloudsearch.json b/aws/sdk/aws-models/cloudsearch.json index 504b356c1..22c9918a1 100644 --- a/aws/sdk/aws-models/cloudsearch.json +++ b/aws/sdk/aws-models/cloudsearch.json @@ -531,6 +531,12 @@ }, { "target": "com.amazonaws.cloudsearch#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudsearch#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudsearch#ValidationException" } ], "traits": { @@ -1749,6 +1755,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DisabledAction", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

The request was rejected because it attempted an operation which is not enabled.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -1841,7 +1851,7 @@ "min": 3, "max": 28 }, - "smithy.api#pattern": "[a-z][a-z0-9\\-]+" + "smithy.api#pattern": "^[a-z][a-z0-9\\-]+$" } }, "com.amazonaws.cloudsearch#DomainNameList": { @@ -2050,7 +2060,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "([a-z][a-z0-9_]*\\*?|\\*[a-z0-9_]*)" + "smithy.api#pattern": "^([a-z][a-z0-9_]*\\*?|\\*[a-z0-9_]*)$" } }, "com.amazonaws.cloudsearch#DynamicFieldNameList": { @@ -2139,13 +2149,13 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[a-z][a-z0-9_]*" + "smithy.api#pattern": "^[a-z][a-z0-9_]*$" } }, "com.amazonaws.cloudsearch#FieldNameCommaList": { "type": "string", "traits": { - "smithy.api#pattern": "\\s*[a-z*][a-z0-9_]*\\*?\\s*(,\\s*[a-z*][a-z0-9_]*\\*?\\s*)*" + "smithy.api#pattern": "^\\s*[a-z*][a-z0-9_]*\\*?\\s*(,\\s*[a-z*][a-z0-9_]*\\*?\\s*)*$" } }, "com.amazonaws.cloudsearch#FieldNameList": { @@ -2454,6 +2464,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InternalException", + "httpResponseCode": 500 + }, "smithy.api#documentation": "

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

", "smithy.api#error": "server", "smithy.api#httpError": 500 @@ -2470,6 +2484,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidType", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

The request was rejected because it specified an invalid type definition.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -2527,6 +2545,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "LimitExceeded", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

The request was rejected because a resource limit has already been met.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -2811,6 +2833,22 @@ { "value": "search.2xlarge", "name": "search_2xlarge" + }, + { + "value": "search.previousgeneration.small", + "name": "search_previousgeneration_small" + }, + { + "value": "search.previousgeneration.large", + "name": "search_previousgeneration_large" + }, + { + "value": "search.previousgeneration.xlarge", + "name": "search_previousgeneration_xlarge" + }, + { + "value": "search.previousgeneration.2xlarge", + "name": "search_previousgeneration_2xlarge" } ] } @@ -2821,6 +2859,26 @@ "smithy.api#documentation": "

Access rules for a domain's document or search service endpoints. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide. The maximum size of a policy document is 100 KB.

" } }, + "com.amazonaws.cloudsearch#ResourceAlreadyExistsException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.cloudsearch#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.cloudsearch#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceAlreadyExists", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "

The request was rejected because it attempted to create a resource that already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.cloudsearch#ResourceNotFoundException": { "type": "structure", "members": { @@ -2832,6 +2890,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFound", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

The request was rejected because it attempted to reference a resource that does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -2914,7 +2976,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[a-z][a-z0-9_]*" + "smithy.api#pattern": "^[a-z][a-z0-9_]*$" } }, "com.amazonaws.cloudsearch#StandardNameList": { @@ -3388,7 +3450,7 @@ "com.amazonaws.cloudsearch#Word": { "type": "string", "traits": { - "smithy.api#pattern": "[\\S]+" + "smithy.api#pattern": "^[\\S]+$" } } } diff --git a/aws/sdk/aws-models/codebuild.json b/aws/sdk/aws-models/codebuild.json index 83c4a1bea..8c338794c 100644 --- a/aws/sdk/aws-models/codebuild.json +++ b/aws/sdk/aws-models/codebuild.json @@ -37,7 +37,7 @@ } }, "traits": { - "smithy.api#documentation": "

An AWS service limit was exceeded for the calling AWS account.

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

An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.

", "smithy.api#error": "client" } }, @@ -270,7 +270,7 @@ "names": { "target": "com.amazonaws.codebuild#ProjectNames", "traits": { - "smithy.api#documentation": "

The names or ARNs of the build projects. To get information about a project shared\n with your AWS account, its ARN must be specified. You cannot specify a shared project\n using its name.

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

The names or ARNs of the build projects. To get information about a project shared\n with your Amazon Web Services account, its ARN must be specified. You cannot specify a shared project\n using its name.

", "smithy.api#required": {} } } @@ -397,7 +397,7 @@ "computeTypesAllowed": { "target": "com.amazonaws.codebuild#ComputeTypesAllowed", "traits": { - "smithy.api#documentation": "

An array of strings that specify the compute types that are allowed for the batch\n build. See Build environment\n compute types in the AWS CodeBuild User Guide for these values.\n

" + "smithy.api#documentation": "

An array of strings that specify the compute types that are allowed for the batch\n build. See Build environment\n compute types in the CodeBuild User Guide for these values.\n

" } } }, @@ -408,26 +408,6 @@ "com.amazonaws.codebuild#Boolean": { "type": "boolean" }, - "com.amazonaws.codebuild#BucketOwnerAccess": { - "type": "string", - "traits": { - "smithy.api#documentation": "

Specifies the access for objects that are uploaded to an Amazon S3 bucket that is owned by\n another account.

\n

By default, only the account that uploads the objects to the bucket has access to\n these objects. This property allows you to give the bucket owner access to these\n objects.

\n
\n
NONE
\n
\n

The bucket owner does not have access to the objects. This is the\n default.

\n
\n
READ_ONLY
\n
\n

The bucket owner has read only access to the objects. The uploading account\n retains ownership of the objects.

\n
\n
FULL
\n
\n

The bucket owner has full access to the objects. Object ownership is determined\n by the following criteria:

\n
    \n
  • \n

    If the bucket is configured with the Bucket\n owner preferred setting, the bucket owner owns the\n objects. The uploading account will have object access as specified\n by the bucket's policy.

    \n
    • \n
  • \n

    Otherwise, the uploading account retains ownership of the\n objects.

    \n
    • \n
\n

For more information about Amazon S3 object ownership, see Controlling ownership of uploaded objects using S3\n Object Ownership in the Amazon Simple Storage Service User\n Guide.

\n
\n
", - "smithy.api#enum": [ - { - "value": "NONE", - "name": "NONE" - }, - { - "value": "READ_ONLY", - "name": "READ_ONLY" - }, - { - "value": "FULL", - "name": "FULL" - } - ] - } - }, "com.amazonaws.codebuild#Build": { "type": "structure", "members": { @@ -476,19 +456,19 @@ "sourceVersion": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

Any version identifier for the version of the source code to be built. If\n sourceVersion is specified at the project level, then this\n sourceVersion (at the build level) takes precedence.

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

" + "smithy.api#documentation": "

Any version identifier for the version of the source code to be built. If\n sourceVersion is specified at the project level, then this\n sourceVersion (at the build level) takes precedence.

\n

For more information, see Source Version Sample\n with CodeBuild in the CodeBuild User Guide.

" } }, "resolvedSourceVersion": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

An identifier for the version of this build's source code.

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

An identifier for the version of this build's source code.

\n " } }, "projectName": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the AWS CodeBuild project.

" + "smithy.api#documentation": "

The name of the CodeBuild project.

" } }, "phases": { @@ -512,7 +492,7 @@ "secondarySourceVersions": { "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", "traits": { - "smithy.api#documentation": "

An array of ProjectSourceVersion objects. Each\n ProjectSourceVersion must be one of:

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

An array of ProjectSourceVersion objects. Each\n ProjectSourceVersion must be one of:

\n " } }, "artifacts": { @@ -548,13 +528,13 @@ "logs": { "target": "com.amazonaws.codebuild#LogsLocation", "traits": { - "smithy.api#documentation": "

Information about the build's logs in Amazon CloudWatch Logs.

" + "smithy.api#documentation": "

Information about the build's logs in CloudWatch Logs.

" } }, "timeoutInMinutes": { "target": "com.amazonaws.codebuild#WrapperInt", "traits": { - "smithy.api#documentation": "

How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not\n get marked as completed.

" + "smithy.api#documentation": "

How long, in minutes, for CodeBuild to wait before timing out this build if it does\n not get marked as completed.

" } }, "queuedTimeoutInMinutes": { @@ -572,13 +552,13 @@ "initiator": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The entity that started the build. Valid values include:

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

The entity that started the build. Valid values include:

\n " } }, "vpcConfig": { "target": "com.amazonaws.codebuild#VpcConfig", "traits": { - "smithy.api#documentation": "

If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter\n that identifies the VPC ID and the list of security group IDs and subnet IDs. The\n security groups and subnets must belong to the same VPC. You must provide at least one\n security group and one subnet ID.

" + "smithy.api#documentation": "

If your CodeBuild project accesses resources in an Amazon VPC, you provide this\n parameter that identifies the VPC ID and the list of security group IDs and subnet IDs.\n The security groups and subnets must belong to the same VPC. You must provide at least\n one security group and one subnet ID.

" } }, "networkInterface": { @@ -590,13 +570,13 @@ "encryptionKey": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" + "smithy.api#documentation": "

The Key Management Service customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" } }, "exportedEnvironmentVariables": { "target": "com.amazonaws.codebuild#ExportedEnvironmentVariables", "traits": { - "smithy.api#documentation": "

A list of exported environment variables for this build.

\n

Exported environment variables are used in conjunction with AWS CodePipeline to export\n environment variables from the current build stage to subsequent stages in the pipeline.\n For more information, see Working with variables in the AWS CodePipeline User Guide.

" + "smithy.api#documentation": "

A list of exported environment variables for this build.

\n

Exported environment variables are used in conjunction with CodePipeline to export\n environment variables from the current build stage to subsequent stages in the pipeline.\n For more information, see Working with variables in the CodePipeline User Guide.

" } }, "reportArns": { @@ -666,9 +646,6 @@ "traits": { "smithy.api#documentation": "

An identifier for this artifact definition.

" } - }, - "bucketOwnerAccess": { - "target": "com.amazonaws.codebuild#BucketOwnerAccess" } }, "traits": { @@ -735,7 +712,7 @@ "resolvedSourceVersion": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The identifier of the resolved version of this batch build's source code.

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

The identifier of the resolved version of this batch build's source code.

\n " } }, "projectName": { @@ -762,7 +739,7 @@ "secondarySourceVersions": { "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", "traits": { - "smithy.api#documentation": "

An array of ProjectSourceVersion objects. Each\n ProjectSourceVersion must be one of:

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

An array of ProjectSourceVersion objects. Each\n ProjectSourceVersion must be one of:

\n " } }, "artifacts": { @@ -813,7 +790,7 @@ "initiator": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The entity that started the batch build. Valid values include:

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

The entity that started the batch build. Valid values include:

\n " } }, "vpcConfig": { @@ -822,7 +799,7 @@ "encryptionKey": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the batch build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" + "smithy.api#documentation": "

The Key Management Service customer master key (CMK) to be used for encrypting the batch build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" } }, "buildBatchNumber": { @@ -1180,7 +1157,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information that defines how the AWS CodeBuild build project reports the build status\n to the source provider.

" + "smithy.api#documentation": "

Contains information that defines how the CodeBuild build project reports the build status\n to the source provider.

" } }, "com.amazonaws.codebuild#BuildSummaries": { @@ -1283,25 +1260,25 @@ "status": { "target": "com.amazonaws.codebuild#LogsConfigStatusType", "traits": { - "smithy.api#documentation": "

The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are:

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

The current status of the logs in CloudWatch Logs for a build project. Valid values are:

\n ", "smithy.api#required": {} } }, "groupName": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The group name of the logs in Amazon CloudWatch Logs. For more information, see Working\n with Log Groups and Log Streams.

" + "smithy.api#documentation": "

The group name of the logs in CloudWatch Logs. For more information, see Working\n with Log Groups and Log Streams.

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

The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see Working\n with Log Groups and Log Streams.

" + "smithy.api#documentation": "

The prefix of the stream name of the CloudWatch Logs. For more information, see Working\n with Log Groups and Log Streams.

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

Information about Amazon CloudWatch Logs for a build project.

" + "smithy.api#documentation": "

Information about CloudWatch Logs for a build project.

" } }, "com.amazonaws.codebuild#CodeBuild_20161006": { @@ -1453,7 +1430,7 @@ "name": "codebuild" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "AWS CodeBuild\n

AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code,\n runs unit tests, and produces artifacts that are ready to deploy. AWS CodeBuild eliminates the\n need to provision, manage, and scale your own build servers. It provides prepackaged\n build environments for the most popular programming languages and build tools, such as\n Apache Maven, Gradle, and more. You can also fully customize build environments in AWS CodeBuild\n to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests. You\n pay only for the build time you consume. For more information about AWS CodeBuild, see the \n AWS CodeBuild User\n Guide.\n

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

CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source\n code, runs unit tests, and produces artifacts that are ready to deploy. CodeBuild eliminates\n the need to provision, manage, and scale your own build servers. It provides prepackaged\n build environments for the most popular programming languages and build tools, such as\n Apache Maven, Gradle, and more. You can also fully customize build environments in CodeBuild\n to use your own build tools. CodeBuild scales automatically to meet peak build requests. You\n pay only for the build time you consume. For more information about CodeBuild, see the \n CodeBuild\n User Guide.\n

", "smithy.api#title": "AWS CodeBuild" } }, @@ -1659,7 +1636,7 @@ "sourceVersion": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A version of the build input to be built for this project. If not specified, the latest\n version is used. If specified, it must be one of:

\n \n

If sourceVersion is specified at the build level, then that version takes\n precedence over this sourceVersion (at the project level).

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide. \n

" + "smithy.api#documentation": "

A version of the build input to be built for this project. If not specified, the latest\n version is used. If specified, it must be one of:

\n \n

If sourceVersion is specified at the build level, then that version takes\n precedence over this sourceVersion (at the project level).

\n

For more information, see Source Version Sample\n with CodeBuild in the CodeBuild User Guide. \n

" } }, "secondarySourceVersions": { @@ -1697,14 +1674,14 @@ "serviceRole": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services\n on behalf of the AWS account.

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

The ARN of the Identity and Access Management role that enables CodeBuild to interact with dependent Amazon Web Services services\n on behalf of the Amazon Web Services account.

", "smithy.api#required": {} } }, "timeoutInMinutes": { "target": "com.amazonaws.codebuild#TimeOut", "traits": { - "smithy.api#documentation": "

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before it times out\n any build that has not been marked as completed. The default is 60 minutes.

" + "smithy.api#documentation": "

How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before it times out\n any build that has not been marked as completed. The default is 60 minutes.

" } }, "queuedTimeoutInMinutes": { @@ -1716,19 +1693,19 @@ "encryptionKey": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).\n

" + "smithy.api#documentation": "

The Key Management Service customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).\n

" } }, "tags": { "target": "com.amazonaws.codebuild#TagList", "traits": { - "smithy.api#documentation": "

A list of tag key and value pairs associated with this build project.

\n

These tags are available for use by AWS services that support AWS CodeBuild build project\n tags.

" + "smithy.api#documentation": "

A list of tag key and value pairs associated with this build project.

\n

These tags are available for use by Amazon Web Services services that support CodeBuild build project\n tags.

" } }, "vpcConfig": { "target": "com.amazonaws.codebuild#VpcConfig", "traits": { - "smithy.api#documentation": "

VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.

" + "smithy.api#documentation": "

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

" } }, "badgeEnabled": { @@ -1740,7 +1717,7 @@ "logsConfig": { "target": "com.amazonaws.codebuild#LogsConfig", "traits": { - "smithy.api#documentation": "

Information about logs for the build project. These can be logs in Amazon CloudWatch Logs, logs\n uploaded to a specified S3 bucket, or both.

" + "smithy.api#documentation": "

Information about logs for the build project. These can be logs in CloudWatch Logs, logs\n uploaded to a specified S3 bucket, or both.

" } }, "fileSystemLocations": { @@ -1824,7 +1801,7 @@ "tags": { "target": "com.amazonaws.codebuild#TagList", "traits": { - "smithy.api#documentation": "

\n A list of tag key and value pairs associated with this report group.\n

\n

These tags are available for use by AWS services that support AWS CodeBuild report group\n tags.

" + "smithy.api#documentation": "

\n A list of tag key and value pairs associated with this report group.\n

\n

These tags are available for use by Amazon Web Services services that support CodeBuild report group\n tags.

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

For an existing AWS CodeBuild build project that has its source code stored in a GitHub or\n Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a\n code change is pushed to the repository.

\n \n

If you enable webhooks for an AWS CodeBuild project, and the project is used as a build\n step in AWS CodePipeline, then two identical builds are created for each commit. One build is\n triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build\n basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we\n recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the\n Webhook box. For more information, see step 5 in Change a Build Project's Settings.

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

For an existing CodeBuild build project that has its source code stored in a GitHub or\n Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a\n code change is pushed to the repository.

\n \n

If you enable webhooks for an CodeBuild project, and the project is used as a build\n step in CodePipeline, then two identical builds are created for each commit. One build is\n triggered through webhooks, and one through CodePipeline. Because billing is on a per-build\n basis, you are billed for both builds. Therefore, if you are using CodePipeline, we\n recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear the\n Webhook box. For more information, see step 5 in Change a Build Project's Settings.

\n " } }, "com.amazonaws.codebuild#CreateWebhookInput": { @@ -1872,7 +1849,7 @@ "projectName": { "target": "com.amazonaws.codebuild#ProjectName", "traits": { - "smithy.api#documentation": "

The name of the AWS CodeBuild project.

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

The name of the CodeBuild project.

", "smithy.api#required": {} } }, @@ -1902,7 +1879,7 @@ "webhook": { "target": "com.amazonaws.codebuild#Webhook", "traits": { - "smithy.api#documentation": "

Information about a webhook that connects repository events to a build project in\n AWS CodeBuild.

" + "smithy.api#documentation": "

Information about a webhook that connects repository events to a build project in\n CodeBuild.

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

For an existing AWS CodeBuild build project that has its source code stored in a GitHub or\n Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code\n change is pushed to the repository.

" + "smithy.api#documentation": "

For an existing CodeBuild build project that has its source code stored in a GitHub or\n Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code\n change is pushed to the repository.

" } }, "com.amazonaws.codebuild#DeleteWebhookInput": { @@ -2200,7 +2177,7 @@ "projectName": { "target": "com.amazonaws.codebuild#ProjectName", "traits": { - "smithy.api#documentation": "

The name of the AWS CodeBuild project.

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

The name of the CodeBuild project.

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

Information about a Docker image that is managed by AWS CodeBuild.

" + "smithy.api#documentation": "

Information about a Docker image that is managed by CodeBuild.

" } }, "com.amazonaws.codebuild#EnvironmentImages": { @@ -2420,7 +2397,7 @@ } }, "traits": { - "smithy.api#documentation": "

A set of Docker images that are related by programming language and are managed by\n AWS CodeBuild.

" + "smithy.api#documentation": "

A set of Docker images that are related by programming language and are managed by\n CodeBuild.

" } }, "com.amazonaws.codebuild#EnvironmentLanguages": { @@ -2446,7 +2423,7 @@ } }, "traits": { - "smithy.api#documentation": "

A set of Docker images that are related by platform and are managed by AWS CodeBuild.

" + "smithy.api#documentation": "

A set of Docker images that are related by platform and are managed by\n CodeBuild.

" } }, "com.amazonaws.codebuild#EnvironmentPlatforms": { @@ -2495,14 +2472,14 @@ "value": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The value of the environment variable.

\n \n

We strongly discourage the use of PLAINTEXT environment variables to\n store sensitive values, especially AWS secret key IDs and secret access keys.\n PLAINTEXT environment variables can be displayed in plain text\n using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI). For sensitive values, we recommend you use an\n environment variable of type PARAMETER_STORE or\n SECRETS_MANAGER.

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

The value of the environment variable.

\n \n

We strongly discourage the use of PLAINTEXT environment variables to\n store sensitive values, especially Amazon Web Services secret key IDs and secret access keys.\n PLAINTEXT environment variables can be displayed in plain text\n using the CodeBuild console and the AWS Command Line Interface (AWS CLI). For sensitive values, we recommend you\n use an environment variable of type PARAMETER_STORE or\n SECRETS_MANAGER.

\n ", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.codebuild#EnvironmentVariableType", "traits": { - "smithy.api#documentation": "

The type of environment variable. Valid values include:

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

The type of environment variable. Valid values include:

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

Contains information about an exported environment variable.

\n

Exported environment variables are used in conjunction with AWS CodePipeline to export\n environment variables from the current build stage to subsequent stages in the pipeline.\n For more information, see Working with variables in the AWS CodePipeline User Guide.

\n \n

During a build, the value of a variable is available starting with the\n install phase. It can be updated between the start of the\n install phase and the end of the post_build phase.\n After the post_build phase ends, the value of exported variables cannot\n change.

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

Contains information about an exported environment variable.

\n

Exported environment variables are used in conjunction with CodePipeline to export\n environment variables from the current build stage to subsequent stages in the pipeline.\n For more information, see Working with variables in the CodePipeline User Guide.

\n \n

During a build, the value of a variable is available starting with the\n install phase. It can be updated between the start of the\n install phase and the end of the post_build phase.\n After the post_build phase ends, the value of exported variables cannot\n change.

\n " } }, "com.amazonaws.codebuild#ExportedEnvironmentVariables": { @@ -2704,13 +2681,13 @@ "fetchSubmodules": { "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { - "smithy.api#documentation": "

Set to true to fetch Git submodules for your AWS CodeBuild build project.

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

Set to true to fetch Git submodules for your CodeBuild build project.

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

Information about the Git submodules configuration for an AWS CodeBuild build project.\n

" + "smithy.api#documentation": "

Information about the Git submodules configuration for an CodeBuild build project.\n

" } }, "com.amazonaws.codebuild#Identifiers": { @@ -2760,7 +2737,7 @@ } ], "traits": { - "smithy.api#documentation": "

Imports the source repository credentials for an AWS CodeBuild project that has its\n source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.

" + "smithy.api#documentation": "

Imports the source repository credentials for an CodeBuild project that has its\n source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.

" } }, "com.amazonaws.codebuild#ImportSourceCredentialsInput": { @@ -2789,7 +2766,7 @@ "authType": { "target": "com.amazonaws.codebuild#AuthType", "traits": { - "smithy.api#documentation": "

The type of authentication used to connect to a GitHub, GitHub Enterprise, or\n Bitbucket repository. An OAUTH connection is not supported by the API and must be\n created using the AWS CodeBuild console.

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

The type of authentication used to connect to a GitHub, GitHub Enterprise, or\n Bitbucket repository. An OAUTH connection is not supported by the API and must be\n created using the CodeBuild console.

", "smithy.api#required": {} } }, @@ -2850,7 +2827,7 @@ "projectName": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the AWS CodeBuild build project that the cache is reset for.

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

The name of the CodeBuild build project that the cache is reset for.

", "smithy.api#required": {} } } @@ -3117,7 +3094,7 @@ "projectName": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the AWS CodeBuild project.

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

The name of the CodeBuild project.

", "smithy.api#required": {} } }, @@ -3195,7 +3172,7 @@ "target": "com.amazonaws.codebuild#ListCuratedEnvironmentImagesOutput" }, "traits": { - "smithy.api#documentation": "

Gets information about Docker images that are managed by AWS CodeBuild.

" + "smithy.api#documentation": "

Gets information about Docker images that are managed by CodeBuild.

" } }, "com.amazonaws.codebuild#ListCuratedEnvironmentImagesInput": { @@ -3208,7 +3185,7 @@ "platforms": { "target": "com.amazonaws.codebuild#EnvironmentPlatforms", "traits": { - "smithy.api#documentation": "

Information about supported platforms for Docker images that are managed by\n AWS CodeBuild.

" + "smithy.api#documentation": "

Information about supported platforms for Docker images that are managed by\n CodeBuild.

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

\n Gets a list ARNs for the report groups in the current AWS account.\n

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

\n Gets a list ARNs for the report groups in the current Amazon Web Services account.\n

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3339,7 +3316,7 @@ "reportGroups": { "target": "com.amazonaws.codebuild#ReportGroupArns", "traits": { - "smithy.api#documentation": "

\n The list of ARNs for the report groups in the current AWS account.\n

" + "smithy.api#documentation": "

\n The list of ARNs for the report groups in the current Amazon Web Services account.\n

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

\n Returns a list of ARNs for the reports in the current AWS account.\n

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

\n Returns a list of ARNs for the reports in the current Amazon Web Services account.\n

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3487,7 +3464,7 @@ "reports": { "target": "com.amazonaws.codebuild#ReportArns", "traits": { - "smithy.api#documentation": "

\n The list of returned ARNs for the reports in the current AWS account.\n

" + "smithy.api#documentation": "

\n The list of returned ARNs for the reports in the current Amazon Web Services account.\n

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

Gets a list of projects that are shared with other AWS accounts or users.

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

Gets a list of projects that are shared with other Amazon Web Services accounts or users.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3521,7 +3498,7 @@ "sortBy": { "target": "com.amazonaws.codebuild#SharedResourceSortByType", "traits": { - "smithy.api#documentation": "

The criterion to be used to list build projects shared with the current AWS account\n or user. Valid values include:

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

The criterion to be used to list build projects shared with the current Amazon Web Services account\n or user. Valid values include:

\n " } }, "sortOrder": { @@ -3556,7 +3533,7 @@ "projects": { "target": "com.amazonaws.codebuild#ProjectArns", "traits": { - "smithy.api#documentation": "

The list of ARNs for the build projects shared with the current AWS account or user.\n

" + "smithy.api#documentation": "

The list of ARNs for the build projects shared with the current Amazon Web Services account or\n user.

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

Gets a list of report groups that are shared with other AWS accounts or users.\n

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

Gets a list of report groups that are shared with other Amazon Web Services accounts or users.\n

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3596,7 +3573,7 @@ "sortBy": { "target": "com.amazonaws.codebuild#SharedResourceSortByType", "traits": { - "smithy.api#documentation": "

The criterion to be used to list report groups shared with the current AWS account or\n user. Valid values include:

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

The criterion to be used to list report groups shared with the current Amazon Web Services account\n or user. Valid values include:

\n " } }, "nextToken": { @@ -3625,7 +3602,7 @@ "reportGroups": { "target": "com.amazonaws.codebuild#ReportGroupArns", "traits": { - "smithy.api#documentation": "

The list of ARNs for the report groups shared with the current AWS account or user.\n

" + "smithy.api#documentation": "

The list of ARNs for the report groups shared with the current Amazon Web Services account or user.\n

" } } } @@ -3668,7 +3645,7 @@ "cloudWatchLogs": { "target": "com.amazonaws.codebuild#CloudWatchLogsConfig", "traits": { - "smithy.api#documentation": "

Information about Amazon CloudWatch Logs for a build project. Amazon CloudWatch Logs are enabled by default.

" + "smithy.api#documentation": "

Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.

" } }, "s3Logs": { @@ -3679,7 +3656,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a\n specified S3 bucket, or both.

" + "smithy.api#documentation": "

Information about logs for a build project. These can be logs in CloudWatch Logs, built in a\n specified S3 bucket, or both.

" } }, "com.amazonaws.codebuild#LogsConfigStatusType": { @@ -3703,19 +3680,19 @@ "groupName": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs group for the build logs.

" + "smithy.api#documentation": "

The name of the CloudWatch Logs group for the build logs.

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

The name of the Amazon CloudWatch Logs stream for the build logs.

" + "smithy.api#documentation": "

The name of the CloudWatch Logs stream for the build logs.

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

The URL to an individual build log in Amazon CloudWatch Logs.

" + "smithy.api#documentation": "

The URL to an individual build log in CloudWatch Logs.

" } }, "s3DeepLink": { @@ -3727,7 +3704,7 @@ "cloudWatchLogsArn": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The ARN of Amazon CloudWatch Logs for a build project. Its format is\n arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}.\n For more information, see Resources Defined by Amazon CloudWatch Logs.

" + "smithy.api#documentation": "

The ARN of CloudWatch Logs for a build project. Its format is\n arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}.\n For more information, see Resources Defined by CloudWatch Logs.

" } }, "s3LogsArn": { @@ -3739,7 +3716,7 @@ "cloudWatchLogs": { "target": "com.amazonaws.codebuild#CloudWatchLogsConfig", "traits": { - "smithy.api#documentation": "

Information about Amazon CloudWatch Logs for a build project.

" + "smithy.api#documentation": "

Information about CloudWatch Logs for a build project.

" } }, "s3Logs": { @@ -3750,7 +3727,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about build logs in Amazon CloudWatch Logs.

" + "smithy.api#documentation": "

Information about build logs in CloudWatch Logs.

" } }, "com.amazonaws.codebuild#NetworkInterface": { @@ -3907,7 +3884,7 @@ "sourceVersion": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A version of the build input to be built for this project. If not specified, the\n latest version is used. If specified, it must be one of:

\n \n

If sourceVersion is specified at the build level, then that version\n takes precedence over this sourceVersion (at the project level).

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide. \n

" + "smithy.api#documentation": "

A version of the build input to be built for this project. If not specified, the\n latest version is used. If specified, it must be one of:

\n \n

If sourceVersion is specified at the build level, then that version\n takes precedence over this sourceVersion (at the project level).

\n

For more information, see Source Version Sample\n with CodeBuild in the CodeBuild User Guide. \n

" } }, "secondarySourceVersions": { @@ -3943,13 +3920,13 @@ "serviceRole": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services\n on behalf of the AWS account.

" + "smithy.api#documentation": "

The ARN of the Identity and Access Management role that enables CodeBuild to interact with dependent Amazon Web Services services\n on behalf of the Amazon Web Services account.

" } }, "timeoutInMinutes": { "target": "com.amazonaws.codebuild#TimeOut", "traits": { - "smithy.api#documentation": "

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any\n related build that did not get marked as completed. The default is 60 minutes.

" + "smithy.api#documentation": "

How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any\n related build that did not get marked as completed. The default is 60 minutes.

" } }, "queuedTimeoutInMinutes": { @@ -3961,13 +3938,13 @@ "encryptionKey": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).\n

" + "smithy.api#documentation": "

The Key Management Service customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/). If you don't specify a \n value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).\n

" } }, "tags": { "target": "com.amazonaws.codebuild#TagList", "traits": { - "smithy.api#documentation": "

A list of tag key and value pairs associated with this build project.

\n

These tags are available for use by AWS services that support AWS CodeBuild build project\n tags.

" + "smithy.api#documentation": "

A list of tag key and value pairs associated with this build project.

\n

These tags are available for use by Amazon Web Services services that support CodeBuild build project\n tags.

" } }, "created": { @@ -3985,13 +3962,13 @@ "webhook": { "target": "com.amazonaws.codebuild#Webhook", "traits": { - "smithy.api#documentation": "

Information about a webhook that connects repository events to a build project in\n AWS CodeBuild.

" + "smithy.api#documentation": "

Information about a webhook that connects repository events to a build project in\n CodeBuild.

" } }, "vpcConfig": { "target": "com.amazonaws.codebuild#VpcConfig", "traits": { - "smithy.api#documentation": "

Information about the VPC configuration that AWS CodeBuild accesses.

" + "smithy.api#documentation": "

Information about the VPC configuration that CodeBuild accesses.

" } }, "badge": { @@ -4003,7 +3980,7 @@ "logsConfig": { "target": "com.amazonaws.codebuild#LogsConfig", "traits": { - "smithy.api#documentation": "

Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an\n S3 bucket, or both.

" + "smithy.api#documentation": "

Information about logs for the build project. A project can create logs in CloudWatch Logs, an\n S3 bucket, or both.

" } }, "fileSystemLocations": { @@ -4047,38 +4024,38 @@ "type": { "target": "com.amazonaws.codebuild#ArtifactsType", "traits": { - "smithy.api#documentation": "

The type of build output artifact. Valid values include:

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

The type of build output artifact. Valid values include:

\n ", "smithy.api#required": {} } }, "location": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

Information about the build output artifact location:

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

Information about the build output artifact location:

\n " } }, "path": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

Along with namespaceType and name, the pattern that AWS CodeBuild\n uses to name and store the output artifact:

\n \n

For example, if path is set to MyArtifacts,\n namespaceType is set to NONE, and name is set\n to MyArtifact.zip, the output artifact is stored in the output bucket at\n MyArtifacts/MyArtifact.zip.

" + "smithy.api#documentation": "

Along with namespaceType and name, the pattern that\n CodeBuild uses to name and store the output artifact:

\n \n

For example, if path is set to MyArtifacts,\n namespaceType is set to NONE, and name is set\n to MyArtifact.zip, the output artifact is stored in the output bucket at\n MyArtifacts/MyArtifact.zip.

" } }, "namespaceType": { "target": "com.amazonaws.codebuild#ArtifactNamespace", "traits": { - "smithy.api#documentation": "

Along with path and name, the pattern that AWS CodeBuild uses to\n determine the name and location to store the output artifact:

\n \n

For example, if path is set to MyArtifacts,\n namespaceType is set to BUILD_ID, and name is\n set to MyArtifact.zip, the output artifact is stored in\n MyArtifacts//MyArtifact.zip.

" + "smithy.api#documentation": "

Along with path and name, the pattern that CodeBuild uses to\n determine the name and location to store the output artifact:

\n \n

For example, if path is set to MyArtifacts,\n namespaceType is set to BUILD_ID, and name is\n set to MyArtifact.zip, the output artifact is stored in\n MyArtifacts//MyArtifact.zip.

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

Along with path and namespaceType, the pattern that AWS CodeBuild\n uses to name and store the output artifact:

\n \n

For example:

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

Along with path and namespaceType, the pattern that\n CodeBuild uses to name and store the output artifact:

\n \n

For example:

\n " } }, "packaging": { "target": "com.amazonaws.codebuild#ArtifactPackaging", "traits": { - "smithy.api#documentation": "

The type of build output artifact to create:

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

The type of build output artifact to create:

\n " } }, "overrideArtifactName": { @@ -4098,9 +4075,6 @@ "traits": { "smithy.api#documentation": "

An identifier for this artifact definition.

" } - }, - "bucketOwnerAccess": { - "target": "com.amazonaws.codebuild#BucketOwnerAccess" } }, "traits": { @@ -4219,21 +4193,21 @@ "type": { "target": "com.amazonaws.codebuild#EnvironmentType", "traits": { - "smithy.api#documentation": "

The type of build environment to use for related builds.

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

The type of build environment to use for related builds.

\n \n \n

For more information, see Build environment compute types in the CodeBuild\n user guide.

", "smithy.api#required": {} } }, "image": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The image tag or image digest that identifies the Docker image to use for this build\n project. Use the following formats:

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

The image tag or image digest that identifies the Docker image to use for this build\n project. Use the following formats:

\n \n

For more information, see Docker images provided by CodeBuild in the CodeBuild user\n guide.

", "smithy.api#required": {} } }, "computeType": { "target": "com.amazonaws.codebuild#ComputeType", "traits": { - "smithy.api#documentation": "

Information about the compute resources the build project uses. Available values\n include:

\n \n

If you use BUILD_GENERAL1_LARGE:

\n \n

For more information, see Build Environment\n Compute Types in the AWS CodeBuild User Guide.\n

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

Information about the compute resources the build project uses. Available values\n include:

\n \n

If you use BUILD_GENERAL1_LARGE:

\n \n

For more information, see Build Environment\n Compute Types in the CodeBuild User Guide.\n

", "smithy.api#required": {} } }, @@ -4252,7 +4226,7 @@ "certificate": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded\n certificate for the build project. For more information, see certificate in the\n AWS CodeBuild User Guide.

" + "smithy.api#documentation": "

The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded\n certificate for the build project. For more information, see certificate in the\n CodeBuild User Guide.

" } }, "registryCredential": { @@ -4264,7 +4238,7 @@ "imagePullCredentialsType": { "target": "com.amazonaws.codebuild#ImagePullCredentialsType", "traits": { - "smithy.api#documentation": "

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid\n values:

\n \n

When you use a cross-account or private registry image, you must use SERVICE_ROLE\n credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.\n

" + "smithy.api#documentation": "

The type of credentials CodeBuild uses to pull images in your build. There are two valid\n values:

\n \n

When you use a cross-account or private registry image, you must use SERVICE_ROLE\n credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials.\n

" } } }, @@ -4284,7 +4258,7 @@ "location": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A string that specifies the location of the file system created by Amazon EFS. Its\n format is efs-dns-name:/directory-path. You can find the DNS name of file\n system when you view it in the AWS EFS console. The directory path is a path to a\n directory in the file system that CodeBuild mounts. For example, if the DNS name of a\n file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount\n directory is my-efs-mount-directory, then the location is\n fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.

\n

The directory path in the format efs-dns-name:/directory-path is\n optional. If you do not specify a directory path, the location is only the DNS name and\n CodeBuild mounts the entire file system.

" + "smithy.api#documentation": "

A string that specifies the location of the file system created by Amazon EFS. Its\n format is efs-dns-name:/directory-path. You can find the DNS name of file\n system when you view it in the Amazon EFS console. The directory path is a path to a\n directory in the file system that CodeBuild mounts. For example, if the DNS name of a\n file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount\n directory is my-efs-mount-directory, then the location is\n fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.

\n

The directory path in the format efs-dns-name:/directory-path is\n optional. If you do not specify a directory path, the location is only the DNS name and\n CodeBuild mounts the entire file system.

" } }, "mountPoint": { @@ -4302,7 +4276,7 @@ "mountOptions": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The mount options for a file system created by AWS EFS. The default mount options\n used by CodeBuild are\n nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For\n more information, see Recommended NFS Mount\n Options.

" + "smithy.api#documentation": "

The mount options for a file system created by Amazon EFS. The default mount options used\n by CodeBuild are\n nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For\n more information, see Recommended NFS Mount\n Options.

" } } }, @@ -4323,7 +4297,7 @@ "min": 2, "max": 255 }, - "smithy.api#pattern": "[A-Za-z0-9][A-Za-z0-9\\-_]{1,254}" + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9\\-_]{1,254}$" } }, "com.amazonaws.codebuild#ProjectNames": { @@ -4375,14 +4349,14 @@ "type": { "target": "com.amazonaws.codebuild#SourceType", "traits": { - "smithy.api#documentation": "

The type of repository that contains the source code to be built. Valid values\n include:

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

The type of repository that contains the source code to be built. Valid values\n include:

\n ", "smithy.api#required": {} } }, "location": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

Information about the location of the source code to be built. Valid values\n include:

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

Information about the location of the source code to be built. Valid values\n include:

\n \n

\n If you specify CODEPIPELINE for the Type property, don't specify this \n property. For all of the other types, you must specify Location.\n

" } }, "gitCloneDepth": { @@ -4400,19 +4374,19 @@ "buildspec": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The buildspec file declaration to use for the builds in this build project.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same AWS Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

" + "smithy.api#documentation": "

The buildspec file declaration to use for the builds in this build project.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

" } }, "auth": { "target": "com.amazonaws.codebuild#SourceAuth", "traits": { - "smithy.api#documentation": "

Information about the authorization settings for AWS CodeBuild to access the source code to be\n built.

\n

This information is for the AWS CodeBuild console's use only. Your code should not get or set\n this information directly.

" + "smithy.api#documentation": "

Information about the authorization settings for CodeBuild to access the source code to be\n built.

\n

This information is for the CodeBuild console's use only. Your code should not get or set\n this information directly.

" } }, "reportBuildStatus": { "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { - "smithy.api#documentation": "

Set to true to report the status of a build's start and finish to your source\n provider. This option is valid only when your source provider is GitHub, GitHub\n Enterprise, or Bitbucket. If this is set and you use a different source provider, an\n invalidInputException is thrown.

\n

To be able to report the build status to the source provider, the user associated with the source provider must\nhave write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the AWS CodeBuild User Guide.

\n \n

The status of a build triggered by a webhook is always reported to your source\n provider.

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

Set to true to report the status of a build's start and finish to your source\n provider. This option is valid only when your source provider is GitHub, GitHub\n Enterprise, or Bitbucket. If this is set and you use a different source provider, an\n invalidInputException is thrown.

\n

To be able to report the build status to the source provider, the user associated with the source provider must\nhave write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.

\n \n

The status of a build triggered by a webhook is always reported to your source\n provider.

\n " } }, "buildStatusConfig": { @@ -4451,7 +4425,7 @@ "sourceVersion": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The source version for the corresponding source identifier. If specified, must be one\n of:

\n \n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

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

The source version for the corresponding source identifier. If specified, must be one\n of:

\n \n

For more information, see Source Version Sample\n with CodeBuild in the CodeBuild User Guide.

", "smithy.api#required": {} } } @@ -4504,7 +4478,7 @@ "policy": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

A JSON-formatted resource policy. For more information, see Sharing\n a Project and Sharing a Report Group in the AWS CodeBuild User Guide.\n

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

A JSON-formatted resource policy. For more information, see Sharing\n a Project and Sharing a Report Group in the CodeBuild User Guide.\n

", "smithy.api#required": {} } }, @@ -4534,20 +4508,20 @@ "credential": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.

\n \n

The credential can use the name of the credentials only if they\n exist in your current AWS Region.

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

The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager.

\n \n

The credential can use the name of the credentials only if they\n exist in your current Region.

\n ", "smithy.api#required": {} } }, "credentialProvider": { "target": "com.amazonaws.codebuild#CredentialProviderType", "traits": { - "smithy.api#documentation": "

The service that created the credentials to access a private Docker registry. The\n valid value, SECRETS_MANAGER, is for AWS Secrets Manager.

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

The service that created the credentials to access a private Docker registry. The\n valid value, SECRETS_MANAGER, is for Secrets Manager.

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

Information about credentials that provide access to a private Docker registry. When\n this is set:

\n \n

For more information, see Private Registry with\n AWS Secrets Manager Sample for AWS CodeBuild.

" + "smithy.api#documentation": "

Information about credentials that provide access to a private Docker registry. When\n this is set:

\n \n

For more information, see Private Registry with\n Secrets Manager Sample for CodeBuild.

" } }, "com.amazonaws.codebuild#Report": { @@ -4748,7 +4722,7 @@ "tags": { "target": "com.amazonaws.codebuild#TagList", "traits": { - "smithy.api#documentation": "

A list of tag key and value pairs associated with this report group.

\n

These tags are available for use by AWS services that support AWS CodeBuild report group\n tags.

" + "smithy.api#documentation": "

A list of tag key and value pairs associated with this report group.

\n

These tags are available for use by Amazon Web Services services that support CodeBuild report group\n tags.

" } }, "status": { @@ -5042,7 +5016,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified AWS resource cannot be created, because an AWS resource with the same\n settings already exists.

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

The specified Amazon Web Services resource cannot be created, because an Amazon Web Services resource with the\n same settings already exists.

", "smithy.api#error": "client" } }, @@ -5054,7 +5028,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified AWS resource cannot be found.

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

The specified Amazon Web Services resource cannot be found.

", "smithy.api#error": "client" } }, @@ -5113,7 +5087,7 @@ "idempotencyToken": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A unique, case sensitive identifier you provide to ensure the idempotency of the\n RetryBuildBatch request. The token is included in the\n RetryBuildBatch request and is valid for five minutes. If you repeat\n the RetryBuildBatch request with the same token, but change a parameter,\n AWS CodeBuild returns a parameter mismatch error.

" + "smithy.api#documentation": "

A unique, case sensitive identifier you provide to ensure the idempotency of the\n RetryBuildBatch request. The token is included in the\n RetryBuildBatch request and is valid for five minutes. If you repeat\n the RetryBuildBatch request with the same token, but change a parameter,\n CodeBuild returns a parameter mismatch error.

" } }, "retryType": { @@ -5159,7 +5133,7 @@ "idempotencyToken": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A unique, case sensitive identifier you provide to ensure the idempotency of the\n RetryBuild request. The token is included in the\n RetryBuild request and is valid for five minutes. If you repeat\n the RetryBuild request with the same token, but change a parameter,\n AWS CodeBuild returns a parameter mismatch error.

" + "smithy.api#documentation": "

A unique, case sensitive identifier you provide to ensure the idempotency of the\n RetryBuild request. The token is included in the\n RetryBuild request and is valid for five minutes. If you repeat\n the RetryBuild request with the same token, but change a parameter,\n CodeBuild returns a parameter mismatch error.

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

Set to true if you do not want your S3 build log output encrypted. By default S3\n build logs are encrypted.

" } - }, - "bucketOwnerAccess": { - "target": "com.amazonaws.codebuild#BucketOwnerAccess" } }, "traits": { @@ -5214,7 +5185,7 @@ "bucketOwner": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The AWS account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket\n that is owned by an account other than the account running the build.

" + "smithy.api#documentation": "

The Amazon Web Services account identifier of the owner of the Amazon S3 bucket. This allows report data\n to be exported to an Amazon S3 bucket that is owned by an account other than the account\n running the build.

" } }, "path": { @@ -5226,7 +5197,7 @@ "packaging": { "target": "com.amazonaws.codebuild#ReportPackagingType", "traits": { - "smithy.api#documentation": "

The type of build output artifact to create. Valid values include:

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

The type of build output artifact to create. Valid values include:

\n " } }, "encryptionKey": { @@ -5334,7 +5305,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about the authorization settings for AWS CodeBuild to access the source code to be\n built.

\n

This information is for the AWS CodeBuild console's use only. Your code should not get or set\n this information directly.

" + "smithy.api#documentation": "

Information about the authorization settings for CodeBuild to access the source code\n to be built.

\n

This information is for the CodeBuild console's use only. Your code should not get or\n set this information directly.

" } }, "com.amazonaws.codebuild#SourceAuthType": { @@ -5483,7 +5454,7 @@ "sourceVersion": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The version of the batch build input to be built, for this build only. If not specified,\n the latest version is used. If specified, the contents depends on the source\n provider:

\n
\n
AWS CodeCommit
\n
\n

The commit ID, branch, or Git tag to use.

\n
\n
GitHub
\n
\n

The commit ID, pull request ID, branch name, or tag name that corresponds\n to the version of the source code you want to build. If a pull request ID is\n specified, it must use the format pr/pull-request-ID (for\n example pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit\n ID is used.

\n
\n
Bitbucket
\n
\n

The commit ID, branch name, or tag name that corresponds to the version of\n the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

\n
\n
Amazon S3
\n
\n

The version ID of the object that represents the build input ZIP file to\n use.

\n
\n
\n

If sourceVersion is specified at the project level, then this\n sourceVersion (at the build level) takes precedence.

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

" + "smithy.api#documentation": "

The version of the batch build input to be built, for this build only. If not specified,\n the latest version is used. If specified, the contents depends on the source\n provider:

\n
\n
CodeCommit
\n
\n

The commit ID, branch, or Git tag to use.

\n
\n
GitHub
\n
\n

The commit ID, pull request ID, branch name, or tag name that corresponds\n to the version of the source code you want to build. If a pull request ID is\n specified, it must use the format pr/pull-request-ID (for\n example pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit\n ID is used.

\n
\n
Bitbucket
\n
\n

The commit ID, branch name, or tag name that corresponds to the version of\n the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

\n
\n
Amazon S3
\n
\n

The version ID of the object that represents the build input ZIP file to\n use.

\n
\n
\n

If sourceVersion is specified at the project level, then this\n sourceVersion (at the build level) takes precedence.

\n

For more information, see Source Version Sample\n with CodeBuild in the CodeBuild User Guide.

" } }, "artifactsOverride": { @@ -5537,7 +5508,7 @@ "buildspecOverride": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A buildspec file declaration that overrides, for this build only, the latest one\n already defined in the build project.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same AWS Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

" + "smithy.api#documentation": "

A buildspec file declaration that overrides, for this build only, the latest one\n already defined in the build project.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

" } }, "insecureSslOverride": { @@ -5609,13 +5580,13 @@ "encryptionKeyOverride": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the batch build\n project. The CMK key encrypts the build output artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" + "smithy.api#documentation": "

The Key Management Service customer master key (CMK) that overrides the one specified in the batch build\n project. The CMK key encrypts the build output artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

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

A unique, case sensitive identifier you provide to ensure the idempotency of the\n StartBuildBatch request. The token is included in the\n StartBuildBatch request and is valid for five minutes. If you repeat\n the StartBuildBatch request with the same token, but change a parameter,\n AWS CodeBuild returns a parameter mismatch error.

" + "smithy.api#documentation": "

A unique, case sensitive identifier you provide to ensure the idempotency of the\n StartBuildBatch request. The token is included in the\n StartBuildBatch request and is valid for five minutes. If you repeat\n the StartBuildBatch request with the same token, but change a parameter,\n CodeBuild returns a parameter mismatch error.

" } }, "logsConfigOverride": { @@ -5633,7 +5604,7 @@ "imagePullCredentialsTypeOverride": { "target": "com.amazonaws.codebuild#ImagePullCredentialsType", "traits": { - "smithy.api#documentation": "

The type of credentials AWS CodeBuild uses to pull images in your batch build. There are two valid\n values:

\n
\n
CODEBUILD
\n
\n

Specifies that AWS CodeBuild uses its own credentials. This requires that you\n modify your ECR repository policy to trust AWS CodeBuild's service principal.

\n
\n
SERVICE_ROLE
\n
\n

Specifies that AWS CodeBuild uses your build project's service role.

\n
\n
\n

When using a cross-account or private registry image, you must use\n SERVICE_ROLE credentials. When using an AWS CodeBuild curated image,\n you must use CODEBUILD credentials.

" + "smithy.api#documentation": "

The type of credentials CodeBuild uses to pull images in your batch build. There are two valid\n values:

\n
\n
CODEBUILD
\n
\n

Specifies that CodeBuild uses its own credentials. This requires that you\n modify your ECR repository policy to trust CodeBuild's service principal.

\n
\n
SERVICE_ROLE
\n
\n

Specifies that CodeBuild uses your build project's service role.

\n
\n
\n

When using a cross-account or private registry image, you must use\n SERVICE_ROLE credentials. When using an CodeBuild curated image,\n you must use CODEBUILD credentials.

" } }, "buildBatchConfigOverride": { @@ -5667,7 +5638,7 @@ "projectName": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the AWS CodeBuild build project to start running a build.

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

The name of the CodeBuild build project to start running a build.

", "smithy.api#required": {} } }, @@ -5686,7 +5657,7 @@ "sourceVersion": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The version of the build input to be built, for this build only. If not specified,\n the latest version is used. If specified, the contents depends on the source\n provider:

\n
\n
AWS CodeCommit
\n
\n

The commit ID, branch, or Git tag to use.

\n
\n
GitHub
\n
\n

The commit ID, pull request ID, branch name, or tag name that corresponds\n to the version of the source code you want to build. If a pull request ID is\n specified, it must use the format pr/pull-request-ID (for\n example pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit\n ID is used.

\n
\n
Bitbucket
\n
\n

The commit ID, branch name, or tag name that corresponds to the version of\n the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

\n
\n
Amazon S3
\n
\n

The version ID of the object that represents the build input ZIP file to\n use.

\n
\n
\n

If sourceVersion is specified at the project level, then this\n sourceVersion (at the build level) takes precedence.

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

" + "smithy.api#documentation": "

The version of the build input to be built, for this build only. If not specified,\n the latest version is used. If specified, the contents depends on the source\n provider:

\n
\n
CodeCommit
\n
\n

The commit ID, branch, or Git tag to use.

\n
\n
GitHub
\n
\n

The commit ID, pull request ID, branch name, or tag name that corresponds\n to the version of the source code you want to build. If a pull request ID is\n specified, it must use the format pr/pull-request-ID (for\n example pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit\n ID is used.

\n
\n
Bitbucket
\n
\n

The commit ID, branch name, or tag name that corresponds to the version of\n the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

\n
\n
Amazon S3
\n
\n

The version ID of the object that represents the build input ZIP file to\n use.

\n
\n
\n

If sourceVersion is specified at the project level, then this\n sourceVersion (at the build level) takes precedence.

\n

For more information, see Source Version Sample\n with CodeBuild in the CodeBuild User Guide.

" } }, "artifactsOverride": { @@ -5734,13 +5705,13 @@ "gitSubmodulesConfigOverride": { "target": "com.amazonaws.codebuild#GitSubmodulesConfig", "traits": { - "smithy.api#documentation": "

Information about the Git submodules configuration for this build of an AWS CodeBuild build\n project.

" + "smithy.api#documentation": "

Information about the Git submodules configuration for this build of an CodeBuild build\n project.

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

A buildspec file declaration that overrides, for this build only, the latest one\n already defined in the build project.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same AWS Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

" + "smithy.api#documentation": "

A buildspec file declaration that overrides, for this build only, the latest one\n already defined in the build project.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

" } }, "insecureSslOverride": { @@ -5752,7 +5723,7 @@ "reportBuildStatusOverride": { "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { - "smithy.api#documentation": "

Set to true to report to your source provider the status of a build's start and\n completion. If you use this option with a source provider other than GitHub, GitHub\n Enterprise, or Bitbucket, an invalidInputException is thrown.

\n

To be able to report the build status to the source provider, the user associated with the source provider must\nhave write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the AWS CodeBuild User Guide.

\n \n

The status of a build triggered by a webhook is always reported to your source\n provider.

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

Set to true to report to your source provider the status of a build's start and\n completion. If you use this option with a source provider other than GitHub, GitHub\n Enterprise, or Bitbucket, an invalidInputException is thrown.

\n

To be able to report the build status to the source provider, the user associated with the source provider must\nhave write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.

\n \n

The status of a build triggered by a webhook is always reported to your source\n provider.

\n " } }, "buildStatusConfigOverride": { @@ -5818,13 +5789,13 @@ "encryptionKeyOverride": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the build\n project. The CMK key encrypts the build output artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" + "smithy.api#documentation": "

The Key Management Service customer master key (CMK) that overrides the one specified in the build\n project. The CMK key encrypts the build output artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

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

A unique, case sensitive identifier you provide to ensure the idempotency of the\n StartBuild request. The token is included in the StartBuild request and is valid for 5\n minutes. If you repeat the StartBuild request with the same token, but change a\n parameter, AWS CodeBuild returns a parameter mismatch error.

" + "smithy.api#documentation": "

A unique, case sensitive identifier you provide to ensure the idempotency of the\n StartBuild request. The token is included in the StartBuild request and is valid for 5\n minutes. If you repeat the StartBuild request with the same token, but change a\n parameter, CodeBuild returns a parameter mismatch error.

" } }, "logsConfigOverride": { @@ -5842,7 +5813,7 @@ "imagePullCredentialsTypeOverride": { "target": "com.amazonaws.codebuild#ImagePullCredentialsType", "traits": { - "smithy.api#documentation": "

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid\n values:

\n
\n
CODEBUILD
\n
\n

Specifies that AWS CodeBuild uses its own credentials. This requires that you\n modify your ECR repository policy to trust AWS CodeBuild's service principal.

\n
\n
SERVICE_ROLE
\n
\n

Specifies that AWS CodeBuild uses your build project's service role.

\n
\n
\n

When using a cross-account or private registry image, you must use\n SERVICE_ROLE credentials. When using an AWS CodeBuild curated image,\n you must use CODEBUILD credentials.

" + "smithy.api#documentation": "

The type of credentials CodeBuild uses to pull images in your build. There are two valid\n values:

\n
\n
CODEBUILD
\n
\n

Specifies that CodeBuild uses its own credentials. This requires that you\n modify your ECR repository policy to trust CodeBuild's service principal.

\n
\n
SERVICE_ROLE
\n
\n

Specifies that CodeBuild uses your build project's service role.

\n
\n
\n

When using a cross-account or private registry image, you must use\n SERVICE_ROLE credentials. When using an CodeBuild curated image,\n you must use CODEBUILD credentials.

" } }, "debugSessionEnabled": { @@ -6010,7 +5981,7 @@ } }, "traits": { - "smithy.api#documentation": "

A tag, consisting of a key and a value.

\n

This tag is available for use by AWS services that support tags in AWS CodeBuild.

" + "smithy.api#documentation": "

A tag, consisting of a key and a value.

\n

This tag is available for use by Amazon Web Services services that support tags in CodeBuild.

" } }, "com.amazonaws.codebuild#TagList": { @@ -6200,7 +6171,7 @@ "sourceVersion": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A version of the build input to be built for this project. If not specified, the\n latest version is used. If specified, it must be one of:

\n \n

If sourceVersion is specified at the build level, then that version\n takes precedence over this sourceVersion (at the project level).

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide. \n

" + "smithy.api#documentation": "

A version of the build input to be built for this project. If not specified, the\n latest version is used. If specified, it must be one of:

\n \n

If sourceVersion is specified at the build level, then that version\n takes precedence over this sourceVersion (at the project level).

\n

For more information, see Source Version Sample\n with CodeBuild in the CodeBuild User Guide. \n

" } }, "secondarySourceVersions": { @@ -6236,13 +6207,13 @@ "serviceRole": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent\n AWS services on behalf of the AWS account.

" + "smithy.api#documentation": "

The replacement ARN of the Identity and Access Management role that enables CodeBuild to interact with dependent\n Amazon Web Services services on behalf of the Amazon Web Services account.

" } }, "timeoutInMinutes": { "target": "com.amazonaws.codebuild#TimeOut", "traits": { - "smithy.api#documentation": "

The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before\n timing out any related build that did not get marked as completed.

" + "smithy.api#documentation": "

The replacement value in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before\n timing out any related build that did not get marked as completed.

" } }, "queuedTimeoutInMinutes": { @@ -6254,19 +6225,19 @@ "encryptionKey": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).\n

" + "smithy.api#documentation": "

The Key Management Service customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).\n

" } }, "tags": { "target": "com.amazonaws.codebuild#TagList", "traits": { - "smithy.api#documentation": "

An updated list of tag key and value pairs associated with this build project.

\n

These tags are available for use by AWS services that support AWS CodeBuild build project\n tags.

" + "smithy.api#documentation": "

An updated list of tag key and value pairs associated with this build project.

\n

These tags are available for use by Amazon Web Services services that support CodeBuild build project\n tags.

" } }, "vpcConfig": { "target": "com.amazonaws.codebuild#VpcConfig", "traits": { - "smithy.api#documentation": "

VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.

" + "smithy.api#documentation": "

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

" } }, "badgeEnabled": { @@ -6278,7 +6249,7 @@ "logsConfig": { "target": "com.amazonaws.codebuild#LogsConfig", "traits": { - "smithy.api#documentation": "

Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs,\n logs in an S3 bucket, or both.

" + "smithy.api#documentation": "

Information about logs for the build project. A project can create logs in CloudWatch Logs,\n logs in an S3 bucket, or both.

" } }, "fileSystemLocations": { @@ -6348,7 +6319,7 @@ "tags": { "target": "com.amazonaws.codebuild#TagList", "traits": { - "smithy.api#documentation": "

\n An updated list of tag key and value pairs associated with this report group.\n

\n

These tags are available for use by AWS services that support AWS CodeBuild report group\n tags.

" + "smithy.api#documentation": "

\n An updated list of tag key and value pairs associated with this report group.\n

\n

These tags are available for use by Amazon Web Services services that support CodeBuild report group\n tags.

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

Updates the webhook associated with an AWS CodeBuild build project.

\n \n

If you use Bitbucket for your repository, rotateSecret is ignored.\n

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

Updates the webhook associated with an CodeBuild build project.

\n \n

If you use Bitbucket for your repository, rotateSecret is ignored.\n

\n " } }, "com.amazonaws.codebuild#UpdateWebhookInput": { @@ -6393,7 +6364,7 @@ "projectName": { "target": "com.amazonaws.codebuild#ProjectName", "traits": { - "smithy.api#documentation": "

The name of the AWS CodeBuild project.

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

The name of the CodeBuild project.

", "smithy.api#required": {} } }, @@ -6429,7 +6400,7 @@ "webhook": { "target": "com.amazonaws.codebuild#Webhook", "traits": { - "smithy.api#documentation": "

Information about a repository's webhook that is associated with a project in AWS CodeBuild.\n

" + "smithy.api#documentation": "

Information about a repository's webhook that is associated with a project in CodeBuild.\n

" } } } @@ -6467,7 +6438,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about the VPC configuration that AWS CodeBuild accesses.

" + "smithy.api#documentation": "

Information about the VPC configuration that CodeBuild accesses.

" } }, "com.amazonaws.codebuild#Webhook": { @@ -6482,7 +6453,7 @@ "payloadUrl": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AWS CodeBuild endpoint where webhook events are sent.

" + "smithy.api#documentation": "

The CodeBuild endpoint where webhook events are sent.

" } }, "secret": { @@ -6517,7 +6488,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about a webhook that connects repository events to a build project in\n AWS CodeBuild.

" + "smithy.api#documentation": "

Information about a webhook that connects repository events to a build project in\n CodeBuild.

" } }, "com.amazonaws.codebuild#WebhookBuildType": { @@ -6541,7 +6512,7 @@ "type": { "target": "com.amazonaws.codebuild#WebhookFilterType", "traits": { - "smithy.api#documentation": "

The type of webhook filter. There are six webhook filter types: EVENT,\n ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF,\n FILE_PATH, and COMMIT_MESSAGE.

\n
\n
\n EVENT\n
\n
\n

A webhook event triggers a build when the provided pattern\n matches one of five event types: PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED,\n PULL_REQUEST_REOPENED, and\n PULL_REQUEST_MERGED. The EVENT patterns are\n specified as a comma-separated string. For example, PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull\n request created, and pull request updated events.

\n \n

The PULL_REQUEST_REOPENED works with GitHub and GitHub\n Enterprise only.

\n \n
\n
\n ACTOR_ACCOUNT_ID\n
\n
\n

A webhook event triggers a build when a GitHub, GitHub Enterprise, or\n Bitbucket account ID matches the regular expression pattern.\n

\n
\n
\n HEAD_REF\n
\n
\n

A webhook event triggers a build when the head reference matches the\n regular expression pattern. For example,\n refs/heads/branch-name and refs/tags/tag-name.

\n

Works with GitHub and GitHub Enterprise push, GitHub and GitHub\n Enterprise pull request, Bitbucket push, and Bitbucket pull request events.\n

\n
\n
\n BASE_REF\n
\n
\n

A webhook event triggers a build when the base reference matches the\n regular expression pattern. For example,\n refs/heads/branch-name.

\n \n

Works with pull request events only.

\n \n
\n
\n FILE_PATH\n
\n
\n

A webhook triggers a build when the path of a changed file matches the\n regular expression pattern.

\n \n

Works with GitHub and Bitbucket events push and pull requests events.\n Also works with GitHub Enterprise push events, but does not work with\n GitHub Enterprise pull request events.

\n \n
\n
COMMIT_MESSAGE
\n
\n

A webhook triggers a build when the head commit message matches the\n regular expression pattern.

\n \n

Works with GitHub and Bitbucket events push and pull requests events.\n Also works with GitHub Enterprise push events, but does not work with\n GitHub Enterprise pull request events.

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

The type of webhook filter. There are six webhook filter types: EVENT,\n ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF,\n FILE_PATH, and COMMIT_MESSAGE.

\n
\n
EVENT
\n
\n

A webhook event triggers a build when the provided pattern\n matches one of five event types: PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED,\n PULL_REQUEST_REOPENED, and\n PULL_REQUEST_MERGED. The EVENT patterns are\n specified as a comma-separated string. For example, PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull\n request created, and pull request updated events.

\n \n

The PULL_REQUEST_REOPENED works with GitHub and GitHub\n Enterprise only.

\n \n
\n
ACTOR_ACCOUNT_ID
\n
\n

A webhook event triggers a build when a GitHub, GitHub Enterprise, or\n Bitbucket account ID matches the regular expression pattern.\n

\n
\n
HEAD_REF
\n
\n

A webhook event triggers a build when the head reference matches the\n regular expression pattern. For example,\n refs/heads/branch-name and refs/tags/tag-name.

\n

Works with GitHub and GitHub Enterprise push, GitHub and GitHub\n Enterprise pull request, Bitbucket push, and Bitbucket pull request events.\n

\n
\n
BASE_REF
\n
\n

A webhook event triggers a build when the base reference matches the\n regular expression pattern. For example,\n refs/heads/branch-name.

\n \n

Works with pull request events only.

\n \n
\n
FILE_PATH
\n
\n

A webhook triggers a build when the path of a changed file matches the\n regular expression pattern.

\n \n

Works with GitHub and Bitbucket events push and pull requests events.\n Also works with GitHub Enterprise push events, but does not work with\n GitHub Enterprise pull request events.

\n \n
\n
COMMIT_MESSAGE
\n
\n

A webhook triggers a build when the head commit message matches the\n regular expression pattern.

\n \n

Works with GitHub and Bitbucket events push and pull requests events.\n Also works with GitHub Enterprise push events, but does not work with\n GitHub Enterprise pull request events.

\n \n
\n
", "smithy.api#required": {} } }, diff --git a/aws/sdk/aws-models/codeguru-reviewer.json b/aws/sdk/aws-models/codeguru-reviewer.json index 9b65b91e4..611e59a82 100644 --- a/aws/sdk/aws-models/codeguru-reviewer.json +++ b/aws/sdk/aws-models/codeguru-reviewer.json @@ -88,7 +88,7 @@ "name": "codeguru-reviewer" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a service\n that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommendations to \n address them in your Java and Python code.

\n \n

By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer\n improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the \n \n Amazon CodeGuru Reviewer User Guide.\n

\n \n

\n To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection between your VPC and CodeGuru Reviewer by \n creating an interface VPC endpoint. For more information, see \n CodeGuru Reviewer and interface \n VPC endpoints (AWS PrivateLink) in the Amazon CodeGuru Reviewer User Guide.\n

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

This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a service\n that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommends\n fixes in your Java and Python code.

\n \n

By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer\n improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the \n \n Amazon CodeGuru Reviewer User Guide.\n

\n \n

\n To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection between your VPC and CodeGuru Reviewer by \n creating an interface VPC endpoint. For more information, see \n CodeGuru Reviewer and interface \n VPC endpoints (AWS PrivateLink) in the Amazon CodeGuru Reviewer User Guide.\n

", "smithy.api#title": "Amazon CodeGuru Reviewer" } }, @@ -105,6 +105,27 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.codegurureviewer#AnalysisType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Security", + "name": "SECURITY" + }, + { + "value": "CodeQuality", + "name": "CODE_QUALITY" + } + ] + } + }, + "com.amazonaws.codegurureviewer#AnalysisTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurureviewer#AnalysisType" + } + }, "com.amazonaws.codegurureviewer#Arn": { "type": "string", "traits": { @@ -141,7 +162,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Use to associate an AWS CodeCommit repository or a repostory managed by \n AWS CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a \n repository, CodeGuru Reviewer reviews source code changes in the repository's pull requests and provides \n automatic recommendations. You can view recommendations using the CodeGuru Reviewer console. For more information, see \n Recommendations in \n Amazon CodeGuru Reviewer in the Amazon CodeGuru Reviewer User Guide. \n

\n \n

If you associate a CodeCommit repository, it must be in the same \n AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.

\n \n

Bitbucket and GitHub Enterprise Server repositories are managed by AWS CodeStar\n Connections to connect to CodeGuru Reviewer. For more information, see Associate a repository in\n the Amazon CodeGuru Reviewer User Guide.\n

\n \n \n

\n You cannot use the CodeGuru Reviewer SDK or the AWS CLI to associate a GitHub repository with Amazon CodeGuru Reviewer. To associate \n a GitHub repository, use the console. For more information, see \n Getting \n started with CodeGuru Reviewer in the CodeGuru Reviewer User Guide.\n

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

\n Use to associate an AWS CodeCommit repository or a repostory managed by \n AWS CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a \n repository, CodeGuru Reviewer reviews source code changes in the repository's pull requests and provides \n automatic recommendations. You can view recommendations using the CodeGuru Reviewer console. For more information, see \n Recommendations in \n Amazon CodeGuru Reviewer in the Amazon CodeGuru Reviewer User Guide. \n

\n \n

If you associate a CodeCommit or S3 repository, it must be in the same \n AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.

\n \n

Bitbucket and GitHub Enterprise Server repositories are managed by AWS CodeStar\n Connections to connect to CodeGuru Reviewer. For more information, see Associate a repository in\n the Amazon CodeGuru Reviewer User Guide.\n

\n \n \n

\n You cannot use the CodeGuru Reviewer SDK or the AWS CLI to associate a GitHub repository with Amazon CodeGuru Reviewer. To associate \n a GitHub repository, use the console. For more information, see \n Getting \n started with CodeGuru Reviewer in the CodeGuru Reviewer User Guide.\n

\n ", "smithy.api#http": { "method": "POST", "uri": "/associations", @@ -216,6 +237,28 @@ } } }, + "com.amazonaws.codegurureviewer#BranchDiffSourceCodeType": { + "type": "structure", + "members": { + "SourceBranchName": { + "target": "com.amazonaws.codegurureviewer#BranchName", + "traits": { + "smithy.api#documentation": "

The source branch for a diff in an associated repository.

", + "smithy.api#required": {} + } + }, + "DestinationBranchName": { + "target": "com.amazonaws.codegurureviewer#BranchName", + "traits": { + "smithy.api#documentation": "

The destination branch for a diff in an associated repository.

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

\n A type of \n SourceCodeType\n that \n specifies a code diff between a source and destination branch in an associated repository.\n

" + } + }, "com.amazonaws.codegurureviewer#BranchName": { "type": "string", "traits": { @@ -225,6 +268,16 @@ } } }, + "com.amazonaws.codegurureviewer#BuildArtifactsObjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^\\S(.*\\S)?$" + } + }, "com.amazonaws.codegurureviewer#ClientRequestToken": { "type": "string", "traits": { @@ -235,6 +288,27 @@ "smithy.api#pattern": "^[\\w-]+$" } }, + "com.amazonaws.codegurureviewer#CodeArtifacts": { + "type": "structure", + "members": { + "SourceCodeArtifactsObjectKey": { + "target": "com.amazonaws.codegurureviewer#SourceCodeArtifactsObjectKey", + "traits": { + "smithy.api#documentation": "

The S3 object key for a source code .zip file. This is required for all code reviews.

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

The S3 object key for a build artifacts .zip file that \n contains .jar or .class files. This is required for a code review with security analysis. For more \n information, see Create code reviews with security \n analysis in the Amazon CodeGuru Reviewer User Guide.

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

Code artifacts are source code artifacts and build artifacts used in a repository analysis or a pull request review.

\n " + } + }, "com.amazonaws.codegurureviewer#CodeCommitRepository": { "type": "structure", "members": { @@ -247,7 +321,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about an AWS CodeCommit repository. The CodeCommit repository must be in the same \n AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.

" + "smithy.api#documentation": "

Information about an AWS CodeCommit repository. The CodeCommit repository must be in the same \n AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.

" } }, "com.amazonaws.codegurureviewer#CodeReview": { @@ -274,7 +348,7 @@ "Owner": { "target": "com.amazonaws.codegurureviewer#Owner", "traits": { - "smithy.api#documentation": "

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the \n account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.

" + "smithy.api#documentation": "

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the \n account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.\n For an S3 repository, it can be the username or AWS account ID.

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

\n The statistics from the code review.\n

" } + }, + "AnalysisTypes": { + "target": "com.amazonaws.codegurureviewer#AnalysisTypes", + "traits": { + "smithy.api#documentation": "

They types of analysis performed during a repository analysis or a pull request review. You can specify either \n Security, CodeQuality, or both.

" + } } }, "traits": { @@ -349,7 +429,7 @@ "min": 1, "max": 100 }, - "smithy.api#pattern": "[a-zA-Z0-9-_]*" + "smithy.api#pattern": "^[a-zA-Z0-9-_]*$" } }, "com.amazonaws.codegurureviewer#CodeReviewSummaries": { @@ -382,7 +462,7 @@ "Owner": { "target": "com.amazonaws.codegurureviewer#Owner", "traits": { - "smithy.api#documentation": "

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the \n account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.

" + "smithy.api#documentation": "

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the \n account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.\n For an S3 repository, it can be the username or AWS account ID.

" } }, "ProviderType": { @@ -426,6 +506,9 @@ "traits": { "smithy.api#documentation": "

\n The statistics from the code review.\n

" } + }, + "SourceCodeType": { + "target": "com.amazonaws.codegurureviewer#SourceCodeType" } }, "traits": { @@ -441,10 +524,16 @@ "smithy.api#documentation": "

A code review that analyzes all code under a specified branch in an associated\n\t\t\trepository. The associated repository is specified using its ARN in \n CreateCodeReview\n .

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

They types of analysis performed during a repository analysis or a pull request review. You can specify either \n Security, CodeQuality, or both.

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

\n The type of a code review. There are two code review types: \n

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

\n The type of a code review. There are two code review types: \n

\n " } }, "com.amazonaws.codegurureviewer#CommitDiffSourceCodeType": { @@ -453,18 +542,24 @@ "SourceCommit": { "target": "com.amazonaws.codegurureviewer#CommitId", "traits": { - "smithy.api#documentation": "

\n The SHA of the source commit used to generate a commit diff.\n

" + "smithy.api#documentation": "

\n The SHA of the source commit used to generate a commit diff. This field is required for a pull request code review.\n

" } }, "DestinationCommit": { "target": "com.amazonaws.codegurureviewer#CommitId", "traits": { - "smithy.api#documentation": "

\n The SHA of the destination commit used to generate a commit diff.\n

" + "smithy.api#documentation": "

\n The SHA of the destination commit used to generate a commit diff. This field is required for a pull request code review.\n

" + } + }, + "MergeBaseCommit": { + "target": "com.amazonaws.codegurureviewer#CommitId", + "traits": { + "smithy.api#documentation": "

The SHA of the merge base of a commit.

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

\n A type of \n SourceCodeType\n that \n specifies the commit diff for a pull request on an associated repository.\n

" + "smithy.api#documentation": "

\n A type of \n SourceCodeType\n that \n specifies the commit diff for a pull request on an associated repository. The SourceCommit \n and DestinationCommit fields are required to do a pull request code review.\n

" } }, "com.amazonaws.codegurureviewer#CommitId": { @@ -496,7 +591,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+" + "smithy.api#pattern": "^arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+$" } }, "com.amazonaws.codegurureviewer#CreateCodeReview": { @@ -528,7 +623,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Use to create a code review with a \n CodeReviewType\n \n of RepositoryAnalysis. This type of code review analyzes all code under a specified branch in an associated repository. \n PullRequest code reviews are automatically triggered by a pull request so cannot be created using this method.\n

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

\n Use to create a code review with a \n CodeReviewType\n \n of RepositoryAnalysis. This type of code review analyzes all code under a specified branch in an associated repository. \n PullRequest code reviews are automatically triggered by a pull request.\n

", "smithy.api#http": { "method": "POST", "uri": "/codereviews", @@ -608,6 +703,34 @@ "method": "GET", "uri": "/codereviews/{CodeReviewArn}", "code": 200 + }, + "smithy.waiters#waitable": { + "CodeReviewCompleted": { + "documentation": "Wait until a code review is complete.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "CodeReview.State", + "expected": "Completed", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "CodeReview.State", + "expected": "Pending", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 10 + } } } }, @@ -739,6 +862,34 @@ "method": "GET", "uri": "/associations/{AssociationArn}", "code": 200 + }, + "smithy.waiters#waitable": { + "RepositoryAssociationSucceeded": { + "documentation": "Wait until a repository association is complete.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "RepositoryAssociation.State", + "expected": "Associated", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "RepositoryAssociation.State", + "expected": "Associating", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 10 + } } } }, @@ -857,6 +1008,46 @@ "com.amazonaws.codegurureviewer#ErrorMessage": { "type": "string" }, + "com.amazonaws.codegurureviewer#EventInfo": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.codegurureviewer#EventName", + "traits": { + "smithy.api#documentation": "

The name of the event. The possible names are pull_request, workflow_dispatch, \n schedule, and push\n

" + } + }, + "State": { + "target": "com.amazonaws.codegurureviewer#EventState", + "traits": { + "smithy.api#documentation": "

The state of an event. The state might be open, closed, or another state.

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

Information about an event. The event might be a push, pull request, scheduled request, or another type of event.

" + } + }, + "com.amazonaws.codegurureviewer#EventName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[ \\-A-Z_a-z]+$" + } + }, + "com.amazonaws.codegurureviewer#EventState": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[ \\-A-Z_a-z]+$" + } + }, "com.amazonaws.codegurureviewer#FilePath": { "type": "string", "traits": { @@ -947,7 +1138,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "[a-zA-Z0-9-]+" + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" } }, "com.amazonaws.codegurureviewer#LineNumber": { @@ -1537,6 +1728,10 @@ { "value": "GitHubEnterpriseServer", "name": "GIT_HUB_ENTERPRISE_SERVER" + }, + { + "value": "S3Bucket", + "name": "S3_BUCKET" } ] } @@ -1653,6 +1848,53 @@ } } }, + "com.amazonaws.codegurureviewer#RecommendationCategory": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWSBestPractices", + "name": "AWS_BEST_PRACTICES" + }, + { + "value": "AWSCloudFormationIssues", + "name": "AWS_CLOUDFORMATION_ISSUES" + }, + { + "value": "DuplicateCode", + "name": "DUPLICATE_CODE" + }, + { + "value": "CodeMaintenanceIssues", + "name": "CODE_MAINTENANCE_ISSUES" + }, + { + "value": "ConcurrencyIssues", + "name": "CONCURRENCY_ISSUES" + }, + { + "value": "InputValidations", + "name": "INPUT_VALIDATIONS" + }, + { + "value": "PythonBestPractices", + "name": "PYTHON_BEST_PRACTICES" + }, + { + "value": "JavaBestPractices", + "name": "JAVA_BEST_PRACTICES" + }, + { + "value": "ResourceLeaks", + "name": "RESOURCE_LEAKS" + }, + { + "value": "SecurityIssues", + "name": "SECURITY_ISSUES" + } + ] + } + }, "com.amazonaws.codegurureviewer#RecommendationFeedback": { "type": "structure", "members": { @@ -1788,6 +2030,12 @@ "traits": { "smithy.api#documentation": "

\n A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.\n

" } + }, + "RecommendationCategory": { + "target": "com.amazonaws.codegurureviewer#RecommendationCategory", + "traits": { + "smithy.api#documentation": "

The type of a recommendation.

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

\n Information about a GitHub Enterprise Server repository.\n

" } + }, + "S3Bucket": { + "target": "com.amazonaws.codegurureviewer#S3Repository" } }, "traits": { @@ -1826,9 +2077,11 @@ "RepositoryHead": { "target": "com.amazonaws.codegurureviewer#RepositoryHeadSourceCodeType", "traits": { - "smithy.api#documentation": "

\n A \n SourceCodeType\n that \n specifies the tip of a branch in an associated repository. \n

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

\n A \n SourceCodeType\n that \n specifies the tip of a branch in an associated repository. \n

" } + }, + "SourceCodeType": { + "target": "com.amazonaws.codegurureviewer#SourceCodeType" } }, "traits": { @@ -1865,7 +2118,7 @@ "Owner": { "target": "com.amazonaws.codegurureviewer#Owner", "traits": { - "smithy.api#documentation": "

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the \n account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.

" + "smithy.api#documentation": "

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the \n account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.\n For an S3 repository, it can be the username or AWS account ID.

" } }, "ProviderType": { @@ -1903,6 +2156,9 @@ "traits": { "smithy.api#documentation": "

A KMSKeyDetails object that contains:

\n " } + }, + "S3RepositoryDetails": { + "target": "com.amazonaws.codegurureviewer#S3RepositoryDetails" } }, "traits": { @@ -1990,7 +2246,7 @@ "Owner": { "target": "com.amazonaws.codegurureviewer#Owner", "traits": { - "smithy.api#documentation": "

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the \n account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.

" + "smithy.api#documentation": "

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the \n account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.\n For an S3 repository, it can be the username or AWS account ID.

" } }, "ProviderType": { @@ -2037,6 +2293,57 @@ } } }, + "com.amazonaws.codegurureviewer#RequestId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.codegurureviewer#RequestMetadata": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.codegurureviewer#RequestId", + "traits": { + "smithy.api#documentation": "

The ID of the request. This is required for a pull request code review.

" + } + }, + "Requester": { + "target": "com.amazonaws.codegurureviewer#Requester", + "traits": { + "smithy.api#documentation": "

An identifier, such as a name or account ID, that is associated with the requester. The \n Requester is used to capture the author/actor name of the event request.

" + } + }, + "EventInfo": { + "target": "com.amazonaws.codegurureviewer#EventInfo", + "traits": { + "smithy.api#documentation": "

Information about the event associated with a code review.

" + } + }, + "VendorName": { + "target": "com.amazonaws.codegurureviewer#VendorName", + "traits": { + "smithy.api#documentation": "

The name of the repository vendor used to upload code to an S3 bucket for a CI/CD code\n review. For example, if code and artifacts are uploaded to an S3 bucket for a CI/CD code\n review by GitHub scripts from a GitHub repository, then the repository association's ProviderType is\n S3Bucket and the CI/CD repository vendor name is GitHub. For more\n information, see the definition for ProviderType in RepositoryAssociation.

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

Metadata that is associated with a code review. This applies to both pull request \n and repository analysis code reviews.

" + } + }, + "com.amazonaws.codegurureviewer#Requester": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^\\S(.*\\S)?$" + } + }, "com.amazonaws.codegurureviewer#ResourceNotFoundException": { "type": "structure", "members": { @@ -2050,6 +2357,89 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.codegurureviewer#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^\\S(.*\\S)?$" + } + }, + "com.amazonaws.codegurureviewer#S3BucketRepository": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.codegurureviewer#Name", + "traits": { + "smithy.api#documentation": "

\n The name of the repository when the ProviderType is S3Bucket.\n

", + "smithy.api#required": {} + } + }, + "Details": { + "target": "com.amazonaws.codegurureviewer#S3RepositoryDetails", + "traits": { + "smithy.api#documentation": "

\n\t\t\tAn S3RepositoryDetails object that specifies the name of an S3 bucket and \n\t\t\ta CodeArtifacts object. The CodeArtifacts object includes the S3 \n\t\t\tobject keys for a source code .zip file and for a build artifacts .zip file.\n\t\t

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

\n Information about an associated repository in an S3 bucket. The associated repository contains a source code \n .zip file and a build artifacts .zip file that contains .jar or .class files.\n

" + } + }, + "com.amazonaws.codegurureviewer#S3Repository": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.codegurureviewer#Name", + "traits": { + "smithy.api#documentation": "

The name of the repository in the S3 bucket.

", + "smithy.api#required": {} + } + }, + "BucketName": { + "target": "com.amazonaws.codegurureviewer#S3BucketName", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket used for associating a new S3 repository. It must begin with \n codeguru-reviewer-.

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

\n Information about a repository in an S3 bucket. \n

" + } + }, + "com.amazonaws.codegurureviewer#S3RepositoryDetails": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.codegurureviewer#S3BucketName", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket used for associating a new S3 repository. It must begin with \n codeguru-reviewer-.

" + } + }, + "CodeArtifacts": { + "target": "com.amazonaws.codegurureviewer#CodeArtifacts", + "traits": { + "smithy.api#documentation": "

\n A CodeArtifacts object. The CodeArtifacts object includes the S3 \n object key for a source code .zip file and for a build artifacts .zip file that contains .jar or .class files.\n

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

\n Specifies the name of an S3 bucket and a CodeArtifacts object that contains the S3 \n object keys for a source code .zip file and for a build artifacts .zip file that contains .jar or .class files.\n

" + } + }, + "com.amazonaws.codegurureviewer#SourceCodeArtifactsObjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^\\S(.*\\S)?$" + } + }, "com.amazonaws.codegurureviewer#SourceCodeType": { "type": "structure", "members": { @@ -2061,10 +2451,28 @@ }, "RepositoryHead": { "target": "com.amazonaws.codegurureviewer#RepositoryHeadSourceCodeType" + }, + "BranchDiff": { + "target": "com.amazonaws.codegurureviewer#BranchDiffSourceCodeType", + "traits": { + "smithy.api#documentation": "

\n A type of \n SourceCodeType\n that \n specifies a source branch name and a destination branch name in an associated repository.\n

" + } + }, + "S3BucketRepository": { + "target": "com.amazonaws.codegurureviewer#S3BucketRepository", + "traits": { + "smithy.api#documentation": "

\n\t\t\tInformation about an associated repository in an S3 bucket that includes its name and an S3RepositoryDetails object. \n\t\t\tThe S3RepositoryDetails object includes the name of an S3 bucket, an S3 key for a source code .zip file, and \n\t\t\tan S3 key for a build artifacts .zip file. S3BucketRepository is required in \n SourceCodeType\n for \n S3BucketRepository based code reviews.\n\t\t

" + } + }, + "RequestMetadata": { + "target": "com.amazonaws.codegurureviewer#RequestMetadata", + "traits": { + "smithy.api#documentation": "

Metadata that is associated with a code review. This applies to any type of code review supported by CodeGuru Reviewer. The \n RequestMetadaa field captures any event metadata. For example, it might capture metadata associated with \n an event trigger, such as a push or a pull request.

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

\n Specifies the source code that is analyzed in a code review. A code review can analyze the source code that is specified \n using a pull request diff or a branch in an associated repository.\n

" + "smithy.api#documentation": "

\n Specifies the source code that is analyzed in a code review. \n

" } }, "com.amazonaws.codegurureviewer#StateReason": { @@ -2202,7 +2610,7 @@ "Owner": { "target": "com.amazonaws.codegurureviewer#Owner", "traits": { - "smithy.api#documentation": "

\n The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket repository, \n this is the username for the account that owns the repository. \n

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

\n The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket repository, \n this is the username for the account that owns the repository. For an S3 repository, \n this can be the username or AWS account ID.\n

", "smithy.api#required": {} } } @@ -2328,6 +2736,25 @@ "smithy.api#error": "client", "smithy.api#httpError": 400 } + }, + "com.amazonaws.codegurureviewer#VendorName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GitHub", + "name": "GITHUB" + }, + { + "value": "GitLab", + "name": "GITLAB" + }, + { + "value": "NativeS3", + "name": "NATIVE_S3" + } + ] + } } } } diff --git a/aws/sdk/aws-models/codeguruprofiler.json b/aws/sdk/aws-models/codeguruprofiler.json index e54bb4e6d..68b2066e3 100644 --- a/aws/sdk/aws-models/codeguruprofiler.json +++ b/aws/sdk/aws-models/codeguruprofiler.json @@ -3174,4 +3174,4 @@ } } } -} +} \ No newline at end of file diff --git a/aws/sdk/aws-models/connect.json b/aws/sdk/aws-models/connect.json index 6af653162..ac0199f7a 100644 --- a/aws/sdk/aws-models/connect.json +++ b/aws/sdk/aws-models/connect.json @@ -67,6 +67,15 @@ } } }, + "com.amazonaws.connect#AliasArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.connect#AmazonConnectService": { "type": "service", "version": "2017-08-08", @@ -74,6 +83,9 @@ { "target": "com.amazonaws.connect#AssociateApprovedOrigin" }, + { + "target": "com.amazonaws.connect#AssociateBot" + }, { "target": "com.amazonaws.connect#AssociateInstanceStorageConfig" }, @@ -173,6 +185,9 @@ { "target": "com.amazonaws.connect#DisassociateApprovedOrigin" }, + { + "target": "com.amazonaws.connect#DisassociateBot" + }, { "target": "com.amazonaws.connect#DisassociateInstanceStorageConfig" }, @@ -206,6 +221,9 @@ { "target": "com.amazonaws.connect#ListApprovedOrigins" }, + { + "target": "com.amazonaws.connect#ListBots" + }, { "target": "com.amazonaws.connect#ListContactFlows" }, @@ -428,7 +446,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -442,6 +460,65 @@ } } }, + "com.amazonaws.connect#AssociateBot": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociateBotRequest" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/instance/{InstanceId}/bot", + "code": 200 + } + } + }, + "com.amazonaws.connect#AssociateBotRequest": { + "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": {} + } + }, + "LexBot": { + "target": "com.amazonaws.connect#LexBot" + }, + "LexV2Bot": { + "target": "com.amazonaws.connect#LexV2Bot", + "traits": { + "smithy.api#documentation": "

The Amazon Lex V2 bot to associate with the instance.

" + } + } + } + }, "com.amazonaws.connect#AssociateInstanceStorageConfig": { "type": "operation", "input": { @@ -485,7 +562,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -560,7 +637,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -617,7 +694,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -625,7 +702,7 @@ "LexBot": { "target": "com.amazonaws.connect#LexBot", "traits": { - "smithy.api#documentation": "

The Amazon Lex box to associate with the instance.

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

The Amazon Lex bot to associate with the instance.

", "smithy.api#required": {} } } @@ -671,7 +748,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -730,7 +807,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -798,7 +875,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -1223,6 +1300,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ContactNotFoundException", + "httpResponseCode": 410 + }, "smithy.api#documentation": "

The contact with the specified ID is not active or does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 410 @@ -1478,7 +1559,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -1589,7 +1670,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -1690,7 +1771,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Creates a quick connect for the specified Amazon Connect instance.

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

Creates a quick connect for the specified Amazon Connect instance.

", "smithy.api#http": { "method": "PUT", "uri": "/quick-connects/{InstanceId}", @@ -1704,7 +1785,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -1749,7 +1830,7 @@ "QuickConnectId": { "target": "com.amazonaws.connect#QuickConnectId", "traits": { - "smithy.api#documentation": "

The identifier for the quick connect.

" + "smithy.api#documentation": "

The identifier for the quick connect. \n

" } } } @@ -1800,7 +1881,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -1904,7 +1985,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -2048,7 +2129,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -2130,7 +2211,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -2371,7 +2452,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -2412,7 +2493,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -2450,7 +2531,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Deletes a quick connect.

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

Deletes a quick connect.

", "smithy.api#http": { "method": "DELETE", "uri": "/quick-connects/{InstanceId}/{QuickConnectId}", @@ -2464,7 +2545,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -2513,7 +2594,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -2615,7 +2696,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -2628,7 +2709,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -2752,7 +2833,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -2846,7 +2927,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -2878,7 +2959,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -2936,7 +3017,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -3010,7 +3091,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -3062,7 +3143,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes the quick connect.

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

Describes the quick connect.

", "smithy.api#http": { "method": "GET", "uri": "/quick-connects/{InstanceId}/{QuickConnectId}", @@ -3076,7 +3157,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -3142,7 +3223,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -3250,7 +3331,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -3308,7 +3389,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -3340,7 +3421,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -3378,6 +3459,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DestinationNotAllowedException", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

Outbound calls to the destination number are not allowed.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -3483,7 +3568,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -3498,6 +3583,56 @@ } } }, + "com.amazonaws.connect#DisassociateBot": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DisassociateBotRequest" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "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

Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2\n bot.

", + "smithy.api#http": { + "method": "POST", + "uri": "/instance/{InstanceId}/bot", + "code": 200 + } + } + }, + "com.amazonaws.connect#DisassociateBotRequest": { + "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": {} + } + }, + "LexBot": { + "target": "com.amazonaws.connect#LexBot" + }, + "LexV2Bot": { + "target": "com.amazonaws.connect#LexV2Bot", + "traits": { + "smithy.api#documentation": "

The Amazon Lex V2 bot to disassociate from the instance.

" + } + } + } + }, "com.amazonaws.connect#DisassociateInstanceStorageConfig": { "type": "operation", "input": { @@ -3535,7 +3670,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -3595,7 +3730,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance..

", + "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": {} } @@ -3647,7 +3782,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -3707,7 +3842,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -3766,7 +3901,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -3825,7 +3960,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -4038,7 +4173,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -4144,7 +4279,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -4207,7 +4342,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -4236,13 +4371,13 @@ "Groupings": { "target": "com.amazonaws.connect#Groupings", "traits": { - "smithy.api#documentation": "

The grouping applied to the metrics returned. For example, when results are grouped by\n queue, the metrics returned are grouped by queue. The values returned apply to the metrics for\n each queue rather than aggregated for all queues.

\n \n

If no grouping is specified, a summary of metrics for all queues is returned.

" + "smithy.api#documentation": "

The grouping applied to the metrics returned. For example, when results are grouped by\n queue, the metrics returned are grouped by queue. The values returned apply to the metrics for\n each queue rather than aggregated for all queues.

\n\n

If no grouping is specified, a summary of metrics for all queues is returned.

" } }, "HistoricalMetrics": { "target": "com.amazonaws.connect#HistoricalMetrics", "traits": { - "smithy.api#documentation": "

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The\n following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator\n Guide.

\n
\n
ABANDON_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
AFTER_CONTACT_WORK_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
API_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CALLBACK_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_AGENT_HUNG_UP_FIRST
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_CONSULTED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED_INCOMING
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED_OUTBOUND
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_MISSED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_IN
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
HANDLE_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
INTERACTION_AND_HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
INTERACTION_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
OCCUPANCY
\n
\n

Unit: PERCENT

\n

Statistic: AVG

\n
\n
QUEUE_ANSWER_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
QUEUED_TIME
\n
\n

Unit: SECONDS

\n

Statistic: MAX

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: PERCENT

\n

Statistic: AVG

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

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

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The\n following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator\n Guide.

\n \n

This API does not support a contacts\n incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

\n \n\n
\n
ABANDON_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
AFTER_CONTACT_WORK_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
API_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CALLBACK_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_AGENT_HUNG_UP_FIRST
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_CONSULTED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED_INCOMING
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED_OUTBOUND
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_MISSED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_IN
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
HANDLE_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
INTERACTION_AND_HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
INTERACTION_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
OCCUPANCY
\n
\n

Unit: PERCENT

\n

Statistic: AVG

\n
\n
QUEUE_ANSWER_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
QUEUED_TIME
\n
\n

Unit: SECONDS

\n

Statistic: MAX

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: PERCENT

\n

Statistic: AVG

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
", "smithy.api#required": {} } }, @@ -4946,7 +5081,7 @@ "Id": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

" + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

" } }, "Arn": { @@ -5271,7 +5406,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

" + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

" } }, "IntegrationType": { @@ -5478,6 +5613,29 @@ "smithy.api#documentation": "

Configuration information of an Amazon Lex bot.

" } }, + "com.amazonaws.connect#LexBotConfig": { + "type": "structure", + "members": { + "LexBot": { + "target": "com.amazonaws.connect#LexBot" + }, + "LexV2Bot": { + "target": "com.amazonaws.connect#LexV2Bot", + "traits": { + "smithy.api#documentation": "

Configuration information of an Amazon Lex V2 bot.

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

Configuration information of an Amazon Lex or Amazon Lex V2 bot.

" + } + }, + "com.amazonaws.connect#LexBotConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#LexBotConfig" + } + }, "com.amazonaws.connect#LexBotsList": { "type": "list", "member": { @@ -5493,6 +5651,35 @@ } } }, + "com.amazonaws.connect#LexV2Bot": { + "type": "structure", + "members": { + "AliasArn": { + "target": "com.amazonaws.connect#AliasArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.

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

Configuration information of an Amazon Lex V2 bot.

" + } + }, + "com.amazonaws.connect#LexVersion": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "V1", + "name": "V1" + }, + { + "value": "V2", + "name": "V2" + } + ] + } + }, "com.amazonaws.connect#LimitExceededException": { "type": "structure", "members": { @@ -5504,6 +5691,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "LimitExceededException", + "httpResponseCode": 429 + }, "smithy.api#documentation": "

The allowed limit for the resource has been exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 429 @@ -5555,7 +5746,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -5594,6 +5785,96 @@ } } }, + "com.amazonaws.connect#ListBots": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListBotsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListBotsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "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 version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the\n instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/instance/{InstanceId}/bots", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LexBots", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListBotsRequest": { + "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": {} + } + }, + "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#MaxResult25", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "LexVersion": { + "target": "com.amazonaws.connect#LexVersion", + "traits": { + "smithy.api#documentation": "

The version of Amazon Lex or Amazon Lex V2.

", + "smithy.api#httpQuery": "lexVersion", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#ListBotsResponse": { + "type": "structure", + "members": { + "LexBots": { + "target": "com.amazonaws.connect#LexBotConfigList", + "traits": { + "smithy.api#documentation": "

The names and Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified\n instance.

" + } + }, + "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#ListContactFlows": { "type": "operation", "input": { @@ -5640,7 +5921,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -5731,7 +6012,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -5815,7 +6096,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -5900,7 +6181,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -6058,7 +6339,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -6143,7 +6424,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -6228,7 +6509,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -6313,7 +6594,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -6496,7 +6777,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -6589,7 +6870,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -6660,7 +6941,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Provides information about the quick connects for the specified Amazon Connect instance.

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

Provides information about the quick connects for the specified Amazon Connect instance.

", "smithy.api#http": { "method": "GET", "uri": "/quick-connects/{InstanceId}", @@ -6680,7 +6961,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -6772,7 +7053,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -6865,7 +7146,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -6950,7 +7231,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -7035,7 +7316,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -7175,7 +7456,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -7271,7 +7552,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -7356,7 +7637,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -7468,7 +7749,7 @@ "Concurrency": { "target": "com.amazonaws.connect#Concurrency", "traits": { - "smithy.api#documentation": "

The number of contacts an agent can have on a channel simultaneously.

\n

Valid Range for VOICE: Minimum value of 1. Maximum value of 1.

\n

Valid Range for CHAT: Minimum value of 1. Maximum value of 5.

\n

Valid Range for TASK: Minimum value of 1. Maximum value of 10.

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

The number of contacts an agent can have on a channel simultaneously.

\n

Valid Range for VOICE: Minimum value of 1. Maximum value of 1.

\n

Valid Range for CHAT: Minimum value of 1. Maximum value of 10.

\n

Valid Range for TASK: Minimum value of 1. Maximum value of 10.

", "smithy.api#required": {} } } @@ -7568,6 +7849,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "OutboundContactNotPermittedException", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

The contact is not permitted.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -7618,7 +7903,7 @@ "com.amazonaws.connect#Password": { "type": "string", "traits": { - "smithy.api#pattern": "/^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d\\S]{8,64}$/" + "smithy.api#pattern": "^/^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d\\S]{8,64}$/$" } }, "com.amazonaws.connect#PhoneNumber": { @@ -9105,7 +9390,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 0, + "min": 1, "max": 250 } } @@ -9377,7 +9662,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "smithy.api#required": {} } }, @@ -9407,7 +9692,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

" + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

" } }, "Name": { @@ -9831,7 +10116,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "smithy.api#required": {} } }, @@ -9930,7 +10215,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "smithy.api#required": {} } }, @@ -10021,14 +10306,14 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. The token is valid for 7 days after creation. If a contact is already started, the\n contact ID is returned. If the contact is disconnected, a new contact is started.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. The token is valid for 7 days after creation. If a contact is already started, the\n contact ID is returned.\n

", "smithy.api#idempotencyToken": {} } }, @@ -10106,7 +10391,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "smithy.api#required": {} } }, @@ -10255,7 +10540,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "smithy.api#required": {} } }, @@ -10292,7 +10577,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "smithy.api#required": {} } } @@ -10362,7 +10647,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "smithy.api#required": {} } }, @@ -10518,6 +10803,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ThrottlingException", + "httpResponseCode": 429 + }, "smithy.api#documentation": "

The throttling limit has been exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 429 @@ -10653,7 +10942,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "smithy.api#required": {} } }, @@ -10836,7 +11125,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -10895,7 +11184,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -10961,7 +11250,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -11020,7 +11309,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -11082,7 +11371,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -11146,7 +11435,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -11205,7 +11494,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -11250,7 +11539,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the configuration settings for the specified quick connect.

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

Updates the configuration settings for the specified quick connect.

", "smithy.api#http": { "method": "POST", "uri": "/quick-connects/{InstanceId}/{QuickConnectId}/config", @@ -11264,7 +11553,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -11286,6 +11575,15 @@ } } }, + "com.amazonaws.connect#UpdateQuickConnectDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 + } + } + }, "com.amazonaws.connect#UpdateQuickConnectName": { "type": "operation", "input": { @@ -11309,7 +11607,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.

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

Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.

", "smithy.api#http": { "method": "POST", "uri": "/quick-connects/{InstanceId}/{QuickConnectId}/name", @@ -11323,7 +11621,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -11343,7 +11641,7 @@ } }, "Description": { - "target": "com.amazonaws.connect#QuickConnectDescription", + "target": "com.amazonaws.connect#UpdateQuickConnectDescription", "traits": { "smithy.api#documentation": "

The description of the quick connect.

" } @@ -11387,7 +11685,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -11446,7 +11744,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -11508,7 +11806,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -11572,7 +11870,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -11680,7 +11978,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -11707,7 +12005,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -11761,7 +12059,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -11820,7 +12118,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -11879,7 +12177,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -11938,7 +12236,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } @@ -11997,7 +12295,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "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": {} } diff --git a/aws/sdk/aws-models/databrew.json b/aws/sdk/aws-models/databrew.json index 027c7a66e..97e7f172a 100644 --- a/aws/sdk/aws-models/databrew.json +++ b/aws/sdk/aws-models/databrew.json @@ -163,7 +163,7 @@ "name": "databrew" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

AWS 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#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" } }, @@ -394,7 +394,7 @@ "Condition": { "target": "com.amazonaws.databrew#Condition", "traits": { - "smithy.api#documentation": "

A specific condition to apply to a recipe action. For more information, see Recipe\n structure in the AWS Glue DataBrew Developer\n Guide.

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

A specific condition to apply to a recipe action. For more information, see Recipe\n structure in the Glue DataBrew Developer\n Guide.

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

Represents an individual condition that evaluates to true or false.

\n

Conditions are used with recipe actions. The action is only performed for column values where the condition evaluates to true.

\n

If a recipe requires more than one condition, then the recipe must specify multiple ConditionExpression elements. Each condition is applied to the rows in a dataset first, before the recipe action is performed.

" + "smithy.api#documentation": "

Represents an individual condition that evaluates to true or false.

\n

Conditions are used with recipe actions. The action is only performed for column values where the \n condition evaluates to true.

\n

If a recipe requires more than one condition, then the recipe must specify multiple \n ConditionExpression elements. Each condition is applied to the rows in a dataset first, before \n the recipe action is performed.

" } }, "com.amazonaws.databrew#ConditionExpressionList": { @@ -491,7 +491,7 @@ "Format": { "target": "com.amazonaws.databrew#InputFormat", "traits": { - "smithy.api#documentation": "

The file format of a dataset that is created from an S3 file or folder.

" + "smithy.api#documentation": "

The file format of a dataset that is created from an Amazon S3 file or folder.

" } }, "FormatOptions": { @@ -506,7 +506,7 @@ "PathOptions": { "target": "com.amazonaws.databrew#PathOptions", "traits": { - "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an S3 path of the dataset.

" + "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

" } }, "Tags": { @@ -582,7 +582,7 @@ "EncryptionMode": { "target": "com.amazonaws.databrew#EncryptionMode", "traits": { - "smithy.api#documentation": "

The encryption mode for the job, which can be one of the following:

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

The encryption mode for the job, which can be one of the following:

\n " } }, "Name": { @@ -619,7 +619,7 @@ "RoleArn": { "target": "com.amazonaws.databrew#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to\n be assumed when DataBrew runs the job.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to\n be assumed when DataBrew runs the job.

", "smithy.api#required": {} } }, @@ -716,7 +716,7 @@ "RoleArn": { "target": "com.amazonaws.databrew#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to\n be assumed for this request.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to\n be assumed for this request.

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

Creates a new job to transform input data, using steps defined in an existing AWS Glue\n DataBrew recipe

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

Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe

", "smithy.api#http": { "method": "POST", "uri": "/recipeJobs", @@ -820,7 +820,7 @@ "EncryptionMode": { "target": "com.amazonaws.databrew#EncryptionMode", "traits": { - "smithy.api#documentation": "

The encryption mode for the job, which can be one of the following:

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

The encryption mode for the job, which can be one of the following:

\n " } }, "Name": { @@ -851,8 +851,13 @@ "Outputs": { "target": "com.amazonaws.databrew#OutputList", "traits": { - "smithy.api#documentation": "

One or more artifacts that represent the output from running the job.

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

One or more artifacts that represent the output from running the job.

" + } + }, + "DataCatalogOutputs": { + "target": "com.amazonaws.databrew#DataCatalogOutputList", + "traits": { + "smithy.api#documentation": "

One or more artifacts that represent the AWS Glue Data Catalog output from running the job.

" } }, "ProjectName": { @@ -867,7 +872,7 @@ "RoleArn": { "target": "com.amazonaws.databrew#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to\n be assumed when DataBrew runs the job.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to\n be assumed when DataBrew runs the job.

", "smithy.api#required": {} } }, @@ -980,7 +985,7 @@ "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 more information,\n see Cron\n expressions in the AWS Glue DataBrew Developer\n Guide.

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

The date or dates and time or times when the jobs are to be run. For more information,\n see Cron\n expressions in the Glue DataBrew Developer\n Guide.

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

Represents a set of options that define how DataBrew will read a comma-separated value (CSV) file when creating a dataset from that file.

" + "smithy.api#documentation": "

Represents a set of options that define how DataBrew will read a \n comma-separated value (CSV) file when creating a dataset from that file.

" } }, "com.amazonaws.databrew#CsvOutputOptions": { @@ -1063,7 +1068,7 @@ "CatalogId": { "target": "com.amazonaws.databrew#CatalogId", "traits": { - "smithy.api#documentation": "

The unique identifier of the AWS account that holds the Data Catalog that stores the\n data.

" + "smithy.api#documentation": "

The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the\n data.

" } }, "DatabaseName": { @@ -1083,12 +1088,69 @@ "TempDirectory": { "target": "com.amazonaws.databrew#S3Location", "traits": { - "smithy.api#documentation": "

An Amazon location that AWS Glue Data Catalog can use as a temporary directory.

" + "smithy.api#documentation": "

Represents an Amazon location where DataBrew can store intermediate results.

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

Represents how metadata stored in the AWS Glue Data Catalog is defined in a DataBrew\n dataset.

" + "smithy.api#documentation": "

Represents how metadata stored in the Glue Data Catalog is defined in a DataBrew\n dataset.

" + } + }, + "com.amazonaws.databrew#DataCatalogOutput": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.databrew#CatalogId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the AWS account that holds the Data Catalog that stores the data.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.databrew#DatabaseName", + "traits": { + "smithy.api#documentation": "

The name of a database in the Data Catalog.

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

The name of a table in the Data Catalog.

", + "smithy.api#required": {} + } + }, + "S3Options": { + "target": "com.amazonaws.databrew#S3TableOutputOptions", + "traits": { + "smithy.api#documentation": "

Represents options that specify how and where DataBrew writes the S3 output generated \n by recipe jobs.

" + } + }, + "DatabaseOptions": { + "target": "com.amazonaws.databrew#DatabaseTableOutputOptions", + "traits": { + "smithy.api#documentation": "

Represents options that specify how and where DataBrew writes the database output \n generated by recipe jobs.

" + } + }, + "Overwrite": { + "target": "com.amazonaws.databrew#OverwriteOutput", + "traits": { + "smithy.api#documentation": "

A value that, if true, means that any data in the location specified for output \n is overwritten with new output. Not supported with DatabaseOptions.

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

Represents options that specify how and where DataBrew writes the output generated by recipe \n jobs.

" + } + }, + "com.amazonaws.databrew#DataCatalogOutputList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#DataCatalogOutput" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } } }, "com.amazonaws.databrew#DatabaseInputDefinition": { @@ -1097,7 +1159,7 @@ "GlueConnectionName": { "target": "com.amazonaws.databrew#GlueConnectionName", "traits": { - "smithy.api#documentation": "

The AWS Glue Connection that stores the connection information for the target\n database.

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

The Glue Connection that stores the connection information for the target\n database.

", "smithy.api#required": {} } }, @@ -1134,13 +1196,34 @@ } } }, + "com.amazonaws.databrew#DatabaseTableOutputOptions": { + "type": "structure", + "members": { + "TempDirectory": { + "target": "com.amazonaws.databrew#S3Location", + "traits": { + "smithy.api#documentation": "

Represents an Amazon S3 location (bucket name and object key) where DataBrew can store \n intermediate results.

" + } + }, + "TableName": { + "target": "com.amazonaws.databrew#DatabaseTableName", + "traits": { + "smithy.api#documentation": "

A prefix for the name of a table DataBrew will create in the database.

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

Represents options that specify how and where DataBrew writes the database output generated by recipe \n jobs.

" + } + }, "com.amazonaws.databrew#Dataset": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.databrew#AccountId", "traits": { - "smithy.api#documentation": "

The ID of the AWS account that owns the dataset.

" + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the dataset.

" } }, "CreatedBy": { @@ -1165,7 +1248,7 @@ "Format": { "target": "com.amazonaws.databrew#InputFormat", "traits": { - "smithy.api#documentation": "

The file format of a dataset that is created from an S3 file or folder.

" + "smithy.api#documentation": "

The file format of a dataset that is created from an Amazon S3 file or folder.

" } }, "FormatOptions": { @@ -1177,7 +1260,7 @@ "Input": { "target": "com.amazonaws.databrew#Input", "traits": { - "smithy.api#documentation": "

Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog\n or Amazon S3.

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

Information on how DataBrew can find the dataset, in either the Glue Data Catalog\n or Amazon S3.

", "smithy.api#required": {} } }, @@ -1196,13 +1279,13 @@ "Source": { "target": "com.amazonaws.databrew#Source", "traits": { - "smithy.api#documentation": "

The location of the data for the dataset, either Amazon S3 or the AWS Glue Data\n Catalog.

" + "smithy.api#documentation": "

The location of the data for the dataset, either Amazon S3 or the Glue Data Catalog.

" } }, "PathOptions": { "target": "com.amazonaws.databrew#PathOptions", "traits": { - "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an S3 path of the dataset.

" + "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

" } }, "Tags": { @@ -1243,7 +1326,7 @@ "Name": { "target": "com.amazonaws.databrew#PathParameterName", "traits": { - "smithy.api#documentation": "

The name of the parameter that is used in the dataset's S3 path.

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

The name of the parameter that is used in the dataset's Amazon S3 path.

", "smithy.api#required": {} } }, @@ -1263,7 +1346,7 @@ "CreateColumn": { "target": "com.amazonaws.databrew#CreateColumn", "traits": { - "smithy.api#documentation": "

Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.

" + "smithy.api#documentation": "

Optional boolean value that defines whether the captured value of this parameter \n should be used to create a new column in a dataset.

" } }, "Filter": { @@ -1274,7 +1357,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a dataset paramater that defines type and conditions for a parameter in the S3 path of the dataset.

" + "smithy.api#documentation": "

Represents a dataset paramater that defines type and conditions for a parameter in the Amazon S3 \n path of the dataset.

" } }, "com.amazonaws.databrew#Date": { @@ -1295,14 +1378,14 @@ "Format": { "target": "com.amazonaws.databrew#DatetimeFormat", "traits": { - "smithy.api#documentation": "

Required option, that defines the datetime format used for a date parameter in the S3 path. Should use only supported datetime specifiers and separation characters, all \n litera a-z or A-Z character should be escaped with single quotes. E.g. \"MM.dd.yyyy-'at'-HH:mm\".

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

Required option, that defines the datetime format used for a date parameter in the \n Amazon S3 path. Should use only supported datetime specifiers and separation characters, all \n literal a-z or A-Z characters should be escaped with single quotes. E.g. \"MM.dd.yyyy-'at'-HH:mm\".

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

Optional value for a timezone offset of the datetime parameter value in the S3 path. Shouldn't be used if Format for this parameter includes timezone fields.\n If no offset specified, UTC is assumed.

" + "smithy.api#documentation": "

Optional value for a timezone offset of the datetime parameter value in the Amazon S3 \n path. Shouldn't be used if Format for this parameter includes timezone fields.\n If no offset specified, UTC is assumed.

" } }, "LocaleCode": { @@ -1313,7 +1396,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents additional options for correct interpretation of datetime parameters used in the S3 path of a dataset.

" + "smithy.api#documentation": "

Represents additional options for correct interpretation of datetime parameters used in \n the Amazon S3 path of a dataset.

" } }, "com.amazonaws.databrew#DeleteDataset": { @@ -1665,7 +1748,7 @@ "Format": { "target": "com.amazonaws.databrew#InputFormat", "traits": { - "smithy.api#documentation": "

The file format of a dataset that is created from an S3 file or folder.

" + "smithy.api#documentation": "

The file format of a dataset that is created from an Amazon S3 file or folder.

" } }, "FormatOptions": { @@ -1692,13 +1775,13 @@ "Source": { "target": "com.amazonaws.databrew#Source", "traits": { - "smithy.api#documentation": "

The location of the data for this dataset, Amazon S3 or the AWS Glue Data\n Catalog.

" + "smithy.api#documentation": "

The location of the data for this dataset, Amazon S3 or the Glue Data Catalog.

" } }, "PathOptions": { "target": "com.amazonaws.databrew#PathOptions", "traits": { - "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an S3 path of the dataset.

" + "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

" } }, "Tags": { @@ -1783,7 +1866,7 @@ "EncryptionMode": { "target": "com.amazonaws.databrew#EncryptionMode", "traits": { - "smithy.api#documentation": "

The encryption mode for the job, which can be one of the following:

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

The encryption mode for the job, which can be one of the following:

\n " } }, "Name": { @@ -1835,6 +1918,12 @@ "smithy.api#documentation": "

One or more artifacts that represent the output from running the job.

" } }, + "DataCatalogOutputs": { + "target": "com.amazonaws.databrew#DataCatalogOutputList", + "traits": { + "smithy.api#documentation": "

One or more artifacts that represent the AWS Glue Data Catalog output from running the job.

" + } + }, "ProjectName": { "target": "com.amazonaws.databrew#ProjectName", "traits": { @@ -1853,7 +1942,7 @@ "RoleArn": { "target": "com.amazonaws.databrew#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the AWS Identity and Access Management (IAM) role to be assumed when\n DataBrew runs the job.

" + "smithy.api#documentation": "

The ARN of the Identity and Access Management (IAM) role to be assumed when\n DataBrew runs the job.

" } }, "Tags": { @@ -1992,6 +2081,12 @@ "smithy.api#documentation": "

One or more output artifacts from a job run.

" } }, + "DataCatalogOutputs": { + "target": "com.amazonaws.databrew#DataCatalogOutputList", + "traits": { + "smithy.api#documentation": "

One or more artifacts that represent the AWS Glue Data Catalog output from running the job.

" + } + }, "RecipeReference": { "target": "com.amazonaws.databrew#RecipeReference" }, @@ -2111,7 +2206,7 @@ "RoleArn": { "target": "com.amazonaws.databrew#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the AWS Identity and Access Management (IAM) role to be assumed when\n DataBrew runs the job.

" + "smithy.api#documentation": "

The ARN of the Identity and Access Management (IAM) role to be assumed when\n DataBrew runs the job.

" } }, "Tags": { @@ -2349,7 +2444,7 @@ "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 AWS Glue DataBrew Developer Guide.

" + "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": { @@ -2442,25 +2537,25 @@ "MaxFiles": { "target": "com.amazonaws.databrew#MaxFiles", "traits": { - "smithy.api#documentation": "

The number of S3 files to select.

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

The number of Amazon S3 files to select.

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

A criteria to use for S3 files sorting before their selection. By default uses LAST_MODIFIED_DATE as \n a sorting criteria. Currently it's the only allowed value.

" + "smithy.api#documentation": "

A criteria to use for Amazon S3 files sorting before their selection. By default uses LAST_MODIFIED_DATE as \n a sorting criteria. Currently it's the only allowed value.

" } }, "Order": { "target": "com.amazonaws.databrew#Order", "traits": { - "smithy.api#documentation": "

A criteria to use for S3 files sorting before their selection. By default uses DESCENDING order, \n i.e. most recent files are selected first. Anotherpossible value is ASCENDING.

" + "smithy.api#documentation": "

A criteria to use for Amazon S3 files sorting before their selection. By default uses DESCENDING order, \n i.e. most recent files are selected first. Anotherpossible value is ASCENDING.

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

Represents a limit imposed on number of S3 files that should be selected for a dataset from a connected \n S3 path.

" + "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.

" } }, "com.amazonaws.databrew#FilterExpression": { @@ -2482,7 +2577,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a structure for defining parameter conditions.

" + "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": { @@ -2508,7 +2603,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input.

" + "smithy.api#documentation": "

Represents a set of options that define the structure of either comma-separated value (CSV),\n Excel, or JSON input.

" } }, "com.amazonaws.databrew#GlueConnectionName": { @@ -2544,7 +2639,7 @@ "DataCatalogInputDefinition": { "target": "com.amazonaws.databrew#DataCatalogInputDefinition", "traits": { - "smithy.api#documentation": "

The AWS Glue Data Catalog parameters for the data.

" + "smithy.api#documentation": "

The Glue Data Catalog parameters for the data.

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

Represents information on how DataBrew can find data, in either the AWS Glue Data Catalog or\n Amazon S3.

" + "smithy.api#documentation": "

Represents information on how DataBrew can find data, in either the Glue Data Catalog or\n Amazon S3.

" } }, "com.amazonaws.databrew#InputFormat": { @@ -2600,7 +2695,7 @@ "AccountId": { "target": "com.amazonaws.databrew#AccountId", "traits": { - "smithy.api#documentation": "

The ID of the AWS account that owns the job.

" + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the job.

" } }, "CreatedBy": { @@ -2630,7 +2725,7 @@ "EncryptionMode": { "target": "com.amazonaws.databrew#EncryptionMode", "traits": { - "smithy.api#documentation": "

The encryption mode for the job, which can be one of the following:

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

The encryption mode for the job, which can be one of the following:

\n " } }, "Name": { @@ -2682,6 +2777,12 @@ "smithy.api#documentation": "

One or more artifacts that represent output from running the job.

" } }, + "DataCatalogOutputs": { + "target": "com.amazonaws.databrew#DataCatalogOutputList", + "traits": { + "smithy.api#documentation": "

One or more artifacts that represent the AWS Glue Data Catalog output \n from running the job.

" + } + }, "ProjectName": { "target": "com.amazonaws.databrew#ProjectName", "traits": { @@ -2825,6 +2926,12 @@ "smithy.api#documentation": "

One or more output artifacts from a job run.

" } }, + "DataCatalogOutputs": { + "target": "com.amazonaws.databrew#DataCatalogOutputList", + "traits": { + "smithy.api#documentation": "

One or more artifacts that represent the AWS Glue Data Catalog output \n from running the job.

" + } + }, "RecipeReference": { "target": "com.amazonaws.databrew#RecipeReference", "traits": { @@ -2959,7 +3066,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the JSON-specific options that define how input is to be interpreted by AWS\n Glue DataBrew.

" + "smithy.api#documentation": "

Represents the JSON-specific options that define how input is to be interpreted by Glue DataBrew.

" } }, "com.amazonaws.databrew#Key": { @@ -3806,7 +3913,7 @@ "LastModifiedDateCondition": { "target": "com.amazonaws.databrew#FilterExpression", "traits": { - "smithy.api#documentation": "

If provided, this structure defines a date range for matching S3 objects based on their LastModifiedDate attribute in S3.

" + "smithy.api#documentation": "

If provided, this structure defines a date range for matching Amazon S3 objects based on their \n LastModifiedDate attribute in Amazon S3.

" } }, "FilesLimit": { @@ -3818,12 +3925,12 @@ "Parameters": { "target": "com.amazonaws.databrew#PathParametersMap", "traits": { - "smithy.api#documentation": "

A structure that maps names of parameters used in the S3 path of a dataset to their definitions.

" + "smithy.api#documentation": "

A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.

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

Represents a set of options that define how DataBrew selects files for a given S3 path in a dataset.

" + "smithy.api#documentation": "

Represents a set of options that define how DataBrew selects files for a given Amazon S3 \n path in a dataset.

" } }, "com.amazonaws.databrew#PathParameterName": { @@ -3844,7 +3951,7 @@ "target": "com.amazonaws.databrew#DatasetParameter" }, "traits": { - "smithy.api#documentation": "

A structure that map names of parameters used in the S3 path of a dataset to their definitions. A definition includes parameter type and conditions.

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

A structure that map names of parameters used in the Amazon S3 path of a dataset to their definitions. \n A definition includes parameter type and conditions.

", "smithy.api#length": { "min": 1, "max": 10 @@ -3860,7 +3967,7 @@ "AccountId": { "target": "com.amazonaws.databrew#AccountId", "traits": { - "smithy.api#documentation": "

The ID of the AWS account that owns the project.

" + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the project.

" } }, "CreateDate": { @@ -4130,7 +4237,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a transformation and associated parameters that are used to apply a change\n to a DataBrew dataset. For more information, see Recipe structure and Recipe\n actions reference.

" + "smithy.api#documentation": "

Represents a transformation and associated parameters that are used to apply a change\n to a DataBrew dataset. For more information, see Recipe\n actions reference.

" } }, "com.amazonaws.databrew#RecipeDescription": { @@ -4283,7 +4390,7 @@ "Bucket": { "target": "com.amazonaws.databrew#Bucket", "traits": { - "smithy.api#documentation": "

The S3 bucket name.

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

The Amazon S3 bucket name.

", "smithy.api#required": {} } }, @@ -4298,6 +4405,21 @@ "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 S3 output generated by \n recipe jobs.

" + } + }, "com.amazonaws.databrew#Sample": { "type": "structure", "members": { @@ -4369,7 +4491,7 @@ "AccountId": { "target": "com.amazonaws.databrew#AccountId", "traits": { - "smithy.api#documentation": "

The ID of the AWS account that owns the schedule.

" + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the schedule.

" } }, "CreatedBy": { @@ -4411,7 +4533,7 @@ "CronExpression": { "target": "com.amazonaws.databrew#CronExpression", "traits": { - "smithy.api#documentation": "

The dates and times when the job is to run. For more information, see Cron\n expressions in the AWS Glue DataBrew Developer\n Guide.

" + "smithy.api#documentation": "

The dates and times when the job is to run. For more information, see Cron\n expressions in the Glue DataBrew Developer\n Guide.

" } }, "Tags": { @@ -5089,7 +5211,7 @@ "Format": { "target": "com.amazonaws.databrew#InputFormat", "traits": { - "smithy.api#documentation": "

The file format of a dataset that is created from an S3 file or folder.

" + "smithy.api#documentation": "

The file format of a dataset that is created from an Amazon S3 file or folder.

" } }, "FormatOptions": { @@ -5104,7 +5226,7 @@ "PathOptions": { "target": "com.amazonaws.databrew#PathOptions", "traits": { - "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an S3 path of the dataset.

" + "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

" } } } @@ -5161,7 +5283,7 @@ "EncryptionMode": { "target": "com.amazonaws.databrew#EncryptionMode", "traits": { - "smithy.api#documentation": "

The encryption mode for the job, which can be one of the following:

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

The encryption mode for the job, which can be one of the following:

\n " } }, "Name": { @@ -5199,7 +5321,7 @@ "RoleArn": { "target": "com.amazonaws.databrew#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to\n be assumed when DataBrew runs the job.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to\n be assumed when DataBrew runs the job.

", "smithy.api#required": {} } }, @@ -5360,7 +5482,7 @@ "EncryptionMode": { "target": "com.amazonaws.databrew#EncryptionMode", "traits": { - "smithy.api#documentation": "

The encryption mode for the job, which can be one of the following:

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

The encryption mode for the job, which can be one of the following:

\n " } }, "Name": { @@ -5392,14 +5514,19 @@ "Outputs": { "target": "com.amazonaws.databrew#OutputList", "traits": { - "smithy.api#documentation": "

One or more artifacts that represent the output from running the job.

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

One or more artifacts that represent the output from running the job.

" + } + }, + "DataCatalogOutputs": { + "target": "com.amazonaws.databrew#DataCatalogOutputList", + "traits": { + "smithy.api#documentation": "

One or more artifacts that represent the AWS Glue Data Catalog output from running the job.

" } }, "RoleArn": { "target": "com.amazonaws.databrew#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to\n be assumed when DataBrew runs the job.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to\n be assumed when DataBrew runs the job.

", "smithy.api#required": {} } }, @@ -5500,7 +5627,7 @@ "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 more information,\n see Cron\n expressions in the AWS Glue DataBrew Developer\n Guide.

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

The date or dates and time or times when the jobs are to be run. For more information,\n see Cron\n expressions in the Glue DataBrew Developer\n Guide.

", "smithy.api#required": {} } }, diff --git a/aws/sdk/aws-models/dax.json b/aws/sdk/aws-models/dax.json index 2aa32a417..0252a8ba2 100644 --- a/aws/sdk/aws-models/dax.json +++ b/aws/sdk/aws-models/dax.json @@ -188,7 +188,7 @@ "ClusterDiscoveryEndpoint": { "target": "com.amazonaws.dax#Endpoint", "traits": { - "smithy.api#documentation": "

The configuration endpoint for this DAX cluster, consisting of a DNS name and a\n port number. Client applications can specify this endpoint, rather than an individual\n node endpoint, and allow the DAX client software to intelligently route requests and\n responses to nodes in the DAX cluster.

" + "smithy.api#documentation": "

The endpoint for this DAX cluster, consisting of a DNS name, a port number,\n and a URL. Applications should use the URL to configure the DAX client to find\n their cluster.

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

The description of the server-side encryption status on the specified DAX cluster.

" } + }, + "ClusterEndpointEncryptionType": { + "target": "com.amazonaws.dax#ClusterEndpointEncryptionType", + "traits": { + "smithy.api#documentation": "

The type of encryption supported by the cluster's endpoint. Values are:

\n " + } } }, "traits": { @@ -263,6 +269,21 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.dax#ClusterEndpointEncryptionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "TLS", + "name": "TLS" + } + ] + } + }, "com.amazonaws.dax#ClusterList": { "type": "list", "member": { @@ -346,6 +367,9 @@ { "target": "com.amazonaws.dax#ServiceLinkedRoleNotFoundFault" }, + { + "target": "com.amazonaws.dax#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.dax#SubnetGroupNotFoundFault" }, @@ -441,6 +465,12 @@ "traits": { "smithy.api#documentation": "

Represents the settings used to enable server-side encryption on the cluster.

" } + }, + "ClusterEndpointEncryptionType": { + "target": "com.amazonaws.dax#ClusterEndpointEncryptionType", + "traits": { + "smithy.api#documentation": "

The type of encryption the cluster's endpoint should support. Values are:

\n " + } } } }, @@ -1228,10 +1258,16 @@ "traits": { "smithy.api#documentation": "

The port number that applications should use to connect to the endpoint.

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

The URL that applications should use to connect to the endpoint. The default\n ports are 8111 for the \"dax\" protocol and 9111 for the \"daxs\" protocol.

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

Represents the information required for client programs to connect to the\n configuration endpoint for a DAX cluster, or to an individual node within the\n cluster.

" + "smithy.api#documentation": "

Represents the information required for client programs to connect to the\n endpoint for a DAX cluster.

" } }, "com.amazonaws.dax#Event": { @@ -1690,7 +1726,7 @@ "TopicStatus": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The current state of the topic.

" + "smithy.api#documentation": "

The current state of the topic. A value of “active” means that notifications will\n be sent to the topic. A value of “inactive” means that notifications will not be sent to the\n topic.

" } } }, @@ -2075,6 +2111,15 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.dax#ServiceQuotaExceededException": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

You have reached the maximum number of x509 certificates that can be created for\n encrypted clusters in a 30 day period. Contact AWS customer support to discuss options\n for continuing to create encrypted clusters.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, "com.amazonaws.dax#SourceType": { "type": "string", "traits": { @@ -2502,7 +2547,7 @@ "NotificationTopicStatus": { "target": "com.amazonaws.dax#String", "traits": { - "smithy.api#documentation": "

The current state of the topic.

" + "smithy.api#documentation": "

The current state of the topic. A value of “active” means that notifications will\n be sent to the topic. A value of “inactive” means that notifications will not be sent to the\n topic.

" } }, "ParameterGroupName": { @@ -2572,7 +2617,7 @@ "ParameterNameValues": { "target": "com.amazonaws.dax#ParameterNameValueList", "traits": { - "smithy.api#documentation": "

An array of name-value pairs for the parameters in the group. Each element in the\n array represents a single parameter.

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

An array of name-value pairs for the parameters in the group. Each element in the\n array represents a single parameter.

\n \n

\n record-ttl-millis and query-ttl-millis are the only supported parameter names. For more details, see Configuring TTL Settings.

\n ", "smithy.api#required": {} } } diff --git a/aws/sdk/aws-models/docdb.json b/aws/sdk/aws-models/docdb.json index 1d2d23ed4..7c31e2b4b 100644 --- a/aws/sdk/aws-models/docdb.json +++ b/aws/sdk/aws-models/docdb.json @@ -96,7 +96,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds metadata tags to an Amazon DocumentDB resource. You can use these tags \n with cost allocation reporting to track costs that are associated \n with Amazon DocumentDB resources. or in a Condition statement in \n an AWS Identity and Access Management (IAM) policy for Amazon DocumentDB.

" + "smithy.api#documentation": "

Adds metadata tags to an Amazon DocumentDB resource. You can use these tags \n with cost allocation reporting to track costs that are associated \n with Amazon DocumentDB resources or in a Condition statement in \n an Identity and Access Management (IAM) policy for Amazon DocumentDB.

" } }, "com.amazonaws.docdb#AddTagsToResourceMessage": { @@ -396,6 +396,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.

\n

Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -483,7 +487,7 @@ } }, "traits": { - "smithy.api#documentation": "

A certificate authority (CA) certificate for an AWS account.

" + "smithy.api#documentation": "

A certificate authority (CA) certificate for an account.

" } }, "com.amazonaws.docdb#CertificateList": { @@ -501,7 +505,7 @@ "Certificates": { "target": "com.amazonaws.docdb#CertificateList", "traits": { - "smithy.api#documentation": "

A list of certificates for this AWS account.

" + "smithy.api#documentation": "

A list of certificates for this account.

" } }, "Marker": { @@ -520,6 +524,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "CertificateNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n CertificateIdentifier doesn't refer to an existing certificate.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -574,7 +582,7 @@ "SourceDBClusterParameterGroupIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.

\n

Constraints:

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

The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.

\n

Constraints:

\n ", "smithy.api#required": {} } }, @@ -640,7 +648,7 @@ } ], "traits": { - "smithy.api#documentation": "

Copies a snapshot of a cluster.

\n \n

To copy a cluster snapshot from a shared manual cluster snapshot,\n SourceDBClusterSnapshotIdentifier must be the Amazon \n Resource Name (ARN) of the shared cluster snapshot. You can only \n copy a shared DB cluster snapshot, whether encrypted or not, in the \n same AWS Region.

\n \n

To cancel the copy operation after it is in progress, delete the \n target cluster snapshot identified by \n TargetDBClusterSnapshotIdentifier while that cluster \n snapshot is in the copying status.

" + "smithy.api#documentation": "

Copies a snapshot of a cluster.

\n \n

To copy a cluster snapshot from a shared manual cluster snapshot,\n SourceDBClusterSnapshotIdentifier must be the Amazon \n Resource Name (ARN) of the shared cluster snapshot. You can only \n copy a shared DB cluster snapshot, whether encrypted or not, in the \n same Region.

\n \n

To cancel the copy operation after it is in progress, delete the \n target cluster snapshot identified by \n TargetDBClusterSnapshotIdentifier while that cluster \n snapshot is in the copying status.

" } }, "com.amazonaws.docdb#CopyDBClusterSnapshotMessage": { @@ -649,7 +657,7 @@ "SourceDBClusterSnapshotIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The identifier of the cluster snapshot to copy. This parameter is\n not case sensitive.

\n \n

Constraints:

\n \n

Example: my-cluster-snapshot1\n

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

The identifier of the cluster snapshot to copy. This parameter is\n not case sensitive.

\n \n

Constraints:

\n \n

Example: my-cluster-snapshot1\n

", "smithy.api#required": {} } }, @@ -663,13 +671,13 @@ "KmsKeyId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS\n key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or\n the AWS KMS key alias for the AWS KMS encryption key.

\n \n

If you copy an encrypted cluster snapshot from your AWS account, \n you can specify a value for KmsKeyId to encrypt the \n copy with a new AWS KMS encryption key. If you don't specify a value\n for KmsKeyId, then the copy of the cluster snapshot is \n encrypted with the same AWS KMS key as the source cluster snapshot.\n

\n \n

If you copy an encrypted cluster snapshot that is shared from \n another AWS account, then you must specify a value for \n KmsKeyId.

\n \n \n

To copy an encrypted cluster snapshot to another AWS Region, set\n KmsKeyId to the AWS KMS key ID that you want to use to \n encrypt the copy of the cluster snapshot in the destination Region. \n AWS KMS encryption keys are specific to the AWS Region that they are \n created in, and you can't use encryption keys from one AWS Region in \n another AWS Region.

\n \n

If you copy an unencrypted cluster snapshot and specify a value \n for the KmsKeyId parameter, an error is returned.

" + "smithy.api#documentation": "

The KMS key ID for an encrypted cluster snapshot. The KMS\n key ID is the Amazon Resource Name (ARN), KMS key identifier, or\n the KMS key alias for the KMS encryption key.

\n \n

If you copy an encrypted cluster snapshot from your account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.

\n \n

If you copy an encrypted cluster snapshot that is shared from another account, then you must specify a value for KmsKeyId.

\n \n

To copy an encrypted cluster snapshot to another Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Region that they are created in, and you can't use encryption keys from one Region in another Region.

\n \n

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

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

The URL that contains a Signature Version 4 signed request for the\n CopyDBClusterSnapshot API action in the AWS Region that \n contains the source cluster snapshot to copy. You must use the \n PreSignedUrl parameter when copying a cluster snapshot\n from another AWS Region.

\n \n

If you are using an AWS SDK tool or the AWS CLI, you can specify \n SourceRegion (or --source-region for the\n AWS CLI) instead of specifying PreSignedUrl manually. \n Specifying SourceRegion autogenerates a pre-signed URL \n that is a valid request for the operation that can be executed in\n the source AWS Region.

\n \n

The presigned URL must be a valid request for the \n CopyDBClusterSnapshot API action that can be executed \n in the source AWS Region that contains the cluster snapshot to be \n copied. The presigned URL request must contain the following\n parameter values:

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

The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Region.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify \n SourceRegion (or --source-region for the\n CLI) instead of specifying PreSignedUrl manually. \n Specifying SourceRegion autogenerates a pre-signed URL \n that is a valid request for the operation that can be executed in\n the source Region.

\n \n

The presigned URL must be a valid request for the \n CopyDBClusterSnapshot API action that can be executed \n in the source Region that contains the cluster snapshot to be \n copied. The presigned URL request must contain the following\n parameter values:

\n " } }, "CopyTags": { @@ -812,7 +820,7 @@ "EngineVersion": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

" + "smithy.api#documentation": "

The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

" } }, "Port": { @@ -836,13 +844,13 @@ "PreferredBackupWindow": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created if\n automated backups are enabled using the \n BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an 8-hour\n block of time for each AWS Region.

\n

Constraints:

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

The daily time range during which automated backups are created if\n automated backups are enabled using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each Region.

\n

Constraints:

\n " } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, \n in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour\n block of time for each AWS Region, occurring on a random day of the \n week.

\n

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, \n in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each Region, occurring on a random day of the week.

\n

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

" } }, "Tags": { @@ -860,7 +868,7 @@ "KmsKeyId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for an encrypted cluster.

\n

The AWS KMS key identifier is the Amazon Resource Name (ARN) for \n the AWS KMS encryption key. If you are creating a cluster using the\n same AWS account that owns the AWS KMS encryption key that is used \n to encrypt the new cluster, you can use the AWS KMS key alias \n instead of the ARN for the AWS KMS encryption key.

\n

If an encryption key is not specified in KmsKeyId:\n

\n \n

AWS KMS creates the default encryption key for your AWS account. \n Your AWS account has a different default encryption key for each AWS\n Region.

" + "smithy.api#documentation": "

The KMS key identifier for an encrypted cluster.

\n

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.

\n

If an encryption key is not specified in KmsKeyId:\n

\n \n

KMS creates the default encryption key for your account. Your account has a different default encryption key for each Regions.

" } }, "PreSignedUrl": { @@ -1114,19 +1122,19 @@ "AvailabilityZone": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The Amazon EC2 Availability Zone that the instance is created in.

\n

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

\n

Example: us-east-1d\n

" + "smithy.api#documentation": "

The Amazon EC2 Availability Zone that the instance is created in.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Region.

\n

Example: us-east-1d\n

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

The time range each week during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour block of time for\n each AWS Region, occurring on a random day of the week.

\n

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

" + "smithy.api#documentation": "

The time range each week during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour block of time for\n each Region, occurring on a random day of the week.

\n

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.docdb#BooleanOptional", "traits": { - "smithy.api#documentation": "

Indicates that minor engine upgrades are applied automatically to the instance\n during the maintenance window.

\n

Default: true\n

" + "smithy.api#documentation": "

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

\n

Default: false\n

" } }, "Tags": { @@ -1187,7 +1195,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new subnet group. subnet groups must contain at least one subnet in at\n least two Availability Zones in the AWS Region.

" + "smithy.api#documentation": "

Creates a new subnet group. subnet groups must contain at least one subnet in at\n least two Availability Zones in the Region.

" } }, "com.amazonaws.docdb#CreateDBSubnetGroupMessage": { @@ -1288,7 +1296,7 @@ "SourceType": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

\n

Valid values: db-instance, db-cluster,\n db-parameter-group, db-security-group,\n db-snapshot, db-cluster-snapshot\n

" + "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

\n

Valid values: db-instance, db-cluster,\n db-parameter-group, db-security-group,\n db-cluster-snapshot\n

" } }, "EventCategories": { @@ -1351,7 +1359,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon DocumentDB global cluster that can span multiple multiple AWS Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.

\n

\n

You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.

\n \n

This action only applies to Amazon DocumentDB clusters.

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

Creates an Amazon DocumentDB global cluster that can span multiple multiple Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.

\n

\n

You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.

\n \n

This action only applies to Amazon DocumentDB clusters.

\n " } }, "com.amazonaws.docdb#CreateGlobalClusterMessage": { @@ -1443,7 +1451,7 @@ "DBSubnetGroup": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Specifies information on the subnet group that is associated with the cluster,\n including the name, description, and subnets in the subnet group.

" + "smithy.api#documentation": "

Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

" } }, "Status": { @@ -1563,13 +1571,13 @@ "KmsKeyId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

If StorageEncrypted is true, the AWS KMS key identifier for\n the encrypted cluster.

" + "smithy.api#documentation": "

If StorageEncrypted is true, the KMS key identifier for\n the encrypted cluster.

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

The AWS Region-unique, immutable identifier for the cluster. This identifier is\n found in AWS CloudTrail log entries whenever the AWS KMS key for the cluster is\n accessed.

" + "smithy.api#documentation": "

The Region-unique, immutable identifier for the cluster. This identifier is\n found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

" } }, "DBClusterArn": { @@ -1581,7 +1589,7 @@ "AssociatedRoles": { "target": "com.amazonaws.docdb#DBClusterRoles", "traits": { - "smithy.api#documentation": "

Provides a list of the AWS Identity and Access Management (IAM) roles that are\n associated with the cluster. IAM roles that are associated with a cluster grant\n permission for the cluster to access other AWS services on your behalf.

" + "smithy.api#documentation": "

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

" } }, "ClusterCreateTime": { @@ -1615,6 +1623,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterAlreadyExistsFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You already have a cluster with the given identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1698,6 +1710,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBClusterIdentifier doesn't refer to an existing cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -1786,6 +1802,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterParameterGroupNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -1819,6 +1839,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterQuotaExceededFault", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

The cluster can't be created because you have reached the maximum allowed quota of clusters.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -1830,18 +1854,18 @@ "RoleArn": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB\n cluster.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB\n cluster.

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

Describes the state of association between the IAM role and the cluster. The\n Status property returns one of the following values:

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

Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

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

Describes an AWS Identity and Access Management (IAM) role that is associated with a\n cluster.

" + "smithy.api#documentation": "

Describes an Identity and Access Management (IAM) role that is associated with a\n cluster.

" } }, "com.amazonaws.docdb#DBClusterRoles": { @@ -1943,7 +1967,7 @@ "KmsKeyId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

If StorageEncrypted is true, the AWS KMS key identifier for\n the encrypted cluster snapshot.

" + "smithy.api#documentation": "

If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.

" } }, "DBClusterSnapshotArn": { @@ -1971,6 +1995,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterSnapshotAlreadyExistsFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You already have a cluster snapshot with the given identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1982,18 +2010,18 @@ "AttributeName": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The name of the manual cluster snapshot attribute.

\n

The attribute named restore refers to the list of AWS accounts that have\n permission to copy or restore the manual cluster snapshot.

" + "smithy.api#documentation": "

The name of the manual cluster snapshot attribute.

\n

The attribute named restore refers to the list of accounts that have permission to copy or restore the manual cluster snapshot.

" } }, "AttributeValues": { "target": "com.amazonaws.docdb#AttributeValueList", "traits": { - "smithy.api#documentation": "

The values for the manual cluster snapshot attribute.

\n

If the AttributeName field is set to restore, then this\n element returns a list of IDs of the AWS accounts that are authorized to copy or restore\n the manual cluster snapshot. If a value of all is in the list, then the\n manual cluster snapshot is public and available for any AWS account to copy or\n restore.

" + "smithy.api#documentation": "

The values for the manual cluster snapshot attribute.

\n

If the AttributeName field is set to restore, then this element returns a list of IDs of the accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any account to copy or restore.

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

Contains the name and values of a manual cluster snapshot attribute.

\n

Manual cluster snapshot attributes are used to authorize other AWS accounts to\n restore a manual cluster snapshot.

" + "smithy.api#documentation": "

Contains the name and values of a manual cluster snapshot attribute.

\n

Manual cluster snapshot attributes are used to authorize other accounts to restore a manual cluster snapshot.

" } }, "com.amazonaws.docdb#DBClusterSnapshotAttributeList": { @@ -2062,6 +2090,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterSnapshotNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -2218,7 +2250,7 @@ "DBSubnetGroup": { "target": "com.amazonaws.docdb#DBSubnetGroup", "traits": { - "smithy.api#documentation": "

Specifies information on the subnet group that is associated with the instance,\n including the name, description, and subnets in the subnet group.

" + "smithy.api#documentation": "

Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

" } }, "PreferredMaintenanceWindow": { @@ -2230,7 +2262,7 @@ "PendingModifiedValues": { "target": "com.amazonaws.docdb#PendingModifiedValues", "traits": { - "smithy.api#documentation": "

Specifies that changes to the instance are pending. This element is included only\n when changes are pending. Specific changes are identified by subelements.

" + "smithy.api#documentation": "

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

" } }, "LatestRestorableTime": { @@ -2248,7 +2280,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.docdb#Boolean", "traits": { - "smithy.api#documentation": "

Indicates that minor version patches are applied automatically.

" + "smithy.api#documentation": "

Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

" } }, "PubliclyAccessible": { @@ -2278,13 +2310,13 @@ "KmsKeyId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

If StorageEncrypted is true, the AWS KMS key identifier for\n the encrypted instance.

" + "smithy.api#documentation": "

If StorageEncrypted is true, the KMS key identifier for\n the encrypted instance.

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

The AWS Region-unique, immutable identifier for the instance. This identifier is\n found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is\n accessed.

" + "smithy.api#documentation": "

The Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is\n accessed.

" } }, "CACertificateIdentifier": { @@ -2308,7 +2340,7 @@ "EnabledCloudwatchLogsExports": { "target": "com.amazonaws.docdb#LogTypeList", "traits": { - "smithy.api#documentation": "

A list of log types that this instance is configured to export to Amazon CloudWatch\n Logs.

" + "smithy.api#documentation": "

A list of log types that this instance is configured to export to CloudWatch Logs.

" } } }, @@ -2324,6 +2356,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You already have a instance with the given identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2366,6 +2402,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBInstanceIdentifier doesn't refer to an existing instance.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -2420,6 +2460,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBParameterGroupAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

A parameter group with the same name already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2433,6 +2477,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBParameterGroupNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBParameterGroupName doesn't refer to an existing parameter group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -2446,6 +2494,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBParameterGroupQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

This request would cause you to exceed the allowed number of parameter groups.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2459,6 +2511,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSecurityGroupNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBSecurityGroupName doesn't refer to an existing security group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -2472,6 +2528,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSnapshotAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

\n DBSnapshotIdentifier is already being used by an existing snapshot.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2485,6 +2545,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSnapshotNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBSnapshotIdentifier doesn't refer to an existing snapshot.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -2542,6 +2606,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

\n DBSubnetGroupName is already being used by an existing subnet group.

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

Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2588,6 +2660,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBSubnetGroupName doesn't refer to an existing subnet group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -2601,6 +2677,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request would cause you to exceed the allowed number of subnet groups.

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

The request would cause you to exceed the allowed number of subnets in a subnet group.

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

The upgrade failed because a resource that the depends on can't be\n modified.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2806,7 +2894,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a previously provisioned instance.\n

" + "smithy.api#documentation": "

Deletes a previously provisioned instance.

" } }, "com.amazonaws.docdb#DeleteDBInstanceMessage": { @@ -2967,7 +3055,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this AWS account.

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

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this account.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -3136,7 +3224,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of cluster snapshot attribute names and values for a manual DB\n cluster snapshot.

\n

When you share snapshots with other AWS accounts,\n DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all AWS accounts.

" + "smithy.api#documentation": "

Returns a list of cluster snapshot attribute names and values for a manual DB\n cluster snapshot.

\n

When you share snapshots with other accounts,\n DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all accounts.

" } }, "com.amazonaws.docdb#DescribeDBClusterSnapshotAttributesMessage": { @@ -3203,7 +3291,7 @@ "SnapshotType": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The type of cluster snapshots to be returned. You can specify one of the following values:

\n \n

If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

" + "smithy.api#documentation": "

The type of cluster snapshots to be returned. You can specify one of the following values:

\n \n

If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

" } }, "Filters": { @@ -3227,13 +3315,13 @@ "IncludeShared": { "target": "com.amazonaws.docdb#Boolean", "traits": { - "smithy.api#documentation": "

Set to true to include shared manual cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false.

" + "smithy.api#documentation": "

Set to true to include shared manual cluster snapshots from other accounts that this account has been given permission to copy or restore, and otherwise false. The default is false.

" } }, "IncludePublic": { "target": "com.amazonaws.docdb#Boolean", "traits": { - "smithy.api#documentation": "

Set to true to include manual cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false.

" + "smithy.api#documentation": "

Set to true to include manual cluster snapshots that are public and can be copied or restored by any account, and otherwise false. The default is false.

" } } }, @@ -3624,7 +3712,7 @@ "SourceType": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The type of source that is generating the events.

\n

Valid values: db-instance, db-parameter-group,\n db-security-group, db-snapshot\n

" + "smithy.api#documentation": "

The type of source that is generating the events.

\n

Valid values: db-instance, db-parameter-group, db-security-group\n

" } }, "Filters": { @@ -4118,7 +4206,7 @@ "CustomerAwsId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The AWS customer account that is associated with the Amazon DocumentDB event notification\n subscription.

" + "smithy.api#documentation": "

The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification\n subscription.

" } }, "CustSubscriptionId": { @@ -4188,6 +4276,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "EventSubscriptionQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You have reached the maximum number of event subscriptions.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -4265,7 +4357,7 @@ } ], "traits": { - "smithy.api#documentation": "

Forces a failover for a cluster.

\n

A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances)\n in the cluster to be the primary instance (the cluster writer).

\n

If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica,\n if one exists. You can force a failover when you want to simulate a failure of a primary\n instance for\n testing.

" + "smithy.api#documentation": "

Forces a failover for a cluster.

\n

A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).

\n

If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.

" } }, "com.amazonaws.docdb#FailoverDBClusterMessage": { @@ -4274,7 +4366,7 @@ "DBClusterIdentifier": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

A cluster identifier to force a failover for. This parameter is not case\n sensitive.

\n

Constraints:

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

A cluster identifier to force a failover for. This parameter is not case sensitive.

\n

Constraints:

\n " } }, "TargetDBInstanceIdentifier": { @@ -4348,7 +4440,7 @@ "GlobalClusterResourceId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.

" + "smithy.api#documentation": "

The Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.

" } }, "GlobalClusterArn": { @@ -4412,6 +4504,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalClusterAlreadyExistsFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The GlobalClusterIdentifier already exists. Choose a new global cluster identifier (unique name) to create a new global cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -4424,7 +4520,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "[A-Za-z][0-9A-Za-z-:._]*" + "smithy.api#pattern": "^[A-Za-z][0-9A-Za-z-:._]*$" } }, "com.amazonaws.docdb#GlobalClusterList": { @@ -4479,6 +4575,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalClusterNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The GlobalClusterIdentifier doesn't refer to an existing global cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -4492,6 +4592,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalClusterQuotaExceededFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The number of global clusters for this account is already at the maximum allowed.

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

The request would cause you to exceed the allowed number of instances.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -4535,6 +4643,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientDBClusterCapacityFault", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

The cluster doesn't have enough capacity for the current operation.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -4548,6 +4660,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientDBInstanceCapacity", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified instance class isn't available in the specified Availability Zone.

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

There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

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

The provided value isn't a valid cluster snapshot state.

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

The cluster isn't in a valid state.

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

The specified instance isn't in the available state.\n

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

The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.

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

The state of the security group doesn't allow deletion.

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

The state of the snapshot doesn't allow deletion.

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

The subnet group can't be deleted because it's in use.

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

The subnet isn't in the available state.

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

Someone else might be modifying a subscription. Wait a few seconds, and try\n again.

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

The requested operation can't be performed while the cluster is in this state.

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

You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB\n instance.

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

The requested subnet is not valid, or multiple subnets were requested that are not all\n in a common virtual private cloud (VPC).

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

The subnet group doesn't cover all Availability Zones after it is created\n because of changes that were made.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -4752,7 +4924,11 @@ } }, "traits": { - "smithy.api#documentation": "

An error occurred when accessing an AWS KMS key.

", + "aws.protocols#awsQueryError": { + "code": "KMSKeyNotAccessibleFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

An error occurred when accessing an KMS key.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4915,13 +5091,13 @@ "PreferredBackupWindow": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created if automated backups\n are enabled, using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for\n each AWS Region.

\n

Constraints:

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

The daily time range during which automated backups are created if automated backups\n are enabled, using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for\n each Region.

\n

Constraints:

\n " } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour block of time for\n each AWS Region, occurring on a random day of the week.

\n

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an 8-hour block of time for\n each Region, occurring on a random day of the week.

\n

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

" } }, "CloudwatchLogsExportConfiguration": { @@ -5017,7 +5193,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB\n cluster snapshot.

\n

To share a manual cluster snapshot with other AWS accounts, specify\n restore as the AttributeName, and use the\n ValuesToAdd parameter to add a list of IDs of the AWS accounts that are\n authorized to restore the manual cluster snapshot. Use the value all to\n make the manual cluster snapshot public, which means that it can be copied or\n restored by all AWS accounts. Do not add the all value for any manual DB\n cluster snapshots that contain private information that you don't want available to all\n AWS accounts. If a manual cluster snapshot is encrypted, it can be shared, but only\n by specifying a list of authorized AWS account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.

" + "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.

\n

To share a manual cluster snapshot with other accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all accounts. Do not add the all value for any manual cluster snapshots that contain private information that you don't want available to all accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

" } }, "com.amazonaws.docdb#ModifyDBClusterSnapshotAttributeMessage": { @@ -5033,20 +5209,20 @@ "AttributeName": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The name of the cluster snapshot attribute to modify.

\n

To manage authorization for other AWS accounts to copy or restore a manual cluster\n snapshot, set this value to restore.

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

The name of the cluster snapshot attribute to modify.

\n

To manage authorization for other accounts to copy or restore a manual cluster\n snapshot, set this value to restore.

", "smithy.api#required": {} } }, "ValuesToAdd": { "target": "com.amazonaws.docdb#AttributeValueList", "traits": { - "smithy.api#documentation": "

A list of cluster snapshot attributes to add to the attribute specified by\n AttributeName.

\n

To authorize other AWS accounts to copy or restore a manual cluster snapshot, set\n this list to include one or more AWS account IDs. To make the manual cluster snapshot\n restorable by any AWS account, set it to all. Do not add the\n all value for any manual cluster snapshots that contain private\n information that you don't want to be available to all AWS accounts.

" + "smithy.api#documentation": "

A list of cluster snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other accounts to copy or restore a manual cluster snapshot, set this list to include one or more account IDs. To make the manual cluster snapshot restorable by any account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don't want to be available to all accounts.

" } }, "ValuesToRemove": { "target": "com.amazonaws.docdb#AttributeValueList", "traits": { - "smithy.api#documentation": "

A list of cluster snapshot attributes to remove from the attribute specified by\n AttributeName.

\n

To remove authorization for other AWS accounts to copy or restore a manual cluster\n snapshot, set this list to include one or more AWS account identifiers. To remove\n authorization for any AWS account to copy or restore the cluster snapshot, set it to\n all . If you specify all, an AWS account whose account ID\n is explicitly added to the restore attribute can still copy or restore a\n manual cluster snapshot.

" + "smithy.api#documentation": "

A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.

\n

To remove authorization for other accounts to copy or restore a manual cluster snapshot, set this list to include one or more account identifiers. To remove authorization for any account to copy or restore the cluster snapshot, set it to all . If you specify all, an account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.

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

Modifies settings for an instance. You can change one or more database configuration\n parameters by specifying these parameters and the new values in the request.

" + "smithy.api#documentation": "

Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

" } }, "com.amazonaws.docdb#ModifyDBInstanceMessage": { @@ -5128,7 +5304,7 @@ "DBInstanceClass": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The new compute and memory capacity of the instance; for example,\n db.r5.large. Not all instance classes are available in all AWS\n Regions.

\n

If you modify the instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless ApplyImmediately is\n specified as true for this request.

\n

Default: Uses existing setting.

" + "smithy.api#documentation": "

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Regions.

\n

If you modify the instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless ApplyImmediately is\n specified as true for this request.

\n

Default: Uses existing setting.

" } }, "ApplyImmediately": { @@ -5146,13 +5322,13 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.docdb#BooleanOptional", "traits": { - "smithy.api#documentation": "

Indicates that minor version upgrades are applied automatically to the instance\n during the maintenance window. Changing this parameter doesn't result in an outage\n except in the following case, and the change is asynchronously applied as soon as\n possible. An outage results if this parameter is set to true during the\n maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled\n automatic patching for that engine version.

" + "smithy.api#documentation": "

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

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

The new instance identifier for the instance when renaming an instance. When\n you change the instance identifier, an instance reboot occurs immediately if you set\n Apply Immediately to true. It occurs during the next\n maintenance window if you set Apply Immediately to false. This\n value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

" + "smithy.api#documentation": "

The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

" } }, "CACertificateIdentifier": { @@ -5164,7 +5340,7 @@ "PromotionTier": { "target": "com.amazonaws.docdb#IntegerOptional", "traits": { - "smithy.api#documentation": "

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the\n primary instance after a failure of the existing primary instance.

\n

Default: 1

\n

Valid values: 0-15

" + "smithy.api#documentation": "

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

\n

Default: 1

\n

Valid values: 0-15

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

Modifies an existing subnet group. subnet groups must contain at least one\n subnet in at least two Availability Zones in the AWS Region.

" + "smithy.api#documentation": "

Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region.

" } }, "com.amazonaws.docdb#ModifyDBSubnetGroupMessage": { @@ -5215,7 +5391,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The name for the subnet group. This value is stored as a lowercase string. You\n can't modify the default subnet group.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not\n be default.

\n

Example: mySubnetgroup\n

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

The name for the subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mySubnetgroup\n

", "smithy.api#required": {} } }, @@ -5296,7 +5472,7 @@ "SourceType": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance. If this value is not specified, all events are returned.

\n

Valid values: db-instance, db-parameter-group, db-security-group, db-snapshot\n

" + "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance. If this value is not specified, all events are returned.

\n

Valid values: db-instance, db-parameter-group, db-security-group\n

" } }, "EventCategories": { @@ -5987,6 +6163,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified resource ID was not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -6131,7 +6311,7 @@ "KmsKeyId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

\n

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

\n

If you do not specify a value for the KmsKeyId parameter, then the\n following occurs:

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

The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

\n

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

\n

If you do not specify a value for the KmsKeyId parameter, then the\n following occurs:

\n " } }, "EnableCloudwatchLogsExports": { @@ -6238,7 +6418,7 @@ "RestoreToTime": { "target": "com.amazonaws.docdb#TStamp", "traits": { - "smithy.api#documentation": "

The date and time to restore the cluster to.

\n

Valid values: A time in Universal Coordinated Time (UTC) format.

\n

Constraints:

\n \n

Example: 2015-03-07T23:45:00Z\n

" + "smithy.api#documentation": "

The date and time to restore the cluster to.

\n

Valid values: A time in Universal Coordinated Time (UTC) format.

\n

Constraints:

\n \n

Example: 2015-03-07T23:45:00Z\n

" } }, "UseLatestRestorableTime": { @@ -6274,7 +6454,7 @@ "KmsKeyId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.

\n

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

\n

You can restore to a new cluster and encrypt the new cluster with an AWS KMS key that is different from the AWS KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the AWS KMS key identified by the KmsKeyId parameter.

\n

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

\n \n

If DBClusterIdentifier refers to a cluster that is not encrypted, then\n the restore request is rejected.

" + "smithy.api#documentation": "

The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.

\n

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

\n

You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

\n

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

\n \n

If DBClusterIdentifier refers to a cluster that is not encrypted, then\n the restore request is rejected.

" } }, "EnableCloudwatchLogsExports": { @@ -6310,6 +6490,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSInvalidTopic", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Amazon SNS has responded that there is a problem with the specified topic.

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

You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -6336,6 +6524,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSTopicArnNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The SNS topic Amazon Resource Name (ARN) does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -6349,6 +6541,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SharedSnapshotQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You have exceeded the maximum number of accounts that you can share a manual DB\n snapshot with.

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

The request would cause you to exceed the allowed number of snapshots.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -6384,6 +6584,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SourceNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The requested source could not be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -6514,6 +6718,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "StorageQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request would cause you to exceed the allowed amount of storage available across\n all instances.

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

Storage of the specified StorageType can't be associated with the DB\n instance.

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

The subnet is already in use in the Availability Zone.

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

The provided subscription name already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -6613,6 +6833,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionCategoryNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The provided category does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -6626,6 +6850,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The subscription name does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -6640,13 +6868,13 @@ "Key": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The required name of the tag. The string value can be from 1 to 128 Unicode characters\n in length and can't be prefixed with \"aws:\" or \"rds:\". The string can contain only the\n set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex:\n \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + "smithy.api#documentation": "

The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

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

The optional value of the tag. The string value can be from 1 to 256 Unicode\n characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can contain\n only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java\n regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + "smithy.api#documentation": "

The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" } } }, @@ -6701,7 +6929,7 @@ "AutoUpgrade": { "target": "com.amazonaws.docdb#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether the target version is applied to any source DB\n instances that have AutoMinorVersionUpgrade set to\n true.

" + "smithy.api#documentation": "

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

" } }, "IsMajorVersionUpgrade": { diff --git a/aws/sdk/aws-models/ec2.json b/aws/sdk/aws-models/ec2.json index 5aa50a9d1..4f0424585 100644 --- a/aws/sdk/aws-models/ec2.json +++ b/aws/sdk/aws-models/ec2.json @@ -435,7 +435,7 @@ "target": "com.amazonaws.ec2#InstanceHealthStatus", "traits": { "aws.protocols#ec2QueryName": "InstanceHealth", - "smithy.api#documentation": "

The health status of the instance. If the status of either the instance status check \n or the system status check is impaired, the health status of the instance\n is unhealthy. Otherwise, the health status is healthy.

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

The health status of the instance. If the status of either the instance status check\n or the system status check is impaired, the health status of the instance\n is unhealthy. Otherwise, the health status is healthy.

", "smithy.api#xmlName": "instanceHealth" } } @@ -564,7 +564,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NetworkInterfaceOwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the network interface.

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

The ID of the account that owns the network interface.

", "smithy.api#xmlName": "networkInterfaceOwnerId" } }, @@ -716,7 +716,7 @@ "target": "com.amazonaws.ec2#AdvertiseByoipCidrResult" }, "traits": { - "smithy.api#documentation": "

Advertises an IPv4 or IPv6 address range that is provisioned for use with your AWS resources through \n bring your own IP addresses (BYOIP).

\n

You can perform this operation at most once every 10 seconds, even if you specify different \n address ranges each time.

\n

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise\n it from AWS. To minimize down time, you can configure your AWS resources to use an address from a\n BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current \n location and start advertising it through AWS.

\n

It can take a few minutes before traffic to the specified addresses starts routing to AWS\n because of BGP propagation delays.

\n

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

" + "smithy.api#documentation": "

Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through \n bring your own IP addresses (BYOIP).

\n

You can perform this operation at most once every 10 seconds, even if you specify different \n address ranges each time.

\n

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise\n it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a\n BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current \n location and start advertising it through Amazon Web Services.

\n

It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services\n because of BGP propagation delays.

\n

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

" } }, "com.amazonaws.ec2#AdvertiseByoipCidrRequest": { @@ -774,7 +774,7 @@ "target": "com.amazonaws.ec2#AllocateAddressResult" }, "traits": { - "smithy.api#documentation": "

Allocates an Elastic IP address to your AWS account. After you allocate the Elastic IP address you can associate \n it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address \n pool and can be allocated to a different AWS account.

\n

You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created \n from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own \n IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

\n

[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an \n Elastic IP address that you released after it is allocated to another AWS account. You cannot recover an Elastic IP\n address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.

\n

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate\n 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.

\n

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).

" + "smithy.api#documentation": "

Allocates an Elastic IP address to your account. After you allocate the Elastic IP address you can associate \n it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address \n pool and can be allocated to a different account.

\n

You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created \n from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own \n IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

\n

[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an \n Elastic IP address that you released after it is allocated to another account. You cannot recover an Elastic IP\n address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.

\n

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate\n 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.

\n

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).

" } }, "com.amazonaws.ec2#AllocateAddressRequest": { @@ -842,7 +842,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AllocationId", - "smithy.api#documentation": "

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

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

[EC2-VPC] The ID that Amazon Web Services assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", "smithy.api#xmlName": "allocationId" } }, @@ -1213,6 +1213,9 @@ { "target": "com.amazonaws.ec2#AssociateTransitGatewayRouteTable" }, + { + "target": "com.amazonaws.ec2#AssociateTrunkInterface" + }, { "target": "com.amazonaws.ec2#AssociateVpcCidrBlock" }, @@ -1957,6 +1960,9 @@ { "target": "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachments" }, + { + "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociations" + }, { "target": "com.amazonaws.ec2#DescribeVolumeAttribute" }, @@ -2029,6 +2035,9 @@ { "target": "com.amazonaws.ec2#DisableFastSnapshotRestores" }, + { + "target": "com.amazonaws.ec2#DisableImageDeprecation" + }, { "target": "com.amazonaws.ec2#DisableSerialConsoleAccess" }, @@ -2068,6 +2077,9 @@ { "target": "com.amazonaws.ec2#DisassociateTransitGatewayRouteTable" }, + { + "target": "com.amazonaws.ec2#DisassociateTrunkInterface" + }, { "target": "com.amazonaws.ec2#DisassociateVpcCidrBlock" }, @@ -2077,6 +2089,9 @@ { "target": "com.amazonaws.ec2#EnableFastSnapshotRestores" }, + { + "target": "com.amazonaws.ec2#EnableImageDeprecation" + }, { "target": "com.amazonaws.ec2#EnableSerialConsoleAccess" }, @@ -3690,6 +3705,83 @@ } } }, + "com.amazonaws.ec2#AssociateTrunkInterface": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateTrunkInterfaceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateTrunkInterfaceResult" + }, + "traits": { + "smithy.api#documentation": "

Associates a branch network interface with a trunk network interface.

\n

Before you create the association, run the create-network-interface command and set\n --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.

\n

For more information, see \n Network interface trunking in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#AssociateTrunkInterfaceRequest": { + "type": "structure", + "members": { + "BranchInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

The ID of the branch network interface.

", + "smithy.api#required": {} + } + }, + "TrunkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

The ID of the trunk network interface.

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

The ID of the VLAN. This applies to the VLAN protocol.

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

The application key. This applies to the GRE protocol.

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

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

" + } + } + } + }, + "com.amazonaws.ec2#AssociateTrunkInterfaceResult": { + "type": "structure", + "members": { + "InterfaceAssociation": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociation", + "traits": { + "aws.protocols#ec2QueryName": "InterfaceAssociation", + "smithy.api#documentation": "

Information about the association between the trunk network interface and branch network interface.

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.

", + "smithy.api#xmlName": "clientToken" + } + } + } + }, "com.amazonaws.ec2#AssociateVpcCidrBlock": { "type": "operation", "input": { @@ -5346,7 +5438,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about an address range that is provisioned for use with your AWS resources \n through bring your own IP addresses (BYOIP).

" + "smithy.api#documentation": "

Information about an address range that is provisioned for use with your Amazon Web Services resources \n through bring your own IP addresses (BYOIP).

" } }, "com.amazonaws.ec2#ByoipCidrSet": { @@ -5694,7 +5786,7 @@ "target": "com.amazonaws.ec2#CancelSpotFleetRequestsResponse" }, "traits": { - "smithy.api#documentation": "

Cancels the specified Spot Fleet requests.

\n

After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. \n You must specify whether the Spot Fleet should also terminate its Spot Instances. \n If you terminate the instances, the Spot Fleet request enters the cancelled_terminating state.\n Otherwise, the Spot Fleet request enters the cancelled_running state and the instances \n continue to run until they are interrupted or you terminate them manually.

" + "smithy.api#documentation": "

Cancels the specified Spot Fleet requests.

\n

After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances.\n You must specify whether the Spot Fleet should also terminate its Spot Instances. If you\n terminate the instances, the Spot Fleet request enters the\n cancelled_terminating state. Otherwise, the Spot Fleet request enters\n the cancelled_running state and the instances continue to run until they\n are interrupted or you terminate them manually.

" } }, "com.amazonaws.ec2#CancelSpotFleetRequestsError": { @@ -5761,7 +5853,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "

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

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

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

", "smithy.api#xmlName": "dryRun" } }, @@ -5778,7 +5870,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "TerminateInstances", - "smithy.api#documentation": "

Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.

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

Indicates whether to terminate instances for a Spot Fleet request if it is canceled\n successfully.

", "smithy.api#required": {}, "smithy.api#xmlName": "terminateInstances" } @@ -5889,7 +5981,7 @@ "target": "com.amazonaws.ec2#CancelSpotInstanceRequestsResult" }, "traits": { - "smithy.api#documentation": "

Cancels one or more Spot Instance requests.

\n \n

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

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

Cancels one or more Spot Instance requests.

\n \n

Canceling a Spot Instance request does not terminate running Spot Instances\n associated with the request.

\n " } }, "com.amazonaws.ec2#CancelSpotInstanceRequestsRequest": { @@ -5899,7 +5991,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "

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

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

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

", "smithy.api#xmlName": "dryRun" } }, @@ -5980,7 +6072,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the Capacity Reservation.

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

The ID of the account that owns the Capacity Reservation.

", "smithy.api#xmlName": "ownerId" } }, @@ -6028,7 +6120,7 @@ "target": "com.amazonaws.ec2#CapacityReservationTenancy", "traits": { "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

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

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

\n\t\t ", "smithy.api#xmlName": "tenancy" } }, @@ -6148,7 +6240,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the resource group.

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

The ID of the account that owns the resource group.

", "smithy.api#xmlName": "ownerId" } } @@ -6560,7 +6652,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides authorization for Amazon to bring a specific IP address range to a specific\n AWS account using bring your own IP addresses (BYOIP). For more information, see Prepare to Bring Your Address Range to Your AWS Account in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Provides authorization for Amazon to bring a specific IP address range to a specific\n account using bring your own IP addresses (BYOIP). For more information, see Configuring your BYOIP address range in the Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CidrBlock": { @@ -6714,7 +6806,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances\n with these Classic Load Balancers.

" + "smithy.api#documentation": "

Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers\n the running Spot Instances with these Classic Load Balancers.

" } }, "com.amazonaws.ec2#ClientCertificateRevocationListStatus": { @@ -7751,7 +7843,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The AWS account ID of the instance owner. This is only present if the product code is\n attached to the instance.

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

The account ID of the instance owner. This is only present if the product code is\n attached to the instance.

", "smithy.api#xmlName": "ownerId" } }, @@ -8451,7 +8543,7 @@ "Tenancy": { "target": "com.amazonaws.ec2#CapacityReservationTenancy", "traits": { - "smithy.api#documentation": "

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

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

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

\n\t\t " } }, "InstanceCount": { @@ -9256,7 +9348,7 @@ "Type": { "target": "com.amazonaws.ec2#FleetType", "traits": { - "smithy.api#documentation": "

The type of request. The default value is maintain.

\n \n

For more information, see EC2 Fleet\n request types in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

The fleet type. The default value is maintain.

\n \n

For more information, see EC2 Fleet\n request types in the Amazon EC2 User Guide.

" } }, "ValidFrom": { @@ -9280,9 +9372,15 @@ "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

The key-value pair for tagging the EC2 Fleet request on creation. The value for\n ResourceType must be fleet, otherwise the fleet request fails.\n To tag instances at launch, specify the tags in the launch\n template. For information about tagging after launch, see Tagging your\n resources.

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

The key-value pair for tagging the EC2 Fleet request on creation. For more information, see \n Tagging your resources.

\n

If the fleet type is instant, specify a resource type of fleet \n to tag the fleet or instance to tag the instances at launch.

\n

If the fleet type is maintain or request, specify a resource\n type of fleet to tag the fleet. You cannot specify a resource type of\n instance. To tag instances at launch, specify the tags in a launch template.

", "smithy.api#xmlName": "TagSpecification" } + }, + "Context": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } } } }, @@ -9301,7 +9399,7 @@ "target": "com.amazonaws.ec2#CreateFleetErrorsSet", "traits": { "aws.protocols#ec2QueryName": "ErrorSet", - "smithy.api#documentation": "

Information about the instances that could not be launched by the fleet. Valid only when\n Type is set to instant.

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

Information about the instances that could not be launched by the fleet. Supported only for\n fleets of type instant.

", "smithy.api#xmlName": "errorSet" } }, @@ -9309,7 +9407,7 @@ "target": "com.amazonaws.ec2#CreateFleetInstancesSet", "traits": { "aws.protocols#ec2QueryName": "FleetInstanceSet", - "smithy.api#documentation": "

Information about the instances that were launched by the fleet. Valid only when\n Type is set to instant.

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

Information about the instances that were launched by the fleet. Supported only for\n fleets of type instant.

", "smithy.api#xmlName": "fleetInstanceSet" } } @@ -9529,7 +9627,7 @@ "target": "com.amazonaws.ec2#CreateImageResult" }, "traits": { - "smithy.api#documentation": "

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance \n \tthat is either running or stopped.

\n \n \n \n \t\n \t

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the \n \tnew AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, \n \tthe instance automatically launches with those additional volumes.

\n

For more information, see Creating Amazon EBS-Backed Linux AMIs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance \n \tthat is either running or stopped.

\n \n \n \n \t\n \t

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the \n \tnew AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, \n \tthe instance automatically launches with those additional volumes.

\n

For more information, see Creating Amazon EBS-Backed Linux AMIs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateImageRequest": { @@ -10453,7 +10551,7 @@ "target": "com.amazonaws.ec2#CreateNetworkInterfacePermissionResult" }, "traits": { - "smithy.api#documentation": "

Grants an AWS-authorized account permission to attach the specified network interface to\n an instance in their account.

\n\t\t

You can grant permission to a single AWS account only, and only one account at a time.

" + "smithy.api#documentation": "

Grants an Amazon Web Services-authorized account permission to attach the specified network interface to\n an instance in their account.

\n\t

You can grant permission to a single account only, and only one account at a time.

" } }, "com.amazonaws.ec2#CreateNetworkInterfacePermissionRequest": { @@ -10469,13 +10567,13 @@ "AwsAccountId": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The AWS account ID.

" + "smithy.api#documentation": "

The account ID.

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

The AWS service. Currently not supported.

" + "smithy.api#documentation": "

The Amazon Web Service. Currently not supported.

" } }, "Permission": { @@ -10581,7 +10679,7 @@ "InterfaceType": { "target": "com.amazonaws.ec2#NetworkInterfaceCreationType", "traits": { - "smithy.api#documentation": "

Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify \n\t\t\tefa. For more information, see \n\t\t Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify \n\t\t\tefa. For more information, see \n\t\t\t Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide. To create a trunk network interface, specify \n\t\t efa. For more information, see \n\t\t Network interface trunking in the Amazon Elastic Compute Cloud User Guide.

" } }, "SubnetId": { @@ -11297,7 +11395,7 @@ "target": "com.amazonaws.ec2#CreateSpotDatafeedSubscriptionResult" }, "traits": { - "smithy.api#documentation": "

Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs.\n\t\t\t\tYou can create one data feed per AWS account. For more information, see\n Spot Instance data feed \n in the Amazon EC2 User Guide for Linux Instances.

" + "smithy.api#documentation": "

Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs.\n\t\t\t\tYou can create one data feed per account. For more information, see\n Spot Instance data feed \n in the Amazon EC2 User Guide for Linux Instances.

" } }, "com.amazonaws.ec2#CreateSpotDatafeedSubscriptionRequest": { @@ -11307,7 +11405,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Bucket", - "smithy.api#documentation": "

The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For more information\n about bucket names, see Rules for bucket naming in the Amazon S3 Developer Guide.

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

The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For\n more information about bucket names, see Rules for bucket\n naming in the Amazon S3 Developer Guide.

", "smithy.api#required": {}, "smithy.api#xmlName": "bucket" } @@ -11316,7 +11414,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "

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

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

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

", "smithy.api#xmlName": "dryRun" } }, @@ -15043,7 +15141,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "

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

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

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

", "smithy.api#xmlName": "dryRun" } } @@ -16040,7 +16138,7 @@ "target": "com.amazonaws.ec2#DeprovisionByoipCidrResult" }, "traits": { - "smithy.api#documentation": "

Releases the specified address range that you provisioned for use with your AWS resources\n through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

\n

Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its\n address range.

" + "smithy.api#documentation": "

Releases the specified address range that you provisioned for use with your Amazon Web Services resources\n through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

\n

Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its\n address range.

" } }, "com.amazonaws.ec2#DeprovisionByoipCidrRequest": { @@ -16416,7 +16514,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

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

One or more filters. Filter names and values are case-sensitive.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -16726,7 +16824,7 @@ "target": "com.amazonaws.ec2#DescribeCapacityReservationsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS\n\t\t\tRegion that you're currently using.

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

Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the \n\t\t \tRegion that you're currently using.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -16769,7 +16867,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

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

One or more filters.

\n\t \t ", "smithy.api#xmlName": "Filter" } }, @@ -19321,7 +19419,10 @@ "target": "com.amazonaws.ec2#DescribeImagesResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.

\n

The images available to you include public images, private images that you own, and private images owned by other AWS accounts for which you have explicit launch permissions.

\n

Recently deregistered images appear in the returned results for a short interval and then return empty results. \n After all instances that reference a deregistered AMI are terminated, specifying the ID of the image results\n in an error indicating that the AMI ID cannot be found.

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

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.

\n

The images available to you include public images, private images that you own, and private images owned by other AWS accounts for which you have explicit launch permissions.

\n

Recently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.

", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], "smithy.waiters#waitable": { "ImageAvailable": { "acceptors": [ @@ -19347,6 +19448,27 @@ } ], "minDelay": 15 + }, + "ImageExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(Images[]) > `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidAMIID.NotFound" + } + } + ], + "minDelay": 15 } } } @@ -19382,6 +19504,12 @@ "smithy.api#xmlName": "Owner" } }, + "IncludeDeprecated": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

If true, all deprecated AMIs are included in the response. If\n false, no deprecated AMIs are included in the response. If no value is\n specified, the default value is false.

\n \n

If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false) that you set for this parameter.

\n " + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -19737,7 +19865,31 @@ "items": "InstanceStatuses", "pageSize": "MaxResults" }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], "smithy.waiters#waitable": { + "InstanceStatusOk": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "InstanceStatuses[].InstanceStatus.Status", + "expected": "ok", + "comparator": "allStringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidInstanceID.NotFound" + } + } + ], + "minDelay": 15 + }, "SystemStatusOk": { "acceptors": [ { @@ -19991,7 +20143,82 @@ "items": "Reservations", "pageSize": "MaxResults" }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], "smithy.waiters#waitable": { + "InstanceExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(Reservations[]) > `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidInstanceID.NotFound" + } + } + ], + "minDelay": 5 + }, + "InstanceRunning": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "running", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "shutting-down", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "terminated", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Reservations[].Instances[].State.Name", + "expected": "stopping", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidInstanceID.NotFound" + } + } + ], + "minDelay": 15 + }, "InstanceStopped": { "acceptors": [ { @@ -20071,7 +20298,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

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

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -20302,7 +20529,33 @@ "target": "com.amazonaws.ec2#DescribeKeyPairsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified key pairs or all of your key pairs.

\n

For more information about key pairs, see Key Pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Describes the specified key pairs or all of your key pairs.

\n

For more information about key pairs, see Key Pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "KeyPairExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(KeyPairs[].KeyName) > `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidKeyPair.NotFound" + } + } + ], + "minDelay": 5 + } + } } }, "com.amazonaws.ec2#DescribeKeyPairsRequest": { @@ -21009,7 +21262,7 @@ "target": "com.amazonaws.ec2#DescribeManagedPrefixListsResult" }, "traits": { - "smithy.api#documentation": "

Describes your managed prefix lists and any AWS-managed prefix lists.

\n

To view the entries for your prefix list, use GetManagedPrefixListEntries.

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

Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.

\n

To view the entries for your prefix list, use GetManagedPrefixListEntries.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -21184,6 +21437,62 @@ "outputToken": "NextToken", "items": "NatGateways", "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "NatGatewayAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "NatGateways[].State", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "NatGateways[].State", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "NatGateways[].State", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "NatGateways[].State", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "NatGatewayNotFound" + } + } + ], + "minDelay": 15 + } } } }, @@ -21643,7 +21952,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

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

One or more filters.

\n\t\t ", "smithy.api#xmlName": "Filter" } }, @@ -21703,6 +22012,32 @@ "outputToken": "NextToken", "items": "NetworkInterfaces", "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "NetworkInterfaceAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "NetworkInterfaces[].Status", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "InvalidNetworkInterfaceID.NotFound" + } + } + ], + "minDelay": 20 + } } } }, @@ -21722,7 +22057,7 @@ "target": "com.amazonaws.ec2#FilterList", "traits": { "aws.protocols#ec2QueryName": "Filter", - "smithy.api#documentation": "

One or more filters.

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

One or more filters.

\n\t\t ", "smithy.api#xmlName": "filter" } }, @@ -21851,7 +22186,7 @@ "target": "com.amazonaws.ec2#DescribePrefixListsResult" }, "traits": { - "smithy.api#documentation": "

Describes available AWS services in a prefix list format, which includes the prefix list\n name and prefix list ID of the service and the IP address range for the service.

\n

We recommend that you use DescribeManagedPrefixLists instead.

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

Describes available Amazon Web Services services in a prefix list format, which includes the prefix list\n name and prefix list ID of the service and the IP address range for the service.

\n

We recommend that you use DescribeManagedPrefixLists instead.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -22381,7 +22716,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

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

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -22909,6 +23244,32 @@ "outputToken": "NextToken", "items": "SecurityGroups", "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "SecurityGroupExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(SecurityGroups[].GroupId) > `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidGroup.NotFound" + } + } + ], + "minDelay": 5 + } } } }, @@ -23184,7 +23545,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "

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

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

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

", "smithy.api#xmlName": "dryRun" } } @@ -23237,7 +23598,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "

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

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

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

", "smithy.api#xmlName": "dryRun" } }, @@ -23245,7 +23606,7 @@ "target": "com.amazonaws.ec2#DescribeSpotFleetInstancesMaxResults", "traits": { "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#documentation": "

The maximum number of results to return in a single call. \n Specify a value between 1 and 1000. The default value is 1000. \n To retrieve the remaining results, make another call with the returned\n NextToken value.

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

The maximum number of results to return in a single call. Specify a value between 1\n and 1000. The default value is 1000. To retrieve the remaining results, make another\n call with the returned NextToken value.

", "smithy.api#xmlName": "maxResults" } }, @@ -23286,7 +23647,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token required to retrieve the next set of results. This value is null when there are no more results to return.

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

The token required to retrieve the next set of results. This value is\n null when there are no more results to return.

", "smithy.api#xmlName": "nextToken" } }, @@ -23312,7 +23673,7 @@ "target": "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryResponse" }, "traits": { - "smithy.api#documentation": "

Describes the events for the specified Spot Fleet request during the specified time.

\n

Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query \n by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours.

" + "smithy.api#documentation": "

Describes the events for the specified Spot Fleet request during the specified\n time.

\n

Spot Fleet events are delayed by up to 30 seconds before they can be described. This\n ensures that you can query by the last evaluated time and not miss a recorded event.\n Spot Fleet events are available for 48 hours.

" } }, "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryMaxResults": { @@ -23331,7 +23692,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "

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

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

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

", "smithy.api#xmlName": "dryRun" } }, @@ -23347,7 +23708,7 @@ "target": "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryMaxResults", "traits": { "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#documentation": "

The maximum number of results to return in a single call. \n Specify a value between 1 and 1000. The default value is 1000. \n To retrieve the remaining results, make another call with the returned\n NextToken value.

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

The maximum number of results to return in a single call. Specify a value between 1\n and 1000. The default value is 1000. To retrieve the remaining results, make another\n call with the returned NextToken value.

", "smithy.api#xmlName": "maxResults" } }, @@ -23372,7 +23733,7 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

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

The starting date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", "smithy.api#required": {}, "smithy.api#xmlName": "startTime" } @@ -23397,7 +23758,7 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "LastEvaluatedTime", - "smithy.api#documentation": "

The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).\n All records up to this time were retrieved.

\n

If nextToken indicates that there are more results, this value is not present.

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

The last date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n All records up to this time were retrieved.

\n

If nextToken indicates that there are more results, this value is not\n present.

", "smithy.api#xmlName": "lastEvaluatedTime" } }, @@ -23405,7 +23766,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token required to retrieve the next set of results. This value is null when there are no more results to return.

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

The token required to retrieve the next set of results. This value is\n null when there are no more results to return.

", "smithy.api#xmlName": "nextToken" } }, @@ -23421,7 +23782,7 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

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

The starting date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", "smithy.api#xmlName": "startTime" } } @@ -23439,7 +23800,7 @@ "target": "com.amazonaws.ec2#DescribeSpotFleetRequestsResponse" }, "traits": { - "smithy.api#documentation": "

Describes your Spot Fleet requests.

\n

Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.

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

Describes your Spot Fleet requests.

\n

Spot Fleet requests are deleted 48 hours after they are canceled and their instances\n are terminated.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -23455,7 +23816,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "

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

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

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

", "smithy.api#xmlName": "dryRun" } }, @@ -23463,7 +23824,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#documentation": "

The maximum number of results to return in a single call. \n Specify a value between 1 and 1000. The default value is 1000. \n To retrieve the remaining results, make another call with the returned\n NextToken value.

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

The maximum number of results to return in a single call. Specify a value between 1\n and 1000. The default value is 1000. To retrieve the remaining results, make another\n call with the returned NextToken value.

", "smithy.api#xmlName": "maxResults" } }, @@ -23495,7 +23856,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token required to retrieve the next set of results. This value is null when there are no more results to return.

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

The token required to retrieve the next set of results. This value is\n null when there are no more results to return.

", "smithy.api#xmlName": "nextToken" } }, @@ -23521,12 +23882,88 @@ "target": "com.amazonaws.ec2#DescribeSpotInstanceRequestsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified Spot Instance requests.

\n

You can use DescribeSpotInstanceRequests to find a\n\t\trunning Spot Instance by examining the response. If the status of\n\t\tthe Spot Instance is fulfilled, the instance ID \n\t\tappears in the response and contains the identifier of the instance.\n\t\tAlternatively, you can use DescribeInstances with a filter to\n\t\tlook for instances where the instance lifecycle is spot.

\n

We recommend that you set MaxResults to a value between 5 and 1000 to\n limit the number of results returned. This paginates the output, which makes the list\n more manageable and returns the results faster. If the list of results exceeds your\n MaxResults value, then that number of results is returned along with a\n NextToken value that can be passed to a subsequent\n DescribeSpotInstanceRequests request to retrieve the remaining\n results.

\n\t

Spot Instance requests are deleted four hours after they are canceled and their instances\n are terminated.

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

Describes the specified Spot Instance requests.

\n

You can use DescribeSpotInstanceRequests to find a running Spot Instance by\n examining the response. If the status of the Spot Instance is fulfilled, the\n instance ID appears in the response and contains the identifier of the instance.\n Alternatively, you can use DescribeInstances\n with a filter to look for instances where the instance lifecycle is\n spot.

\n

We recommend that you set MaxResults to a value between 5 and 1000 to\n limit the number of results returned. This paginates the output, which makes the list\n more manageable and returns the results faster. If the list of results exceeds your\n MaxResults value, then that number of results is returned along with a\n NextToken value that can be passed to a subsequent\n DescribeSpotInstanceRequests request to retrieve the remaining\n results.

\n

Spot Instance requests are deleted four hours after they are canceled and their instances are\n terminated.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "SpotInstanceRequests", "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "SpotInstanceRequestFulfilled": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "SpotInstanceRequests[].Status.Code", + "expected": "fulfilled", + "comparator": "allStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "SpotInstanceRequests[].Status.Code", + "expected": "request-canceled-and-instance-running", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "SpotInstanceRequests[].Status.Code", + "expected": "schedule-expired", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "SpotInstanceRequests[].Status.Code", + "expected": "canceled-before-fulfillment", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "SpotInstanceRequests[].Status.Code", + "expected": "bad-parameters", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "SpotInstanceRequests[].Status.Code", + "expected": "system-error", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidSpotInstanceRequestID.NotFound" + } + } + ], + "minDelay": 15 + } } } }, @@ -23536,7 +23973,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

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

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -23544,7 +23981,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "

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

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

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

", "smithy.api#xmlName": "dryRun" } }, @@ -23605,7 +24042,7 @@ "target": "com.amazonaws.ec2#DescribeSpotPriceHistoryResult" }, "traits": { - "smithy.api#documentation": "

Describes the Spot price history. For more information, see\n\t\tSpot Instance pricing history \n in the Amazon EC2 User Guide for Linux Instances.

\n

When you specify a start and end time, the operation returns the prices of the\n instance types within that time range. It also returns the last price change before the\n start time, which is the effective price as of the start time.

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

Describes the Spot price history. For more information, see Spot Instance pricing history in the\n Amazon EC2 User Guide for Linux Instances.

\n

When you specify a start and end time, the operation returns the prices of the\n instance types within that time range. It also returns the last price change before the\n start time, which is the effective price as of the start time.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -23620,7 +24057,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

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

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -23636,7 +24073,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "

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

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

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

", "smithy.api#xmlName": "dryRun" } }, @@ -23644,7 +24081,7 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "EndTime", - "smithy.api#documentation": "

The date and time, up to the current date, from which to stop retrieving the price history data, \n in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

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

The date and time, up to the current date, from which to stop retrieving the price\n history data, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", "smithy.api#xmlName": "endTime" } }, @@ -23659,7 +24096,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#documentation": "

The maximum number of results to return in a single call. \n Specify a value between 1 and 1000. The default value is 1000. \n To retrieve the remaining results, make another call with the returned\n NextToken value.

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

The maximum number of results to return in a single call. Specify a value between 1\n and 1000. The default value is 1000. To retrieve the remaining results, make another\n call with the returned NextToken value.

", "smithy.api#xmlName": "maxResults" } }, @@ -23682,7 +24119,7 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

The date and time, up to the past 90 days, from which to start retrieving the price history data, \n in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

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

The date and time, up to the past 90 days, from which to start retrieving the price\n history data, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", "smithy.api#xmlName": "startTime" } } @@ -24894,6 +25331,85 @@ } } }, + "com.amazonaws.ec2#DescribeTrunkInterfaceAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes one or more network interface trunk associations.

" + } + }, + "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 255 + } + } + }, + "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsRequest": { + "type": "structure", + "members": { + "AssociationIds": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociationIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the associations.

", + "smithy.api#xmlName": "AssociationId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n ", + "smithy.api#xmlName": "Filter" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n To retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + } + }, + "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsResult": { + "type": "structure", + "members": { + "InterfaceAssociations": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociationList", + "traits": { + "aws.protocols#ec2QueryName": "InterfaceAssociationSet", + "smithy.api#documentation": "

Information about the trunk associations.

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

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "smithy.api#xmlName": "nextToken" + } + } + } + }, "com.amazonaws.ec2#DescribeVolumeAttribute": { "type": "operation", "input": { @@ -25056,6 +25572,9 @@ "items": "Volumes", "pageSize": "MaxResults" }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], "smithy.waiters#waitable": { "VolumeAvailable": { "acceptors": [ @@ -25082,6 +25601,27 @@ ], "minDelay": 15 }, + "VolumeDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Volumes[].State", + "expected": "deleted", + "comparator": "allStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "InvalidVolume.NotFound" + } + } + ], + "minDelay": 15 + }, "VolumeInUse": { "acceptors": [ { @@ -25932,6 +26472,49 @@ "outputToken": "NextToken", "items": "VpcPeeringConnections", "pageSize": "MaxResults" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "VpcPeeringConnectionDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "VpcPeeringConnections[].Status.Code", + "expected": "deleted", + "comparator": "allStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "InvalidVpcPeeringConnectionID.NotFound" + } + } + ], + "minDelay": 15 + }, + "VpcPeeringConnectionExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "success": true + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidVpcPeeringConnectionID.NotFound" + } + } + ], + "minDelay": 15 + } } } }, @@ -26020,6 +26603,9 @@ "items": "Vpcs", "pageSize": "MaxResults" }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], "smithy.waiters#waitable": { "VpcAvailable": { "acceptors": [ @@ -26035,6 +26621,23 @@ } ], "minDelay": 15 + }, + "VpcExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "success": true + } + }, + { + "state": "retry", + "matcher": { + "errorType": "InvalidVpcID.NotFound" + } + } + ], + "minDelay": 1 } } } @@ -26952,6 +27555,49 @@ } } }, + "com.amazonaws.ec2#DisableImageDeprecation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableImageDeprecationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableImageDeprecationResult" + }, + "traits": { + "smithy.api#documentation": "

Cancels the deprecation of the specified AMI.

\n

For more information, see Deprecate an AMI in the\n Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#DisableImageDeprecationRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#documentation": "

The ID of the AMI.

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

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

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

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

", + "smithy.api#xmlName": "return" + } + } + } + }, "com.amazonaws.ec2#DisableSerialConsoleAccess": { "type": "operation", "input": { @@ -27518,6 +28164,64 @@ } } }, + "com.amazonaws.ec2#DisassociateTrunkInterface": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateTrunkInterfaceRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateTrunkInterfaceResult" + }, + "traits": { + "smithy.api#documentation": "

Removes an association between a branch network interface with a trunk network interface.

" + } + }, + "com.amazonaws.ec2#DisassociateTrunkInterfaceRequest": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociationId", + "traits": { + "smithy.api#documentation": "

The ID ofthe association

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

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

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

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

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency.

", + "smithy.api#xmlName": "clientToken" + } + } + } + }, "com.amazonaws.ec2#DisassociateVpcCidrBlock": { "type": "operation", "input": { @@ -28897,6 +29601,56 @@ } } }, + "com.amazonaws.ec2#EnableImageDeprecation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableImageDeprecationRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableImageDeprecationResult" + }, + "traits": { + "smithy.api#documentation": "

Enables deprecation of the specified AMI at the specified date and time.

\n

For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "com.amazonaws.ec2#EnableImageDeprecationRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "DeprecateAt": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "smithy.api#documentation": "

The date and time to deprecate the AMI, in UTC, in the following format:\n YYYY-MM-DDTHH:MM:SSZ.\n If you specify a value for seconds, Amazon EC2 rounds the seconds to the\n nearest minute.

\n

You can’t specify a date in the past. The upper limit for DeprecateAt is 10\n years from now.

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

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

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

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

", + "smithy.api#xmlName": "return" + } + } + } + }, "com.amazonaws.ec2#EnableSerialConsoleAccess": { "type": "operation", "input": { @@ -29142,13 +29896,13 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "Enabled", - "smithy.api#documentation": "

If this parameter is set to true, the instance is enabled for AWS Nitro Enclaves; \n \t\totherwise, it is not enabled for AWS Nitro Enclaves.

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

If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves; \n otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.

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

Indicates whether the instance is enabled for AWS Nitro Enclaves.

" + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

" } }, "com.amazonaws.ec2#EnclaveOptionsRequest": { @@ -29157,12 +29911,12 @@ "Enabled": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

To enable the instance for AWS Nitro Enclaves, set this parameter to true.

" + "smithy.api#documentation": "

To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true.

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

Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, \n \t\tsee \n \t\t\tWhat is AWS Nitro Enclaves? in the AWS Nitro Enclaves User Guide.

" + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, \n \t\tsee \n \t\t What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.

" } }, "com.amazonaws.ec2#EndDateType": { @@ -29259,7 +30013,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "EventSubType", - "smithy.api#documentation": "

The event.

\n\n

The following are the error events:

\n \n\n

The following are the fleetRequestChange events:

\n \n\n

The following are the instanceChange events:

\n \n \n

The following are the Information events:

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

The event.

\n\n

The following are the error events:

\n \n\n

The following are the fleetRequestChange events:

\n \n\n

The following are the instanceChange events:

\n \n\n

The following are the Information events:

\n ", "smithy.api#xmlName": "eventSubType" } }, @@ -29267,7 +30021,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance. This information is available only for instanceChange events.

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

The ID of the instance. This information is available only for\n instanceChange events.

", "smithy.api#xmlName": "instanceId" } } @@ -30684,6 +31438,14 @@ "smithy.api#documentation": "

Information about the instances that were launched by the fleet. Valid only when\n Type is set to instant.

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

Reserved.

", + "smithy.api#xmlName": "context" + } } }, "traits": { @@ -30940,7 +31702,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "LaunchTemplateId", - "smithy.api#documentation": "

The ID of the launch template. If you specify the template ID, you can't specify the template name.

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

The ID of the launch template. If you specify the template ID, you can't specify the\n template name.

", "smithy.api#xmlName": "launchTemplateId" } }, @@ -30948,7 +31710,7 @@ "target": "com.amazonaws.ec2#LaunchTemplateName", "traits": { "aws.protocols#ec2QueryName": "LaunchTemplateName", - "smithy.api#documentation": "

The name of the launch template. If you specify the template name, you can't specify the template ID.

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

The name of the launch template. If you specify the template name, you can't specify\n the template ID.

", "smithy.api#xmlName": "launchTemplateName" } }, @@ -30956,13 +31718,13 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Version", - "smithy.api#documentation": "

The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.

\n

If the value is $Latest, Amazon EC2 uses the latest version of the launch template.

\n

If the value is $Default, Amazon EC2 uses the default version of the launch template.

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

The launch template version number, $Latest, or $Default.\n You must specify a value, otherwise the request fails.

\n

If the value is $Latest, Amazon EC2 uses the latest version of the launch\n template.

\n

If the value is $Default, Amazon EC2 uses the default version of the launch\n template.

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

Describes the Amazon EC2 launch template and the launch template version that can be used by\n a Spot Fleet request to configure Amazon EC2 instances. For information about launch templates, see\n Launching an instance from a launch template in the\n Amazon EC2 User Guide for Linux Instances.

" + "smithy.api#documentation": "

Describes the Amazon EC2 launch template and the launch template version that can be used\n by a Spot Fleet request to configure Amazon EC2 instances. For information about launch templates,\n see Launching an instance from a launch template in the\n Amazon EC2 User Guide for Linux Instances.

" } }, "com.amazonaws.ec2#FleetLaunchTemplateSpecificationRequest": { @@ -31823,7 +32585,7 @@ "target": "com.amazonaws.ec2#GetCapacityReservationUsageResult" }, "traits": { - "smithy.api#documentation": "

Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner \n\t\t\tand each AWS account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only \n\t\t\tthe Capacity Reservation owner's usage.

" + "smithy.api#documentation": "

Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner \n\t\t\tand each account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only \n\t\t\tthe Capacity Reservation owner's usage.

" } }, "com.amazonaws.ec2#GetCapacityReservationUsageRequest": { @@ -33484,7 +34246,7 @@ "target": "com.amazonaws.ec2#EventType", "traits": { "aws.protocols#ec2QueryName": "EventType", - "smithy.api#documentation": "

The event type.

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

The event type.

\n ", "smithy.api#xmlName": "eventType" } }, @@ -33492,7 +34254,7 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "Timestamp", - "smithy.api#documentation": "

The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

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

The date and time of the event, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", "smithy.api#xmlName": "timestamp" } } @@ -33670,7 +34432,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the Dedicated Host.

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

The ID of the account that owns the Dedicated Host.

", "smithy.api#xmlName": "ownerId" } }, @@ -33718,7 +34480,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the instance.

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

The ID of the account that owns the instance.

", "smithy.api#xmlName": "ownerId" } } @@ -34544,6 +35306,14 @@ "smithy.api#documentation": "

The boot mode of the image. For more information, see Boot modes in the\n Amazon Elastic Compute Cloud User Guide.

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

The date and time to deprecate the AMI, in UTC, in the following format: \n YYYY-MM-DDTHH:MM:SSZ.\n If you specified a value for seconds, Amazon EC2 rounds the seconds to the\n nearest minute.

", + "smithy.api#xmlName": "deprecationTime" + } } }, "traits": { @@ -36397,7 +37167,7 @@ "target": "com.amazonaws.ec2#EnclaveOptions", "traits": { "aws.protocols#ec2QueryName": "EnclaveOptions", - "smithy.api#documentation": "

Indicates whether the instance is enabled for AWS Nitro Enclaves.

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

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

", "smithy.api#xmlName": "enclaveOptions" } }, @@ -36453,7 +37223,7 @@ "target": "com.amazonaws.ec2#EnclaveOptions", "traits": { "aws.protocols#ec2QueryName": "EnclaveOptions", - "smithy.api#documentation": "

To enable the instance for AWS Nitro Enclaves, set this parameter to true; otherwise, \n\t\tset it to false.

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

To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true; otherwise, \n\t\tset it to false.

", "smithy.api#xmlName": "enclaveOptions" } }, @@ -37255,7 +38025,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account that created the network interface.

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

The ID of the account that created the network interface.

", "smithy.api#xmlName": "ownerId" } }, @@ -37319,7 +38089,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "InterfaceType", - "smithy.api#documentation": "

Describes the type of network interface.

\n\t\t

Valid values: interface | efa\n

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

Describes the type of network interface.

\n\t

Valid values: interface | efa | trunk\n

", "smithy.api#xmlName": "interfaceType" } } @@ -37534,13 +38304,13 @@ "AssociateCarrierIpAddress": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether to assign a carrier IP address to the network interface.

\n

You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the AWS Wavelength Developer Guide.

" + "smithy.api#documentation": "

Indicates whether to assign a carrier IP address to the network interface.

\n

You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. \n For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Web Services Wavelength Developer Guide.

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

The type of network interface.

\n\t

To create an Elastic Fabric Adapter (EFA), specify \n\t\t\tefa. For more information, see Elastic Fabric Adapter in the \n\t\t\tAmazon Elastic Compute Cloud User Guide.

\n\t\t

If you are not creating an EFA, specify interface or omit this parameter.

\n\t\t

Valid values: interface | efa\n

" + "smithy.api#documentation": "

The type of network interface.

\n\t

To create an Elastic Fabric Adapter (EFA), specify \n\t\t\tefa. For more information, see Elastic Fabric Adapter in the \n\t\t\tAmazon Elastic Compute Cloud User Guide.

\n\t\n\t

Valid values: interface | efa\n

" } }, "NetworkCardIndex": { @@ -39390,6 +40160,10 @@ "value": "m5dn.24xlarge", "name": "m5dn_24xlarge" }, + { + "value": "m5dn.metal", + "name": "m5dn_metal" + }, { "value": "m5n.large", "name": "m5n_large" @@ -39422,6 +40196,10 @@ "value": "m5n.24xlarge", "name": "m5n_24xlarge" }, + { + "value": "m5n.metal", + "name": "m5n_metal" + }, { "value": "r5dn.large", "name": "r5dn_large" @@ -39454,6 +40232,10 @@ "value": "r5dn.24xlarge", "name": "r5dn_24xlarge" }, + { + "value": "r5dn.metal", + "name": "r5dn_metal" + }, { "value": "r5n.large", "name": "r5n_large" @@ -39486,6 +40268,10 @@ "value": "r5n.24xlarge", "name": "r5n_24xlarge" }, + { + "value": "r5n.metal", + "name": "r5n_metal" + }, { "value": "inf1.xlarge", "name": "inf1_xlarge" @@ -39895,7 +40681,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AccountId", - "smithy.api#documentation": "

The ID of the AWS account that is making use of the Capacity Reservation.

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

The ID of the account that is making use of the Capacity Reservation.

", "smithy.api#xmlName": "accountId" } }, @@ -39903,7 +40689,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "UsedInstanceCount", - "smithy.api#documentation": "

The number of instances the AWS account currently has in the Capacity Reservation.

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

The number of instances the account currently has in the Capacity Reservation.

", "smithy.api#xmlName": "usedInstanceCount" } } @@ -39954,6 +40740,21 @@ ] } }, + "com.amazonaws.ec2#InterfaceProtocolType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VLAN", + "name": "VLAN" + }, + { + "value": "GRE", + "name": "GRE" + } + ] + } + }, "com.amazonaws.ec2#InternetGateway": { "type": "structure", "members": { @@ -40956,7 +41757,7 @@ "target": "com.amazonaws.ec2#LaunchTemplateOverridesList", "traits": { "aws.protocols#ec2QueryName": "Overrides", - "smithy.api#documentation": "

Any parameters that you specify override the same parameters in the launch template.

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

Any parameters that you specify override the same parameters in the launch\n template.

", "smithy.api#xmlName": "overrides" } } @@ -41846,7 +42647,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance.

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

The maximum price per unit hour that you are willing to pay for a Spot\n Instance.

", "smithy.api#xmlName": "spotPrice" } }, @@ -41878,7 +42679,7 @@ "target": "com.amazonaws.ec2#Double", "traits": { "aws.protocols#ec2QueryName": "Priority", - "smithy.api#documentation": "

The priority for the launch template override. The highest priority is launched\n first.

\n

If OnDemandAllocationStrategy is set to prioritized, Spot Fleet\n uses priority to determine which launch template override to use first in fulfilling\n On-Demand capacity.

\n

If the Spot AllocationStrategy is set to\n capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis\n to determine which launch template override to use in fulfilling Spot capacity,\n but optimizes for capacity first.

\n

Valid values are whole numbers starting at 0. The lower the number, the\n higher the priority. If no number is set, the launch template override has the lowest\n priority. You can set the same priority for different launch template overrides.

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

The priority for the launch template override. The highest priority is launched\n first.

\n

If OnDemandAllocationStrategy is set to prioritized, Spot Fleet\n uses priority to determine which launch template override to use first in fulfilling\n On-Demand capacity.

\n

If the Spot AllocationStrategy is set to\n capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis\n to determine which launch template override to use in fulfilling Spot capacity, but\n optimizes for capacity first.

\n

Valid values are whole numbers starting at 0. The lower the number, the\n higher the priority. If no number is set, the launch template override has the lowest\n priority. You can set the same priority for different launch template overrides.

", "smithy.api#xmlName": "priority" } } @@ -42434,7 +43235,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the Classic Load Balancers and target groups to attach to a Spot Fleet request.

" + "smithy.api#documentation": "

Describes the Classic Load Balancers and target groups to attach to a Spot Fleet\n request.

" } }, "com.amazonaws.ec2#LoadPermission": { @@ -43689,7 +44490,7 @@ "target": "com.amazonaws.ec2#ModifyDefaultCreditSpecificationResult" }, "traits": { - "smithy.api#documentation": "

Modifies the default credit option for CPU usage of burstable performance instances.\n The default credit option is set at the account level per AWS Region, and is specified\n per instance family. All new burstable performance instances in the account launch using\n the default credit option.

\n

\n ModifyDefaultCreditSpecification is an asynchronous operation, which works at an AWS\n Region level and modifies the credit option for each Availability Zone. All zones in a\n Region are updated within five minutes. But if instances are launched during this\n operation, they might not get the new credit option until the zone is updated. To verify\n whether the update has occurred, you can call GetDefaultCreditSpecification and check\n DefaultCreditSpecification for updates.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Modifies the default credit option for CPU usage of burstable performance instances.\n The default credit option is set at the account level per Region, and is specified\n per instance family. All new burstable performance instances in the account launch using\n the default credit option.

\n

\n ModifyDefaultCreditSpecification is an asynchronous operation, which works at an Region \n level and modifies the credit option for each Availability Zone. All zones in a\n Region are updated within five minutes. But if instances are launched during this\n operation, they might not get the new credit option until the zone is updated. To verify\n whether the update has occurred, you can call GetDefaultCreditSpecification and check\n DefaultCreditSpecification for updates.

\n

For more information, see Burstable\n performance instances in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#ModifyDefaultCreditSpecificationRequest": { @@ -43819,6 +44620,12 @@ "traits": { "smithy.api#documentation": "

The size of the EC2 Fleet.

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

Reserved.

" + } } } }, @@ -44280,7 +45087,7 @@ "target": "com.amazonaws.ec2#BlobAttributeValue", "traits": { "aws.protocols#ec2QueryName": "UserData", - "smithy.api#documentation": "

Changes the instance's user data to the specified value. If you are using an AWS SDK\n or command line tool, base64-encoding is performed for you, and you can load the text\n from a file. Otherwise, you must provide base64-encoded text.

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

Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK\n or command line tool, base64-encoding is performed for you, and you can load the text\n from a file. Otherwise, you must provide base64-encoded text.

", "smithy.api#xmlName": "userData" } }, @@ -44933,7 +45740,7 @@ "target": "com.amazonaws.ec2#ModifySpotFleetRequestResponse" }, "traits": { - "smithy.api#documentation": "

Modifies the specified Spot Fleet request.

\n

You can only modify a Spot Fleet request of type maintain.

\n

While the Spot Fleet request is being modified, it is in the modifying state.

\n

To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the\n additional Spot Instances according to the allocation strategy for the Spot Fleet\n request. If the allocation strategy is lowestPrice, the Spot Fleet launches\n instances using the Spot Instance pool with the lowest price. If the allocation strategy\n is diversified, the Spot Fleet distributes the instances across the Spot\n Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet\n launches instances from Spot Instance pools with optimal capacity for the number of instances\n that are launching.

\n

To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet\n cancels any open requests that exceed the new target capacity. You can request that the\n Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the\n new target capacity. If the allocation strategy is lowestPrice, the Spot\n Fleet terminates the instances with the highest price per unit. If the allocation\n strategy is capacityOptimized, the Spot Fleet terminates the instances in\n the Spot Instance pools that have the least available Spot Instance capacity. If the allocation\n strategy is diversified, the Spot Fleet terminates instances across the\n Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet\n at its current size, but not replace any Spot Instances that are interrupted or that you\n terminate manually.

\n

If you are finished with your Spot Fleet for now, but will use it again later, you can set the \n target capacity to 0.

" + "smithy.api#documentation": "

Modifies the specified Spot Fleet request.

\n

You can only modify a Spot Fleet request of type maintain.

\n

While the Spot Fleet request is being modified, it is in the modifying\n state.

\n

To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the\n additional Spot Instances according to the allocation strategy for the Spot Fleet\n request. If the allocation strategy is lowestPrice, the Spot Fleet launches\n instances using the Spot Instance pool with the lowest price. If the allocation strategy\n is diversified, the Spot Fleet distributes the instances across the Spot\n Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet\n launches instances from Spot Instance pools with optimal capacity for the number of instances\n that are launching.

\n

To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet\n cancels any open requests that exceed the new target capacity. You can request that the\n Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the\n new target capacity. If the allocation strategy is lowestPrice, the Spot\n Fleet terminates the instances with the highest price per unit. If the allocation\n strategy is capacityOptimized, the Spot Fleet terminates the instances in\n the Spot Instance pools that have the least available Spot Instance capacity. If the allocation\n strategy is diversified, the Spot Fleet terminates instances across the\n Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet\n at its current size, but not replace any Spot Instances that are interrupted or that you\n terminate manually.

\n

If you are finished with your Spot Fleet for now, but will use it again later, you can\n set the target capacity to 0.

" } }, "com.amazonaws.ec2#ModifySpotFleetRequestRequest": { @@ -44943,14 +45750,14 @@ "target": "com.amazonaws.ec2#ExcessCapacityTerminationPolicy", "traits": { "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", - "smithy.api#documentation": "

Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.

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

Indicates whether running Spot Instances should be terminated if the target capacity\n of the Spot Fleet request is decreased below the current size of the Spot Fleet.

", "smithy.api#xmlName": "excessCapacityTerminationPolicy" } }, "LaunchTemplateConfigs": { "target": "com.amazonaws.ec2#LaunchTemplateConfigList", "traits": { - "smithy.api#documentation": "

The launch template and overrides. You can only use this parameter if you specified a launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you specified LaunchSpecifications in your Spot Fleet request, then omit this parameter.

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

The launch template and overrides. You can only use this parameter if you specified a\n launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you\n specified LaunchSpecifications in your Spot Fleet request, then omit this\n parameter.

", "smithy.api#xmlName": "LaunchTemplateConfig" } }, @@ -44976,6 +45783,12 @@ "traits": { "smithy.api#documentation": "

The number of On-Demand Instances in the fleet.

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

Reserved.

" + } } }, "traits": { @@ -47567,7 +48380,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The AWS account ID of the owner of the network interface.

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

The account ID of the owner of the network interface.

", "smithy.api#xmlName": "ownerId" } }, @@ -47599,7 +48412,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "RequesterId", - "smithy.api#documentation": "

The alias or AWS account ID of the principal or service that created the network interface.

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

The alias or account ID of the principal or service that created the network interface.

", "smithy.api#xmlName": "requesterId" } }, @@ -47607,7 +48420,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "RequesterManaged", - "smithy.api#documentation": "

Indicates whether the network interface is being managed by AWS.

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

Indicates whether the network interface is being managed by Amazon Web Services.

", "smithy.api#xmlName": "requesterManaged" } }, @@ -47775,7 +48588,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "InstanceOwnerId", - "smithy.api#documentation": "

The AWS account ID of the owner of the instance.

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

The account ID of the owner of the instance.

", "smithy.api#xmlName": "instanceOwnerId" } }, @@ -47849,6 +48662,14 @@ { "value": "efa", "name": "efa" + }, + { + "value": "branch", + "name": "branch" + }, + { + "value": "trunk", + "name": "trunk" } ] } @@ -47922,7 +48743,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AwsAccountId", - "smithy.api#documentation": "

The AWS account ID.

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

The account ID.

", "smithy.api#xmlName": "awsAccountId" } }, @@ -47930,7 +48751,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AwsService", - "smithy.api#documentation": "

The AWS service.

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

The Amazon Web Service.

", "smithy.api#xmlName": "awsService" } }, @@ -48111,6 +48932,10 @@ { "value": "efa", "name": "efa" + }, + { + "value": "trunk", + "name": "trunk" } ] } @@ -49311,7 +50136,7 @@ "target": "com.amazonaws.ec2#ValueStringList", "traits": { "aws.protocols#ec2QueryName": "CidrSet", - "smithy.api#documentation": "

The IP address range of the AWS service.

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

The IP address range of the Amazon Web Service.

", "smithy.api#xmlName": "cidrSet" } }, @@ -49333,7 +50158,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes prefixes for AWS services.

" + "smithy.api#documentation": "

Describes prefixes for Amazon Web Services services.

" } }, "com.amazonaws.ec2#PrefixListAssociation": { @@ -49985,7 +50810,7 @@ "target": "com.amazonaws.ec2#ProvisionByoipCidrResult" }, "traits": { - "smithy.api#documentation": "

Provisions an IPv4 or IPv6 address range for use with your AWS resources through bring your own IP \n addresses (BYOIP) and creates a corresponding address pool. After the address range is\n provisioned, it is ready to be advertised using AdvertiseByoipCidr.

\n

AWS verifies that you own the address range and are authorized to advertise it. \n You must ensure that the address range is registered to you and that you created an \n RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. \n For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

\n

Provisioning an address range is an asynchronous operation, so the call returns immediately,\n but the address range is not ready to use until its status changes from pending-provision\n to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. \n To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress \n with either the specific address from the address pool or the ID of the address pool.

" + "smithy.api#documentation": "

Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP \n addresses (BYOIP) and creates a corresponding address pool. After the address range is\n provisioned, it is ready to be advertised using AdvertiseByoipCidr.

\n

Amazon Web Services verifies that you own the address range and are authorized to advertise it. \n You must ensure that the address range is registered to you and that you created an \n RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. \n For more information, see Bring your own IP addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

\n

Provisioning an address range is an asynchronous operation, so the call returns immediately,\n but the address range is not ready to use until its status changes from pending-provision\n to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. \n To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress \n with either the specific address from the address pool or the ID of the address pool.

" } }, "com.amazonaws.ec2#ProvisionByoipCidrRequest": { @@ -50028,6 +50853,12 @@ "smithy.api#documentation": "

The tags to apply to the address pool.

", "smithy.api#xmlName": "PoolTagSpecification" } + }, + "MultiRegion": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Reserved." + } } } }, @@ -50183,7 +51014,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NetworkBorderGroup", - "smithy.api#documentation": "

The name of the location from which the address pool is advertised. A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises public IP addresses.

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

The name of the location from which the address pool is advertised. \n A network border group is a unique set of Availability Zones or Local Zones \n from where Amazon Web Services advertises public IP addresses.

", "smithy.api#xmlName": "networkBorderGroup" } }, @@ -50539,7 +51370,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ReservedInstancesId", - "smithy.api#documentation": "

The IDs of the purchased Reserved Instances.

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

The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted\n pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing\n pricing tiers in the Amazon Elastic Compute Cloud User Guide.

", "smithy.api#xmlName": "reservedInstancesId" } } @@ -51335,7 +52166,7 @@ "target": "com.amazonaws.ec2#ReleaseAddressRequest" }, "traits": { - "smithy.api#documentation": "

Releases the specified Elastic IP address.

\n

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it\n\t\t\t\tfrom any instance that it's associated with. To disassociate an Elastic IP address without\n\t\t\t\treleasing it, use DisassociateAddress.

\n

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address\n\t\t\t before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

\n

After releasing an Elastic IP address, it is released to the IP address pool. \n Be sure to update your DNS records and any servers or devices that communicate with the address. \n If you attempt to release an Elastic IP address that you already released, you'll get an\n AuthFailure error if the address is already allocated to another AWS account.

\n

[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it.\n For more information, see AllocateAddress.

" + "smithy.api#documentation": "

Releases the specified Elastic IP address.

\n

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it\n\t\t\t\tfrom any instance that it's associated with. To disassociate an Elastic IP address without\n\t\t\t\treleasing it, use DisassociateAddress.

\n

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address\n\t\t\t before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

\n

After releasing an Elastic IP address, it is released to the IP address pool. \n Be sure to update your DNS records and any servers or devices that communicate with the address. \n If you attempt to release an Elastic IP address that you already released, you'll get an\n AuthFailure error if the address is already allocated to another account.

\n

[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it.\n For more information, see AllocateAddress.

" } }, "com.amazonaws.ec2#ReleaseAddressRequest": { @@ -52365,7 +53196,7 @@ "target": "com.amazonaws.ec2#RequestSpotFleetResponse" }, "traits": { - "smithy.api#documentation": "

Creates a Spot Fleet request.

\n

The Spot Fleet request specifies the total target capacity and the On-Demand target\n capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand\n capacity, and launches the difference as Spot capacity.

\n

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

\n

By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the\n price per unit is the lowest. Each launch specification can include its own instance\n weighting that reflects the value of the instance type to your application\n workload.

\n

Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.

\n

You can specify tags for the Spot Fleet request and instances launched by the fleet. You\n cannot tag other resource types in a Spot Fleet request because only the\n spot-fleet-request and instance resource types are\n supported.

\n

For more information, see Spot Fleet requests \n in the Amazon EC2 User Guide for Linux Instances.

" + "smithy.api#documentation": "

Creates a Spot Fleet request.

\n

The Spot Fleet request specifies the total target capacity and the On-Demand target\n capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand\n capacity, and launches the difference as Spot capacity.

\n

You can submit a single request that includes multiple launch specifications that vary\n by instance type, AMI, Availability Zone, or subnet.

\n

By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the\n price per unit is the lowest. Each launch specification can include its own instance\n weighting that reflects the value of the instance type to your application\n workload.

\n

Alternatively, you can specify that the Spot Fleet distribute the target capacity\n across the Spot pools included in its launch specifications. By ensuring that the Spot\n Instances in your Spot Fleet are in different Spot pools, you can improve the\n availability of your fleet.

\n

You can specify tags for the Spot Fleet request and instances launched by the fleet.\n You cannot tag other resource types in a Spot Fleet request because only the\n spot-fleet-request and instance resource types are\n supported.

\n

For more information, see Spot Fleet requests\n in the Amazon EC2 User Guide for Linux Instances.

" } }, "com.amazonaws.ec2#RequestSpotFleetRequest": { @@ -52375,7 +53206,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "

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

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

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

", "smithy.api#xmlName": "dryRun" } }, @@ -52418,7 +53249,7 @@ "target": "com.amazonaws.ec2#RequestSpotInstancesResult" }, "traits": { - "smithy.api#documentation": "

Creates a Spot Instance request.

\n

For more information, see Spot Instance requests in the Amazon EC2 User Guide for Linux Instances.

" + "smithy.api#documentation": "

Creates a Spot Instance request.

\n

For more information, see Spot Instance requests in\n the Amazon EC2 User Guide for Linux Instances.

" } }, "com.amazonaws.ec2#RequestSpotInstancesRequest": { @@ -52428,7 +53259,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AvailabilityZoneGroup", - "smithy.api#documentation": "

The user-specified name for a logical grouping of requests.

\n

When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

\n

If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

\n

Default: Instances are launched in any available Availability Zone.

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

The user-specified name for a logical grouping of requests.

\n

When you specify an Availability Zone group in a Spot Instance request, all Spot\n Instances in the request are launched in the same Availability Zone. Instance proximity\n is maintained with this parameter, but the choice of Availability Zone is not. The group\n applies only to requests for Spot Instances of the same instance type. Any additional\n Spot Instance requests that are specified with the same Availability Zone group name are\n launched in that same Availability Zone, as long as at least one instance from the group\n is still active.

\n

If there is no active instance running in the Availability Zone group that you specify\n for a new Spot Instance request (all instances are terminated, the request is expired,\n or the maximum price you specified falls below current Spot price), then Amazon EC2 launches\n the instance in any Availability Zone where the constraint can be met. Consequently, the\n subsequent set of Spot Instances could be placed in a different zone from the original\n request, even if you specified the same Availability Zone group.

\n

Default: Instances are launched in any available Availability Zone.

", "smithy.api#xmlName": "availabilityZoneGroup" } }, @@ -52436,7 +53267,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "BlockDurationMinutes", - "smithy.api#documentation": "

The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

\n

The duration period starts as soon as your Spot Instance receives its instance ID. At\n the end of the duration period, Amazon EC2 marks the Spot Instance for termination and\n provides a Spot Instance termination notice, which gives the instance a two-minute\n warning before it terminates.

\n

You can't specify an Availability Zone group or a launch group if you specify a\n duration.

\n

New accounts or accounts with no previous billing history with AWS are not eligible for\n Spot Instances with a defined duration (also known as Spot blocks).

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

Deprecated.

", "smithy.api#xmlName": "blockDurationMinutes" } }, @@ -52444,7 +53275,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. \n For more information, see How to Ensure Idempotency \n in the Amazon EC2 User Guide for Linux Instances.

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

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to Ensure\n Idempotency in the Amazon EC2 User Guide for Linux Instances.

", "smithy.api#xmlName": "clientToken" } }, @@ -52452,7 +53283,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "

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

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

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

", "smithy.api#xmlName": "dryRun" } }, @@ -52460,7 +53291,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "InstanceCount", - "smithy.api#documentation": "

The maximum number of Spot Instances to launch.

\n

Default: 1

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

The maximum number of Spot Instances to launch.

\n

Default: 1

", "smithy.api#xmlName": "instanceCount" } }, @@ -52468,7 +53299,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "LaunchGroup", - "smithy.api#documentation": "

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

\n

Default: Instances are launched and terminated individually

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

The instance launch group. Launch groups are Spot Instances that launch together and\n terminate together.

\n

Default: Instances are launched and terminated individually

", "smithy.api#xmlName": "launchGroup" } }, @@ -52482,7 +53313,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

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

The maximum price per hour that you are willing to pay for a Spot Instance. The\n default is the On-Demand price.

", "smithy.api#xmlName": "spotPrice" } }, @@ -52490,7 +53321,7 @@ "target": "com.amazonaws.ec2#SpotInstanceType", "traits": { "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The Spot Instance request type.

\n

Default: one-time\n

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

The Spot Instance request type.

\n

Default: one-time\n

", "smithy.api#xmlName": "type" } }, @@ -52498,7 +53329,7 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "ValidFrom", - "smithy.api#documentation": "

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

\n \t

The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.

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

The start date of the request. If this is a one-time request, the request becomes\n active at this date and time and remains active until all instances launch, the request\n expires, or the request is canceled. If the request is persistent, the request becomes\n active at this date and time and remains active until it expires or is canceled.

\n

The specified start date and time cannot be equal to the current date and time. You\n must specify a start date and time that occurs after the current date and time.

", "smithy.api#xmlName": "validFrom" } }, @@ -52506,14 +53337,14 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "ValidUntil", - "smithy.api#documentation": "

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).

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

The end date of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).

\n ", "smithy.api#xmlName": "validUntil" } }, "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "smithy.api#documentation": "

The key-value pair for tagging the Spot Instance request on creation. The value for ResourceType must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see CreateTags.\n

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

The key-value pair for tagging the Spot Instance request on creation. The value for\n ResourceType must be spot-instances-request, otherwise the\n Spot Instance request fails. To tag the Spot Instance request after it has been created,\n see CreateTags.

", "smithy.api#xmlName": "TagSpecification" } }, @@ -52718,7 +53549,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the reservation.

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

The ID of the account that owns the reservation.

", "smithy.api#xmlName": "ownerId" } }, @@ -52726,7 +53557,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "RequesterId", - "smithy.api#documentation": "

The ID of the requester that launched the instances on your behalf (for example, AWS\n Management Console or Auto Scaling).

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

The ID of the requester that launched the instances on your behalf (for example, \n Management Console or Auto Scaling).

", "smithy.api#xmlName": "requesterId" } }, @@ -53463,7 +54294,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "Marketplace", - "smithy.api#documentation": "

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. \n If it's a Reserved Instance Marketplace offering, this is true.

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

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services. \n If it's a Reserved Instance Marketplace offering, this is true.

", "smithy.api#xmlName": "marketplace" } }, @@ -53977,6 +54808,10 @@ "value": "network-insights-analysis", "name": "network_insights_analysis" }, + { + "value": "network-insights-boundary", + "name": "network_insights_boundary" + }, { "value": "network-insights-path", "name": "network_insights_path" @@ -55251,7 +56086,7 @@ "RamdiskId": { "target": "com.amazonaws.ec2#RamdiskId", "traits": { - "smithy.api#documentation": "

The ID of the RAM disk to select. Some kernels require additional drivers at launch.\n Check the kernel requirements for information about whether you need to specify a RAM\n disk. To find kernel requirements, go to the AWS Resource Center and search for the\n kernel ID.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.

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

The ID of the RAM disk to select. Some kernels require additional drivers at launch.\n Check the kernel requirements for information about whether you need to specify a RAM\n disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the\n kernel ID.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.

\n " } }, "SecurityGroupIds": { @@ -55406,7 +56241,7 @@ "HibernationOptions": { "target": "com.amazonaws.ec2#HibernationOptionsRequest", "traits": { - "smithy.api#documentation": "

Indicates whether an instance is enabled for hibernation. For more information, see\n Hibernate\n your instance in the Amazon EC2 User Guide.

\n \t

You can't enable hibernation and AWS Nitro Enclaves on the same instance.

" + "smithy.api#documentation": "

Indicates whether an instance is enabled for hibernation. For more information, see\n Hibernate\n your instance in the Amazon EC2 User Guide.

\n

You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.

" } }, "LicenseSpecifications": { @@ -55425,7 +56260,7 @@ "EnclaveOptions": { "target": "com.amazonaws.ec2#EnclaveOptionsRequest", "traits": { - "smithy.api#documentation": "

Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, \n\t\t\tsee \n\t\t\t\tWhat is AWS Nitro Enclaves? in the AWS Nitro Enclaves User Guide.

\t\t\n\t\t

You can't enable AWS Nitro Enclaves and hibernation on the same instance.

" + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, \n\t\t\tsee \n\t\t\t What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.

\t\t\n\t

You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

" } } } @@ -57690,7 +58525,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The AWS account ID of the account.

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

The account ID of the account.

", "smithy.api#xmlName": "ownerId" } }, @@ -57818,7 +58653,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "RamdiskId", - "smithy.api#documentation": "

The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the AWS Resource Center and search for the kernel ID.

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

The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel \n requirements for information about whether you need to specify a RAM disk. To find kernel \n requirements, refer to the Amazon Web Services Resource Center and search for the kernel ID.

", "smithy.api#xmlName": "ramdiskId" } }, @@ -57864,7 +58699,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the launch specification for one or more Spot Instances. If you include\n On-Demand capacity in your fleet request or want to specify an EFA network device, you can't use\n SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.

" + "smithy.api#documentation": "

Describes the launch specification for one or more Spot Instances. If you include\n On-Demand capacity in your fleet request or want to specify an EFA network device, you\n can't use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.

" } }, "com.amazonaws.ec2#SpotFleetMonitoring": { @@ -57954,7 +58789,7 @@ "target": "com.amazonaws.ec2#OnDemandAllocationStrategy", "traits": { "aws.protocols#ec2QueryName": "OnDemandAllocationStrategy", - "smithy.api#documentation": "

The order of the launch template overrides to use in fulfilling On-Demand capacity.\n If you specify lowestPrice, Spot Fleet uses price to determine the order,\n launching the lowest price first. If you specify prioritized, Spot Fleet uses the\n priority that you assign to each Spot Fleet launch template override, launching the highest\n priority first. If you do not specify a value, Spot Fleet defaults to\n lowestPrice.

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

The order of the launch template overrides to use in fulfilling On-Demand capacity. If\n you specify lowestPrice, Spot Fleet uses price to determine the order, launching\n the lowest price first. If you specify prioritized, Spot Fleet uses the priority\n that you assign to each Spot Fleet launch template override, launching the highest priority\n first. If you do not specify a value, Spot Fleet defaults to lowestPrice.

", "smithy.api#xmlName": "onDemandAllocationStrategy" } }, @@ -57962,7 +58797,7 @@ "target": "com.amazonaws.ec2#SpotMaintenanceStrategies", "traits": { "aws.protocols#ec2QueryName": "SpotMaintenanceStrategies", - "smithy.api#documentation": "

The strategies for managing your Spot Instances that are at an\n elevated risk of being interrupted.

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

The strategies for managing your Spot Instances that are at an elevated risk of being\n interrupted.

", "smithy.api#xmlName": "spotMaintenanceStrategies" } }, @@ -57970,7 +58805,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of\n your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of your\n listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.

", "smithy.api#xmlName": "clientToken" } }, @@ -57978,7 +58813,7 @@ "target": "com.amazonaws.ec2#ExcessCapacityTerminationPolicy", "traits": { "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", - "smithy.api#documentation": "

Indicates whether running Spot Instances should be terminated if you decrease the target\n capacity of the Spot Fleet request below the current size of the Spot Fleet.

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

Indicates whether running Spot Instances should be terminated if you decrease the\n target capacity of the Spot Fleet request below the current size of the Spot\n Fleet.

", "smithy.api#xmlName": "excessCapacityTerminationPolicy" } }, @@ -57986,7 +58821,7 @@ "target": "com.amazonaws.ec2#Double", "traits": { "aws.protocols#ec2QueryName": "FulfilledCapacity", - "smithy.api#documentation": "

The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.

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

The number of units fulfilled by this request compared to the set target capacity. You\n cannot set this value.

", "smithy.api#xmlName": "fulfilledCapacity" } }, @@ -57994,7 +58829,7 @@ "target": "com.amazonaws.ec2#Double", "traits": { "aws.protocols#ec2QueryName": "OnDemandFulfilledCapacity", - "smithy.api#documentation": "

The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.

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

The number of On-Demand units fulfilled by this request compared to the set target\n On-Demand capacity.

", "smithy.api#xmlName": "onDemandFulfilledCapacity" } }, @@ -58002,7 +58837,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "IamFleetRole", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that\n grants the Spot Fleet the permission to request, launch, terminate, and tag instances on\n your behalf. For more information, see Spot\n Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet\n can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using\n CancelSpotFleetRequests or when the Spot Fleet request expires, if\n you set TerminateInstancesWithExpiration.

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

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that\n grants the Spot Fleet the permission to request, launch, terminate, and tag instances on\n your behalf. For more information, see Spot\n Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet\n can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using\n CancelSpotFleetRequests or when the Spot Fleet request expires, if you set\n TerminateInstancesWithExpiration.

", "smithy.api#required": {}, "smithy.api#xmlName": "iamFleetRole" } @@ -58027,7 +58862,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

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

The maximum price per unit hour that you are willing to pay for a Spot Instance. The\n default is the On-Demand price.

", "smithy.api#xmlName": "spotPrice" } }, @@ -58044,7 +58879,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "OnDemandTargetCapacity", - "smithy.api#documentation": "

The number of On-Demand units to request. You can choose to set the target capacity\n in terms of instances or a performance characteristic that is important to your\n application workload, such as vCPUs, memory, or I/O. If the request type is\n maintain, you can specify a target capacity of 0 and add capacity\n later.

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

The number of On-Demand units to request. You can choose to set the target capacity in\n terms of instances or a performance characteristic that is important to your application\n workload, such as vCPUs, memory, or I/O. If the request type is maintain,\n you can specify a target capacity of 0 and add capacity later.

", "smithy.api#xmlName": "onDemandTargetCapacity" } }, @@ -58052,7 +58887,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OnDemandMaxTotalPrice", - "smithy.api#documentation": "

The maximum amount per hour for On-Demand Instances that you're willing to pay. \n You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice\n parameter, or both parameters to ensure that your fleet cost does not exceed \n your budget. If you set a maximum price per hour for the On-Demand Instances and \n Spot Instances in your request, Spot Fleet will launch instances until it reaches\n the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached,\n the fleet stops launching instances even if it hasn’t met the target capacity.

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

The maximum amount per hour for On-Demand Instances that you're willing to pay. You\n can use the onDemandMaxTotalPrice parameter, the\n spotMaxTotalPrice parameter, or both parameters to ensure that your\n fleet cost does not exceed your budget. If you set a maximum price per hour for the\n On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the\n maximum amount you're willing to pay. When the maximum amount you're willing to pay is\n reached, the fleet stops launching instances even if it hasn’t met the target\n capacity.

", "smithy.api#xmlName": "onDemandMaxTotalPrice" } }, @@ -58060,7 +58895,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "SpotMaxTotalPrice", - "smithy.api#documentation": "

The maximum amount per hour for Spot Instances that you're willing to pay.\n You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice\n parameter, or both parameters to ensure that your fleet cost does not exceed \n your budget. If you set a maximum price per hour for the On-Demand Instances and \n Spot Instances in your request, Spot Fleet will launch instances until it reaches\n the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached,\n the fleet stops launching instances even if it hasn’t met the target capacity.

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

The maximum amount per hour for Spot Instances that you're willing to pay. You can use\n the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice\n parameter, or both parameters to ensure that your fleet cost does not exceed your\n budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request,\n Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay.\n When the maximum amount you're willing to pay is reached, the fleet stops launching\n instances even if it hasn’t met the target capacity.

", "smithy.api#xmlName": "spotMaxTotalPrice" } }, @@ -58076,7 +58911,7 @@ "target": "com.amazonaws.ec2#FleetType", "traits": { "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The type of request. Indicates whether the Spot Fleet only requests the target capacity\n or also attempts to maintain it. When this value is request, the Spot Fleet\n only places the required requests. It does not attempt to replenish Spot Instances if\n capacity is diminished, nor does it submit requests in alternative Spot pools if\n capacity is not available. When this value is maintain, the Spot Fleet\n maintains the target capacity. The Spot Fleet places the required requests to meet\n capacity and automatically replenishes any interrupted instances. Default:\n maintain. instant is listed but is not used by Spot\n Fleet.

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

The type of request. Indicates whether the Spot Fleet only requests the target\n capacity or also attempts to maintain it. When this value is request, the\n Spot Fleet only places the required requests. It does not attempt to replenish Spot\n Instances if capacity is diminished, nor does it submit requests in alternative Spot\n pools if capacity is not available. When this value is maintain, the Spot\n Fleet maintains the target capacity. The Spot Fleet places the required requests to meet\n capacity and automatically replenishes any interrupted instances. Default:\n maintain. instant is listed but is not used by Spot\n Fleet.

", "smithy.api#xmlName": "type" } }, @@ -58092,7 +58927,7 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "ValidUntil", - "smithy.api#documentation": "

The end date and time of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n After the end date and time, no new Spot Instance requests are placed or able to fulfill the request.\n If no value is specified, the Spot Fleet request remains until you cancel it.

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

The end date and time of the request, in UTC format\n (YYYY-MM-DDTHH:MM:SSZ).\n After the end date and time, no new Spot Instance requests are placed or able to fulfill\n the request. If no value is specified, the Spot Fleet request remains until you cancel\n it.

", "smithy.api#xmlName": "validUntil" } }, @@ -58108,7 +58943,7 @@ "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", "traits": { "aws.protocols#ec2QueryName": "InstanceInterruptionBehavior", - "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is terminate.

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

The behavior when a Spot Instance is interrupted. The default is\n terminate.

", "smithy.api#xmlName": "instanceInterruptionBehavior" } }, @@ -58116,7 +58951,7 @@ "target": "com.amazonaws.ec2#LoadBalancersConfig", "traits": { "aws.protocols#ec2QueryName": "LoadBalancersConfig", - "smithy.api#documentation": "

One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. \n Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.

\n

With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types:\n C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.

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

One or more Classic Load Balancers and target groups to attach to the Spot Fleet\n request. Spot Fleet registers the running Spot Instances with the specified Classic Load\n Balancers and target groups.

\n

With Network Load Balancers, Spot Fleet cannot register instances that have the\n following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2,\n M3, and T1.

", "smithy.api#xmlName": "loadBalancersConfig" } }, @@ -58124,10 +58959,18 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "InstancePoolsToUseCount", - "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Valid\n only when Spot AllocationStrategy is set to\n lowest-price. Spot Fleet selects the cheapest Spot pools and evenly\n allocates your target Spot capacity across the number of Spot pools that you\n specify.

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

The number of Spot pools across which to allocate your target Spot capacity. Valid\n only when Spot AllocationStrategy is set to\n lowest-price. Spot Fleet selects the cheapest Spot pools and evenly\n allocates your target Spot capacity across the number of Spot pools that you\n specify.

\n

Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of\n pools that you specified.

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

Reserved.

", + "smithy.api#xmlName": "context" + } + }, "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { @@ -58168,7 +59011,7 @@ "target": "com.amazonaws.ec2#ResourceType", "traits": { "aws.protocols#ec2QueryName": "ResourceType", - "smithy.api#documentation": "

The type of resource. Currently, the only resource type that is supported is\n instance. To tag the Spot Fleet request on creation, use the\n TagSpecifications parameter in \n SpotFleetRequestConfigData\n .

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

The type of resource. Currently, the only resource type that is supported is\n instance. To tag the Spot Fleet request on creation, use the\n TagSpecifications parameter in \n SpotFleetRequestConfigData\n .

", "smithy.api#xmlName": "resourceType" } }, @@ -58220,7 +59063,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ActualBlockHourlyPrice", - "smithy.api#documentation": "

If you specified a duration and your Spot Instance request was fulfilled, this is the fixed hourly price in effect for the Spot Instance while it runs.

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

Deprecated.

", "smithy.api#xmlName": "actualBlockHourlyPrice" } }, @@ -58236,7 +59079,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "BlockDurationMinutes", - "smithy.api#documentation": "

The duration for the Spot Instance, in minutes.

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

Deprecated.

", "smithy.api#xmlName": "blockDurationMinutes" } }, @@ -58348,7 +59191,7 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "ValidFrom", - "smithy.api#documentation": "

The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). \n The request becomes active at this date and time.

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

The start date of the request, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).\n The request becomes active at this date and time.

", "smithy.api#xmlName": "validFrom" } }, @@ -58452,7 +59295,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The status code. For a list of status codes, see Spot status codes\n in the Amazon EC2 User Guide for Linux Instances.

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

The status code. For a list of status codes, see Spot status codes in the Amazon EC2 User Guide for Linux Instances.

", "smithy.api#xmlName": "code" } }, @@ -58468,7 +59311,7 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "UpdateTime", - "smithy.api#documentation": "

The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

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

The date and time of the most recent status update, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", "smithy.api#xmlName": "updateTime" } } @@ -58526,7 +59369,7 @@ "BlockDurationMinutes": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The required duration for the Spot Instances (also known as Spot blocks), in minutes.\n This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

\n

The duration period starts as soon as your Spot Instance receives its instance ID. At\n the end of the duration period, Amazon EC2 marks the Spot Instance for termination and\n provides a Spot Instance termination notice, which gives the instance a two-minute\n warning before it terminates.

\n

You can't specify an Availability Zone group or a launch group if you specify a\n duration.

\n

New accounts or accounts with no previous billing history with AWS are not eligible\n for Spot Instances with a defined duration (also known as Spot blocks).

" + "smithy.api#documentation": "

The required duration for the Spot Instances (also known as Spot blocks), in minutes.\n This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

\n

The duration period starts as soon as your Spot Instance receives its instance ID. At\n the end of the duration period, Amazon EC2 marks the Spot Instance for termination and\n provides a Spot Instance termination notice, which gives the instance a two-minute\n warning before it terminates.

\n

You can't specify an Availability Zone group or a launch group if you specify a\n duration.

\n

New accounts or accounts with no previous billing history with Amazon Web Services are not eligible\n for Spot Instances with a defined duration (also known as Spot blocks).

" } }, "ValidUntil": { @@ -58577,7 +59420,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "InstancePoolsToUseCount", - "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Valid only\n when AllocationStrategy is set to\n lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates\n your target Spot capacity across the number of Spot pools that you specify.

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

The number of Spot pools across which to allocate your target Spot capacity. Valid only\n when AllocationStrategy is set to\n lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates\n your target Spot capacity across the number of Spot pools that you specify.

\n

Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of pools\n that you specified.

", "smithy.api#xmlName": "instancePoolsToUseCount" } }, @@ -58642,7 +59485,7 @@ "InstancePoolsToUseCount": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Valid only\n when Spot AllocationStrategy is set to\n lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates\n your target Spot capacity across the number of Spot pools that you specify.

" + "smithy.api#documentation": "

The number of Spot pools across which to allocate your target Spot capacity. Valid only\n when Spot AllocationStrategy is set to\n lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates\n your target Spot capacity across the number of Spot pools that you specify.

\n

Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a\n best effort basis. If a pool runs out of Spot capacity before fulfilling your target\n capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest\n pool. To ensure that your target capacity is met, you might receive Spot Instances from more than\n the number of pools that you specified. Similarly, if most of the pools have no Spot\n capacity, you might receive your full target capacity from fewer than the number of pools\n that you specified.

" } }, "SingleInstanceType": { @@ -58681,7 +59524,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone.

\n

[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, \"us-west-2a, us-west-2b\".

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

The Availability Zone.

\n

[Spot Fleet only] To specify multiple Availability Zones, separate them using commas;\n for example, \"us-west-2a, us-west-2b\".

", "smithy.api#xmlName": "availabilityZone" } }, @@ -58697,7 +59540,7 @@ "target": "com.amazonaws.ec2#Tenancy", "traits": { "aws.protocols#ec2QueryName": "Tenancy", - "smithy.api#documentation": "

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy\n of dedicated runs on single-tenant hardware. The host tenancy is not\n supported for Spot Instances.

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

The tenancy of the instance (if the instance is running in a VPC). An instance with a\n tenancy of dedicated runs on single-tenant hardware. The host\n tenancy is not supported for Spot Instances.

", "smithy.api#xmlName": "tenancy" } } @@ -58745,13 +59588,13 @@ "target": "com.amazonaws.ec2#DateTime", "traits": { "aws.protocols#ec2QueryName": "Timestamp", - "smithy.api#documentation": "

The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

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

The date and time the request was created, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

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

Describes the maximum price per hour that you are willing to pay for a Spot Instance.

" + "smithy.api#documentation": "

Describes the maximum price per hour that you are willing to pay for a Spot\n Instance.

" } }, "com.amazonaws.ec2#SpotPriceHistoryList": { @@ -58902,7 +59745,7 @@ "target": "com.amazonaws.ec2#StartInstancesResult" }, "traits": { - "smithy.api#documentation": "

Starts an Amazon EBS-backed instance that you've previously stopped.

\n

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and\n started. When an instance is stopped, the compute resources are released and you are not\n billed for instance usage. However, your root partition Amazon EBS volume remains and\n continues to persist your data, and you are charged for Amazon EBS volume usage. You can\n restart your instance at any time. Every time you start your Windows instance, Amazon\n EC2 charges you for a full instance hour. If you stop and restart your Windows instance,\n a new instance hour begins and Amazon EC2 charges you for another full instance hour\n even if you are still within the same 60-minute period when it was stopped. Every time\n you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance\n usage, and thereafter charges per second for instance usage.

\n

Before stopping an instance, make sure it is in a state from which it can be\n restarted. Stopping an instance does not preserve data stored in RAM.

\n

Performing this operation on an instance that uses an instance store as its root\n device returns an error.

\n

For more information, see Stopping instances in the\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Starts an Amazon EBS-backed instance that you've previously stopped.

\n

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and\n started. When an instance is stopped, the compute resources are released and you are not\n billed for instance usage. However, your root partition Amazon EBS volume remains and\n continues to persist your data, and you are charged for Amazon EBS volume usage. You can\n restart your instance at any time. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.

\n

Before stopping an instance, make sure it is in a state from which it can be\n restarted. Stopping an instance does not preserve data stored in RAM.

\n

Performing this operation on an instance that uses an instance store as its root\n device returns an error.

\n

For more information, see Stopping instances in the\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#StartInstancesRequest": { @@ -59195,7 +60038,7 @@ "target": "com.amazonaws.ec2#StopInstancesResult" }, "traits": { - "smithy.api#documentation": "

Stops an Amazon EBS-backed instance.

\n

You can use the Stop action to hibernate an instance if the instance is enabled for\n hibernation and it meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.

\n

We don't charge usage for a stopped instance, or data transfer fees; however, your\n root partition Amazon EBS volume remains and continues to persist your data, and you are\n charged for Amazon EBS volume usage. Every time you start your Windows instance, Amazon\n EC2 charges you for a full instance hour. If you stop and restart your Windows instance,\n a new instance hour begins and Amazon EC2 charges you for another full instance hour\n even if you are still within the same 60-minute period when it was stopped. Every time\n you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance\n usage, and thereafter charges per second for instance usage.

\n

You can't stop or hibernate instance store-backed instances. You can't use the Stop\n action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate\n Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.

\n

When you stop or hibernate an instance, we shut it down. You can restart your instance\n at any time. Before stopping or hibernating an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not preserve data stored in RAM,\n but hibernating an instance does preserve data stored in RAM. If an instance cannot\n hibernate successfully, a normal shutdown occurs.

\n

Stopping and hibernating an instance is different to rebooting or terminating it. For\n example, when you stop or hibernate an instance, the root device and any other devices\n attached to the instance persist. When you terminate an instance, the root device and\n any other devices attached during the instance launch are automatically deleted. For\n more information about the differences between rebooting, stopping, hibernating, and\n terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

When you stop an instance, we attempt to shut it down forcibly after a short while. If\n your instance appears stuck in the stopping state after a period of time, there may be\n an issue with the underlying host computer. For more information, see Troubleshooting\n stopping your instance in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Stops an Amazon EBS-backed instance.

\n

You can use the Stop action to hibernate an instance if the instance is enabled for\n hibernation and it meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.

\n

We don't charge usage for a stopped instance, or data transfer fees; however, your\n root partition Amazon EBS volume remains and continues to persist your data, and you are\n charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.

\n

You can't stop or hibernate instance store-backed instances. You can't use the Stop\n action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate\n Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.

\n

When you stop or hibernate an instance, we shut it down. You can restart your instance\n at any time. Before stopping or hibernating an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not preserve data stored in RAM,\n but hibernating an instance does preserve data stored in RAM. If an instance cannot\n hibernate successfully, a normal shutdown occurs.

\n

Stopping and hibernating an instance is different to rebooting or terminating it. For\n example, when you stop or hibernate an instance, the root device and any other devices\n attached to the instance persist. When you terminate an instance, the root device and\n any other devices attached during the instance launch are automatically deleted. For\n more information about the differences between rebooting, stopping, hibernating, and\n terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

When you stop an instance, we attempt to shut it down forcibly after a short while. If\n your instance appears stuck in the stopping state after a period of time, there may be\n an issue with the underlying host computer. For more information, see Troubleshooting\n stopping your instance in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#StopInstancesRequest": { @@ -60043,7 +60886,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances\n with these target groups.

" + "smithy.api#documentation": "

Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the\n running Spot Instances with these target groups.

" } }, "com.amazonaws.ec2#TargetNetwork": { @@ -60299,7 +61142,7 @@ "target": "com.amazonaws.ec2#TerminateInstancesResult" }, "traits": { - "smithy.api#documentation": "

Shuts down the specified instances. This operation is idempotent; if you terminate an\n instance more than once, each call succeeds.

\n

If you specify multiple instances and the request fails (for example, because of a\n single incorrect instance ID), none of the instances are terminated.

\n

Terminated instances remain visible after termination (for approximately one\n hour).

\n

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.

\n

You can stop, start, and terminate EBS-backed instances. You can only terminate\n instance store-backed instances. What happens to an instance differs if you stop it or\n terminate it. For example, when you stop an instance, the root device and any other\n devices attached to the instance persist. When you terminate an instance, any attached\n EBS volumes with the DeleteOnTermination block device mapping parameter set\n to true are automatically deleted. For more information about the\n differences between stopping and terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Shuts down the specified instances. This operation is idempotent; if you terminate an\n instance more than once, each call succeeds.

\n \n

If you specify multiple instances and the request fails (for example, because of a \n single incorrect instance ID), none of the instances are terminated.

\n \n

If you terminate multiple instances across multiple Availability Zones, and one or more \n of the specified instances are enabled for termination protection, the request fails with \n the following results:

\n \n \n

For example, say you have the following instances:

\n \n

If you attempt to terminate all of these instances in the same request, the request reports \n failure with the following results:

\n \n \n \n

Terminated instances remain visible after termination (for approximately one\n hour).

\n

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.

\n

You can stop, start, and terminate EBS-backed instances. You can only terminate\n instance store-backed instances. What happens to an instance differs if you stop it or\n terminate it. For example, when you stop an instance, the root device and any other\n devices attached to the instance persist. When you terminate an instance, any attached\n EBS volumes with the DeleteOnTermination block device mapping parameter set\n to true are automatically deleted. For more information about the\n differences between stopping and terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#TerminateInstancesRequest": { @@ -63131,6 +63974,91 @@ ] } }, + "com.amazonaws.ec2#TrunkInterfaceAssociation": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociationId", + "traits": { + "aws.protocols#ec2QueryName": "AssociationId", + "smithy.api#documentation": "

The ID of the association.

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

The ID of the branch network interface.

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

The ID of the trunk network interface.

", + "smithy.api#xmlName": "trunkInterfaceId" + } + }, + "InterfaceProtocol": { + "target": "com.amazonaws.ec2#InterfaceProtocolType", + "traits": { + "aws.protocols#ec2QueryName": "InterfaceProtocol", + "smithy.api#documentation": "

The interface protocol. Valid values are VLAN and GRE.

", + "smithy.api#xmlName": "interfaceProtocol" + } + }, + "VlanId": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "VlanId", + "smithy.api#documentation": "

The ID of the VLAN when you use the VLAN protocol.

", + "smithy.api#xmlName": "vlanId" + } + }, + "GreKey": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "GreKey", + "smithy.api#documentation": "

The application key when you use the GRE protocol.

", + "smithy.api#xmlName": "greKey" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

The tags.

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

Information about an association between a branch network interface with a trunk network interface.

" + } + }, + "com.amazonaws.ec2#TrunkInterfaceAssociationId": { + "type": "string" + }, + "com.amazonaws.ec2#TrunkInterfaceAssociationIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociationId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TrunkInterfaceAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TrunkInterfaceAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#TunnelInsideIpVersion": { "type": "string", "traits": { @@ -66467,7 +67395,7 @@ "target": "com.amazonaws.ec2#WithdrawByoipCidrResult" }, "traits": { - "smithy.api#documentation": "

Stops advertising an address range that is provisioned as an address pool.

\n

You can perform this operation at most once every 10 seconds, even if you specify different \n address ranges each time.

\n

It can take a few minutes before traffic to the specified addresses stops routing to AWS\n because of BGP propagation delays.

" + "smithy.api#documentation": "

Stops advertising an address range that is provisioned as an address pool.

\n

You can perform this operation at most once every 10 seconds, even if you specify different \n address ranges each time.

\n

It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services\n because of BGP propagation delays.

" } }, "com.amazonaws.ec2#WithdrawByoipCidrRequest": { diff --git a/aws/sdk/aws-models/elasticache.json b/aws/sdk/aws-models/elasticache.json index d788bf66f..4370369d2 100644 --- a/aws/sdk/aws-models/elasticache.json +++ b/aws/sdk/aws-models/elasticache.json @@ -37,6 +37,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "APICallRateForCustomerExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The customer has exceeded the allowed rate of API calls.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -60,7 +64,7 @@ "com.amazonaws.elasticache#AccessString": { "type": "string", "traits": { - "smithy.api#pattern": ".*\\S.*" + "smithy.api#pattern": "\\S" } }, "com.amazonaws.elasticache#AddTagsToResource": { @@ -142,7 +146,7 @@ "min": 1, "max": 4 }, - "smithy.api#pattern": "\\d+" + "smithy.api#pattern": "^\\d+$" } }, "com.amazonaws.elasticache#AllowedNodeTypeModificationsMessage": { @@ -461,6 +465,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified Amazon EC2 security group is already authorized for the specified cache security group.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -474,6 +482,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified Amazon EC2 security group is not authorized for the specified cache security group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -884,6 +896,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "CacheClusterAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You already have a cluster with the given identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -938,6 +954,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "CacheClusterNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The requested cluster ID does not refer to an existing cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -1295,6 +1315,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "CacheParameterGroupAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

A cache parameter group with the requested name already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1357,6 +1381,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "CacheParameterGroupNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The requested cache parameter group name does not refer to an existing cache parameter group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -1370,6 +1398,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "CacheParameterGroupQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request cannot be processed because it would exceed the maximum number of cache security groups.

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

A cache security group with the specified name already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1538,6 +1574,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "CacheSecurityGroupNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The requested cache security group name does not refer to an existing cache security group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -1551,6 +1591,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "QuotaExceeded.CacheSecurityGroup", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request cannot be processed because it would exceed the allowed number of cache security groups.

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

The requested cache subnet group name is already in use by an existing cache subnet group.

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

The requested cache subnet group is currently in use.

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

The requested cache subnet group name does not refer to an existing cache subnet group.

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

The request cannot be processed because it would exceed the allowed number of cache subnet groups.

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

The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

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

The request cannot be processed because it would exceed the allowed number of clusters per customer.

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

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

You must add default user to a user group.

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

A user with this username already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5081,7 +5161,7 @@ "com.amazonaws.elasticache#EngineType": { "type": "string", "traits": { - "smithy.api#pattern": "[a-zA-Z]*" + "smithy.api#pattern": "^[a-zA-Z]*$" } }, "com.amazonaws.elasticache#Event": { @@ -5239,13 +5319,13 @@ "com.amazonaws.elasticache#FilterName": { "type": "string", "traits": { - "smithy.api#pattern": ".*\\S.*" + "smithy.api#pattern": "\\S" } }, "com.amazonaws.elasticache#FilterValue": { "type": "string", "traits": { - "smithy.api#pattern": ".*\\S.*" + "smithy.api#pattern": "\\S" } }, "com.amazonaws.elasticache#FilterValueList": { @@ -5391,6 +5471,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalReplicationGroupAlreadyExistsFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The Global datastore name already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5480,6 +5564,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalReplicationGroupNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The Global datastore does not exist

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -5645,6 +5733,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientCacheClusterCapacity", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The requested cache node type is not available in the specified Availability Zone.\n For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.

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

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

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

The requested cluster is not in the available state.

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

The current state of the cache parameter group does not allow the requested operation to occur.

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

The current state of the cache security group does not allow deletion.

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

The Global datastore is not available or in primary-only state.

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

The KMS key supplied is not valid.

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

Two or more incompatible parameters were specified.

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

The value for a parameter is invalid.

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

The requested replication group is not in the available state.

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

The current state of the snapshot does not allow the requested operation to occur.

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

An invalid subnet identifier was specified.

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

The user group is not in an active state.

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

The user is not in active state.

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

The VPC network is in an invalid state.

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

The operation was not performed because no changes were required.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7229,6 +7381,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "NodeGroupNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The node group specified by the NodeGroupId parameter could not be found.\n Please verify that the node group exists and that you spelled the NodeGroupId value correctly.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -7271,6 +7427,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "NodeGroupsPerReplicationGroupQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request cannot be processed because it would exceed the maximum allowed number\n of node groups (shards) in a single replication group. The default maximum is 90

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

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.

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

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

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

The specified replication group already exists.

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

The targeted replication group is not available.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -8296,6 +8472,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReplicationGroupNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified replication group does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -8309,6 +8489,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReplicationGroupNotUnderMigrationFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The designated replication group is not available for data migration.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -8461,6 +8645,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedCacheNodeAlreadyExists", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

You already have a reservation with the given identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -8503,6 +8691,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedCacheNodeNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The requested reserved cache node was not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -8516,6 +8708,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedCacheNodeQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request cannot be processed because it would exceed the user's cache node quota.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -8614,6 +8810,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedCacheNodesOfferingNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The requested cache node offering does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -8827,6 +9027,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ServiceLinkedRoleNotFoundFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified service linked role (SLR) was not found.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -8929,6 +9133,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ServiceUpdateNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The service update doesn't exist

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -9227,6 +9435,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotAlreadyExistsFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You already have a snapshot with the given name.

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

You attempted one of the following operations:

\n \n

Neither of these are supported by ElastiCache.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -9271,6 +9487,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The requested snapshot name does not refer to an existing snapshot.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -9284,6 +9504,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotQuotaExceededFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request cannot be processed because it would exceed the maximum number of snapshots.

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

The requested subnet is being used by another cache subnet group.

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

At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a\n user sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed on this service.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -9518,6 +9750,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "TagNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The requested tag was not found on this resource.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -9531,6 +9767,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "TagQuotaPerResourceExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

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

The TestFailover action is not available.

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

A user with this ID already exists.

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

The user group with this ID already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -10030,7 +10282,7 @@ "smithy.api#length": { "min": 1 }, - "smithy.api#pattern": "[a-zA-Z][a-zA-Z0-9\\-]*" + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9\\-]*$" } }, "com.amazonaws.elasticache#UserGroupIdList": { @@ -10064,6 +10316,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "UserGroupNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The user group was not found or does not exist

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -10097,6 +10353,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "UserGroupQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The number of users exceeds the user group limit.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -10128,7 +10388,7 @@ "smithy.api#length": { "min": 1 }, - "smithy.api#pattern": "[a-zA-Z][a-zA-Z0-9\\-]*" + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9\\-]*$" } }, "com.amazonaws.elasticache#UserIdList": { @@ -10170,6 +10430,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "UserNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The user does not exist or could not be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -10183,6 +10447,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "UserQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The quota of users has been exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 400 diff --git a/aws/sdk/aws-models/elasticbeanstalk.json b/aws/sdk/aws-models/elasticbeanstalk.json index 4e9bf0310..2943cee0f 100644 --- a/aws/sdk/aws-models/elasticbeanstalk.json +++ b/aws/sdk/aws-models/elasticbeanstalk.json @@ -999,6 +999,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "CodeBuildNotInServiceRegionException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

AWS CodeBuild is not available in the specified region.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3915,6 +3919,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientPrivilegesException", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

The specified account does not have sufficient privileges for one or more AWS\n services.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -3934,6 +3942,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidRequestException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

One or more input parameters is not valid. Please correct the input parameters and try\n the operation again.

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

Cannot modify the managed action in its current state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -4532,7 +4548,7 @@ "com.amazonaws.elasticbeanstalk#NonEmptyString": { "type": "string", "traits": { - "smithy.api#pattern": ".*\\S.*" + "smithy.api#pattern": "\\S" } }, "com.amazonaws.elasticbeanstalk#NullableDouble": { @@ -4570,6 +4586,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "OperationInProgressFailure", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Unable to perform the specified operation because another operation that effects an\n element in this activity is already in progress.

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

You cannot delete the platform version because there are still environments running on it.

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

A resource doesn't exist for the specified Amazon Resource Name (ARN).

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

The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.

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

The specified S3 bucket does not belong to the S3 region in which the service is\n running. The following regions are supported:

\n ", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5476,6 +5512,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "S3SubscriptionRequiredException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified account does not have a subscription to Amazon S3.

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

Unable to delete the Amazon S3 source bundle associated with the application version.\n The application version was deleted successfully.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5700,7 +5744,7 @@ "min": 3, "max": 255 }, - "smithy.api#pattern": ".+/.+" + "smithy.api#pattern": "^.+/.+$" } }, "com.amazonaws.elasticbeanstalk#SourceRepository": { @@ -6002,6 +6046,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "TooManyApplicationsException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified account has reached its limit of applications.

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

The specified account has reached its limit of Amazon S3 buckets.

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

The specified account has reached its limit of configuration templates.

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

The specified account has reached its limit of environments.

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

You have exceeded the maximum number of allowed platforms associated with the account.

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

The number of tags in the resource would exceed the number of tags that each resource\n can have.

\n

To calculate this, the operation considers both the number of tags the resource already has\n and the tags this operation would add if it succeeded.

", "smithy.api#error": "client", "smithy.api#httpError": 400 diff --git a/aws/sdk/aws-models/elasticloadbalancing.json b/aws/sdk/aws-models/elasticloadbalancing.json index f11d0b6a8..52dcb71a4 100644 --- a/aws/sdk/aws-models/elasticloadbalancing.json +++ b/aws/sdk/aws-models/elasticloadbalancing.json @@ -85,6 +85,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "LoadBalancerNotFound", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified load balancer does not exist.

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

The specified ARN does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM) \n or AWS Certificate Manager (ACM). Note that if you recently uploaded the certificate to IAM, this error might \n indicate that the certificate is not fully available yet.

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

A request made by Elastic Load Balancing to another service exceeds the maximum request rate permitted for your account.

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

The specified load balancer name already exists for this account.

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

A listener already exists for the specified load balancer name and port, but with a different instance port, protocol, or SSL certificate.

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

A policy with the specified name already exists for this load balancer.

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

A tag key was specified more than once.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1952,6 +1980,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidConfigurationRequest", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

The requested configuration change is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -1965,6 +1997,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidInstance", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified endpoint is not valid.

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

The specified value for the schema is not valid. You can only specify a scheme for load balancers in a VPC.

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

One or more of the specified security groups do not exist.

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

The specified VPC has no associated Internet gateway.

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

The load balancer does not have a listener configured at the specified port.

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

The specified load balancer attribute does not exist.

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

This operation is not allowed.

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

One or more of the specified policies do not exist.

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

One or more of the specified policy types do not exist.

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

One or more of the specified subnets do not exist.

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

The quota for the number of load balancers has been reached.

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

The quota for the number of policies for this load balancer has been reached.

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

The quota for the number of tags that can be assigned to a load balancer has been reached.

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

The specified protocol or signature version is not supported.

", "smithy.api#error": "client", "smithy.api#httpError": 400 diff --git a/aws/sdk/aws-models/elasticloadbalancingv2.json b/aws/sdk/aws-models/elasticloadbalancingv2.json index bccc3e97a..860dc1ad1 100644 --- a/aws/sdk/aws-models/elasticloadbalancingv2.json +++ b/aws/sdk/aws-models/elasticloadbalancingv2.json @@ -37,6 +37,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ALPNPolicyNotFound", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified ALPN policy is not supported.

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

The specified allocation ID does not exist.

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

The specified Availability Zone is not supported.

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

The specified certificate does not exist.

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

A listener with the specified port already exists.

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

A load balancer with the specified name already exists.

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

A tag key was specified more than once.

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

A target group with the specified name already exists.

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

The health of the specified targets could not be retrieved due to an internal\n error.

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

The specified configuration is not valid with this protocol.

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

The requested configuration is not valid.

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

The requested action is not valid.

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

The requested scheme is not valid.

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

The specified security group does not exist.

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

The specified subnet is out of available addresses.

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

The specified target does not exist, is not in the same VPC as the target group, or has an\n unsupported instance type.

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

The specified listener does not exist.

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

The specified load balancer does not exist.

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

This operation is not allowed.

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

The specified priority is in use.

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

A specified resource is in use.

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

The specified rule does not exist.

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

The specified SSL policy does not exist.

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

The specified subnet does not exist.

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

You've reached the limit on the number of load balancers per target group.

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

The specified target group does not exist.

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

You've reached the limit on the number of actions per rule.

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

You've reached the limit on the number of certificates per load balancer.

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

You've reached the limit on the number of listeners per load balancer.

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

You've reached the limit on the number of load balancers for your AWS account.

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

You've reached the limit on the number of times a target can be registered with a load\n balancer.

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

You've reached the limit on the number of rules per load balancer.

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

You've reached the limit on the number of tags per load balancer.

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

You've reached the limit on the number of target groups for your AWS account.

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

You've reached the limit on the number of targets.

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

You've reached the limit on the number of unique target groups per load balancer across\n all listeners. If a target group is used by multiple actions for a load balancer, it is\n counted as only one use.

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

The specified protocol is not supported.

", "smithy.api#error": "client", "smithy.api#httpError": 400 diff --git a/aws/sdk/aws-models/email.json b/aws/sdk/aws-models/email.json index 23ae72803..0d6a92785 100644 --- a/aws/sdk/aws-models/email.json +++ b/aws/sdk/aws-models/email.json @@ -37,6 +37,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "AccountSendingPausedException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Indicates that email sending is disabled for your entire Amazon SES account.

\n

You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.

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

Indicates that a resource could not be created because of a naming conflict.

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

Indicates that the delete operation could not be completed.

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

Indicates that the configuration set could not be created because of a naming\n conflict.

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

Indicates that the configuration set does not exist.

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

Indicates that email sending is disabled for the configuration set.

\n

You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.

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

Indicates that custom verification email template provided content is invalid.

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

Indicates that a custom verification email template with the name you specified\n already exists.

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

Indicates that a custom verification email template with the name you specified does\n not exist.

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

Indicates that the event destination could not be created because of a naming\n conflict.

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

Indicates that the event destination does not exist.

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

Indicates that the sender address specified for a custom verification email is not\n verified, and is therefore not eligible to send the custom verification email.

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

Indicates that the Amazon CloudWatch destination is invalid. See the error message for\n details.

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

Indicates that the configuration set is invalid. See the error message for\n details.

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

Indicates that provided delivery option is invalid.

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

Indicates that the Amazon Kinesis Firehose destination is invalid. See the error\n message for details.

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

Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could\n not execute the provided function, possibly due to permissions issues. For information\n about giving permissions, see the Amazon SES\n Developer Guide.

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

Indicates that the provided policy is invalid. Check the error stack for more\n information about what caused the error.

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

Indicates that one or more of the replacement values you provided is invalid. This\n error may occur when the TemplateData object contains invalid JSON.

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

Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or\n that Amazon SES could not publish to the bucket, possibly due to permissions issues. For\n information about giving permissions, see the Amazon SES\n Developer Guide.

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

Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is\n invalid. See the error message for details.

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

Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not\n publish to the topic, possibly due to permissions issues. For information about giving\n permissions, see the Amazon SES\n Developer Guide.

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

Indicates that the template that you specified could not be rendered. This issue may\n occur when a template refers to a partial that does not exist.

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

Indicates that the custom domain to be used for open and click tracking redirects is\n invalid. This error appears most often in the following situations:

\n ", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3029,6 +3125,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "LimitExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Indicates that a resource could not be created because of service limits. For a list\n of Amazon SES limits, see the Amazon SES Developer\n Guide.

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

Indicates that the message could not be sent because Amazon SES could not read the MX\n record required to use the specified MAIL FROM domain. For information about editing the\n custom MAIL FROM domain settings for an identity, see the Amazon SES Developer\n Guide.

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

Indicates that the action failed, and the message could not be sent. Check the error\n stack for more information about what caused the error.

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

Indicates that one or more of the replacement values for the specified template was\n not specified. Ensure that the TemplateData object contains references to all of the\n replacement tags in the specified template.

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

Indicates that the account has not been granted production access.

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

Indicates that the provided receipt rule does not exist.

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

Indicates that the provided receipt rule set does not exist.

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

Indicates that the Template object you specified does not exist in your Amazon SES\n account.

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

Indicates that the configuration set you specified already contains a TrackingOptions\n object.

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

Indicates that the TrackingOptions object you specified does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 diff --git a/aws/sdk/aws-models/eventbridge.json b/aws/sdk/aws-models/eventbridge.json index c77e96f96..eff10d113 100644 --- a/aws/sdk/aws-models/eventbridge.json +++ b/aws/sdk/aws-models/eventbridge.json @@ -213,7 +213,7 @@ "min": 12, "max": 12 }, - "smithy.api#pattern": "\\d{12}" + "smithy.api#pattern": "^\\d{12}$" } }, "com.amazonaws.eventbridge#Action": { @@ -223,7 +223,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "events:[a-zA-Z]+" + "smithy.api#pattern": "^events:[a-zA-Z]+$" } }, "com.amazonaws.eventbridge#ActivateEventSource": { @@ -397,7 +397,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.eventbridge#ApiDestinationResponseList": { @@ -504,7 +504,7 @@ "min": 1, "max": 48 }, - "smithy.api#pattern": "[\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.eventbridge#ArchiveResponseList": { @@ -741,6 +741,72 @@ } } }, + "com.amazonaws.eventbridge#CapacityProvider": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.eventbridge#CapacityProviderStrategy": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#CapacityProviderStrategyItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 6 + } + } + }, + "com.amazonaws.eventbridge#CapacityProviderStrategyItem": { + "type": "structure", + "members": { + "capacityProvider": { + "target": "com.amazonaws.eventbridge#CapacityProvider", + "traits": { + "smithy.api#documentation": "

The short name of the capacity provider.

", + "smithy.api#required": {} + } + }, + "weight": { + "target": "com.amazonaws.eventbridge#CapacityProviderStrategyItemWeight", + "traits": { + "smithy.api#documentation": "

The weight value designates the relative percentage of the total number of tasks launched\n that should use the specified capacity provider. The weight value is taken into consideration\n after the base value, if defined, is satisfied.

" + } + }, + "base": { + "target": "com.amazonaws.eventbridge#CapacityProviderStrategyItemBase", + "traits": { + "smithy.api#documentation": "

The base value designates how many tasks, at a minimum, to run on the specified capacity\n provider. Only one capacity provider in a capacity provider strategy can have a base defined.\n If no value is specified, the default value of 0 is used.

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

The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.

" + } + }, + "com.amazonaws.eventbridge#CapacityProviderStrategyItemBase": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100000 + } + } + }, + "com.amazonaws.eventbridge#CapacityProviderStrategyItemWeight": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1000 + } + } + }, "com.amazonaws.eventbridge#ConcurrentModificationException": { "type": "structure", "members": { @@ -844,7 +910,7 @@ "ApiKeyName": { "target": "com.amazonaws.eventbridge#AuthHeaderParameters", "traits": { - "smithy.api#documentation": "

The name of the header to use for the APIKeyValue used for authorization.

" + "smithy.api#documentation": "

The name of the header to use for the APIKeyValue used for\n authorization.

" } } }, @@ -1046,7 +1112,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.eventbridge#ConnectionOAuthClientResponseParameters": { @@ -1470,7 +1536,7 @@ "InvocationHttpParameters": { "target": "com.amazonaws.eventbridge#ConnectionHttpParameters", "traits": { - "smithy.api#documentation": "

A ConnectionHttpParameters object that contains the API key authorization\n parameters to use for the connection. Note that if you include additional parameters for\n the target of a rule via HttpParameters, including query strings, the parameters\n added for the connection take precedence.

" + "smithy.api#documentation": "

A ConnectionHttpParameters object that contains the API key authorization\n parameters to use for the connection. Note that if you include additional parameters for the\n target of a rule via HttpParameters, including query strings, the parameters\n added for the connection take precedence.

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

Deletes the specified rule.

\n

Before you can delete the rule, you must remove all targets, using RemoveTargets.

\n\n

When you delete a rule, incoming events might continue to match to the deleted rule. Allow\n a short period of time for changes to take effect.

\n\n

Managed rules are rules created and managed by another AWS service on your behalf. These\n rules are created by those other AWS services to support functionality in those services. You\n can delete these rules using the Force option, but you should do so only if you\n are sure the other service is not still using that rule.

" + "smithy.api#documentation": "

Deletes the specified rule.

\n

Before you can delete the rule, you must remove all targets, using RemoveTargets.

\n\n

When you delete a rule, incoming events might continue to match to the deleted rule. Allow\n a short period of time for changes to take effect.

\n\n

If you call delete rule multiple times for the same rule, all calls will succeed. When you\n call delete rule for a non-existent custom eventbus, ResourceNotFoundException is\n returned.

\n\n

Managed rules are rules created and managed by another AWS service on your behalf. These\n rules are created by those other AWS services to support functionality in those services. You\n can delete these rules using the Force option, but you should do so only if you\n are sure the other service is not still using that rule.

" } }, "com.amazonaws.eventbridge#DeleteRuleRequest": { @@ -2939,6 +3005,54 @@ "traits": { "smithy.api#documentation": "

Specifies an ECS task group for the task. The maximum length is 255 characters.

" } + }, + "CapacityProviderStrategy": { + "target": "com.amazonaws.eventbridge#CapacityProviderStrategy", + "traits": { + "smithy.api#documentation": "

The capacity provider strategy to use for the task.

\n

If a capacityProviderStrategy is specified, the launchType\n parameter must be omitted. If no capacityProviderStrategy or launchType is\n specified, the defaultCapacityProviderStrategy for the cluster is used.

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

Specifies whether to enable Amazon ECS managed tags for the task. For more information,\n see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer\n Guide.

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

Whether or not to enable the execute command functionality for the containers in this\n task. If true, this enables execute command functionality on all containers in the\n task.

" + } + }, + "PlacementConstraints": { + "target": "com.amazonaws.eventbridge#PlacementConstraints", + "traits": { + "smithy.api#documentation": "

An array of placement constraint objects to use for the task. You can specify up to 10\n constraints per task (including constraints in the task definition and those specified at\n runtime).

" + } + }, + "PlacementStrategy": { + "target": "com.amazonaws.eventbridge#PlacementStrategies", + "traits": { + "smithy.api#documentation": "

The placement strategy objects to use for the task. You can specify a maximum of five\n strategy rules per task.

" + } + }, + "PropagateTags": { + "target": "com.amazonaws.eventbridge#PropagateTags", + "traits": { + "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition to the task. If no value\n is specified, the tags are not propagated. Tags can only be propagated to the task during task\n creation. To add tags to a task after task creation, use the TagResource API action.

" + } + }, + "ReferenceId": { + "target": "com.amazonaws.eventbridge#ReferenceId", + "traits": { + "smithy.api#documentation": "

The reference ID to use for the task.

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

The metadata that you apply to the task to help you categorize and organize them. Each tag\n consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.

" + } } }, "traits": { @@ -3015,7 +3129,7 @@ } }, "traits": { - "smithy.api#documentation": "

An event bus receives events from a source and routes them to rules associated with that\n event bus. Your account's default event bus receives rules from AWS services. A custom event\n bus can receive rules from AWS services as well as your custom applications and services. A\n partner event bus receives events from an event source created by an SaaS partner. These\n events come from the partners services or applications.

" + "smithy.api#documentation": "

An event bus receives events from a source and routes them to rules associated with that\n event bus. Your account's default event bus receives events from AWS services. A custom event\n bus can receive events from your custom applications and services. A partner event bus\n receives events from an event source created by an SaaS partner. These events come from the\n partners services or applications.

" } }, "com.amazonaws.eventbridge#EventBusList": { @@ -3031,7 +3145,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "[/\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^[/\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.eventbridge#EventBusNameOrArn": { @@ -3041,7 +3155,7 @@ "min": 1, "max": 1600 }, - "smithy.api#pattern": "(arn:aws[\\w-]*:events:[a-z]{2}-[a-z]+-[\\w-]+:[0-9]{12}:event-bus\\/)?[/\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^(arn:aws[\\w-]*:events:[a-z]{2}-[a-z]+-[\\w-]+:[0-9]{12}:event-bus\\/)?[/\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.eventbridge#EventId": { @@ -3116,7 +3230,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "aws\\.partner(/[\\.\\-_A-Za-z0-9]+){2,}" + "smithy.api#pattern": "^aws\\.partner(/[\\.\\-_A-Za-z0-9]+){2,}$" } }, "com.amazonaws.eventbridge#EventSourceNamePrefix": { @@ -3126,7 +3240,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "[/\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^[/\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.eventbridge#EventSourceState": { @@ -3186,13 +3300,13 @@ "PathParameterValues": { "target": "com.amazonaws.eventbridge#PathParameterList", "traits": { - "smithy.api#documentation": "

The path parameter values to be used to populate API Gateway REST API or \n EventBridge ApiDestination path wildcards (\"*\").

" + "smithy.api#documentation": "

The path parameter values to be used to populate API Gateway REST API or EventBridge\n ApiDestination path wildcards (\"*\").

" } }, "HeaderParameters": { "target": "com.amazonaws.eventbridge#HeaderParametersMap", "traits": { - "smithy.api#documentation": "

The headers that need to be sent as part of request invoking the API Gateway REST\n API or EventBridge ApiDestination.

" + "smithy.api#documentation": "

The headers that need to be sent as part of request invoking the API Gateway REST API or\n EventBridge ApiDestination.

" } }, "QueryStringParameters": { @@ -3203,7 +3317,7 @@ } }, "traits": { - "smithy.api#documentation": "

These are custom parameter to be used when the target is an API Gateway REST APIs\n or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters\n specified on the Connection, with any values from the Connection taking precedence.

" + "smithy.api#documentation": "

These are custom parameter to be used when the target is an API Gateway REST APIs or\n EventBridge ApiDestinations. In the latter case, these are merged with any\n InvocationParameters specified on the Connection, with any values from the Connection taking\n precedence.

" } }, "com.amazonaws.eventbridge#HttpsEndpoint": { @@ -3240,7 +3354,7 @@ "InputTemplate": { "target": "com.amazonaws.eventbridge#TransformerInput", "traits": { - "smithy.api#documentation": "

Input template where you specify placeholders that will be filled with the values of the\n keys from InputPathsMap to customize the data sent to the target. Enclose each\n InputPathsMaps value in brackets: <value> The\n InputTemplate must be valid JSON.

\n\n

If InputTemplate is a JSON object (surrounded by curly braces), the following\n restrictions apply:

\n \n

The following example shows the syntax for using InputPathsMap and\n InputTemplate.

\n

\n \"InputTransformer\":\n

\n

\n {\n

\n

\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n

\n

\n \"InputTemplate\": \" is in state \"\n

\n

\n }\n

\n

To have the InputTemplate include quote marks within a JSON string, escape\n each quote marks with a slash, as in the following example:

\n

\n \"InputTransformer\":\n

\n

\n {\n

\n

\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n

\n

\n \"InputTemplate\": \" is in state \\\"\\\"\"\n

\n

\n }\n

\n

The InputTemplate can also be valid JSON with varibles in quotes or out,\n as in the following example:

\n

\n \"InputTransformer\":\n

\n

\n {\n

\n

\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n

\n

\n \"InputTemplate\": '{\"myInstance\": ,\"myStatus\":\n \" is in state \\\"\\\"\"}'\n

\n

\n }\n

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

Input template where you specify placeholders that will be filled with the values of the\n keys from InputPathsMap to customize the data sent to the target. Enclose each\n InputPathsMaps value in brackets: <value> The\n InputTemplate must be valid JSON.

\n\n

If InputTemplate is a JSON object (surrounded by curly braces), the following\n restrictions apply:

\n \n

The following example shows the syntax for using InputPathsMap and\n InputTemplate.

\n

\n \"InputTransformer\":\n

\n

\n {\n

\n

\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n

\n

\n \"InputTemplate\": \" is in state \"\n

\n

\n }\n

\n

To have the InputTemplate include quote marks within a JSON string, escape\n each quote marks with a slash, as in the following example:

\n

\n \"InputTransformer\":\n

\n

\n {\n

\n

\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n

\n

\n \"InputTemplate\": \" is in state \\\"\\\"\"\n

\n

\n }\n

\n

The InputTemplate can also be valid JSON with varibles in quotes or out, as\n in the following example:

\n

\n \"InputTransformer\":\n

\n

\n {\n

\n

\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n

\n

\n \"InputTemplate\": '{\"myInstance\": ,\"myStatus\": \" is\n in state \\\"\\\"\"}'\n

\n

\n }\n

", "smithy.api#required": {} } } @@ -3256,7 +3370,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "[A-Za-z0-9\\_\\-]+" + "smithy.api#pattern": "^[A-Za-z0-9\\_\\-]+$" } }, "com.amazonaws.eventbridge#Integer": { @@ -4188,7 +4302,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "[\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.eventbridge#NonPartnerEventBusNameOrArn": { @@ -4198,7 +4312,7 @@ "min": 1, "max": 1600 }, - "smithy.api#pattern": "(arn:aws[\\w-]*:events:[a-z]{2}-[a-z]+-[\\w-]+:[0-9]{12}:event-bus\\/)?[\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^(arn:aws[\\w-]*:events:[a-z]{2}-[a-z]+-[\\w-]+:[0-9]{12}:event-bus\\/)?[\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.eventbridge#OperationDisabledException": { @@ -4284,13 +4398,13 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "aws\\.partner/[\\.\\-_A-Za-z0-9]+/[/\\.\\-_A-Za-z0-9]*" + "smithy.api#pattern": "^aws\\.partner/[\\.\\-_A-Za-z0-9]+/[/\\.\\-_A-Za-z0-9]*$" } }, "com.amazonaws.eventbridge#PathParameter": { "type": "string", "traits": { - "smithy.api#pattern": "^(?!\\s*$).+" + "smithy.api#pattern": "^(?!\\s*$).+$" } }, "com.amazonaws.eventbridge#PathParameterList": { @@ -4299,6 +4413,122 @@ "target": "com.amazonaws.eventbridge#PathParameter" } }, + "com.amazonaws.eventbridge#PlacementConstraint": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.eventbridge#PlacementConstraintType", + "traits": { + "smithy.api#documentation": "

The type of constraint. Use distinctInstance to ensure that each task in a particular\n group is running on a different container instance. Use memberOf to restrict the selection to\n a group of valid candidates.

" + } + }, + "expression": { + "target": "com.amazonaws.eventbridge#PlacementConstraintExpression", + "traits": { + "smithy.api#documentation": "

A cluster query language expression to apply to the constraint. You cannot specify an\n expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.\n

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

An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer\n Guide.

" + } + }, + "com.amazonaws.eventbridge#PlacementConstraintExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.eventbridge#PlacementConstraintType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "distinctInstance", + "name": "DISTINCT_INSTANCE" + }, + { + "value": "memberOf", + "name": "MEMBER_OF" + } + ] + } + }, + "com.amazonaws.eventbridge#PlacementConstraints": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#PlacementConstraint" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.eventbridge#PlacementStrategies": { + "type": "list", + "member": { + "target": "com.amazonaws.eventbridge#PlacementStrategy" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.eventbridge#PlacementStrategy": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.eventbridge#PlacementStrategyType", + "traits": { + "smithy.api#documentation": "

The type of placement strategy. The random placement strategy randomly places tasks on\n available candidates. The spread placement strategy spreads placement across available\n candidates evenly based on the field parameter. The binpack strategy places tasks on available\n candidates that have the least available amount of the resource that is specified with the\n field parameter. For example, if you binpack on memory, a task is placed on the instance with\n the least amount of remaining memory (but still enough to run the task).

" + } + }, + "field": { + "target": "com.amazonaws.eventbridge#PlacementStrategyField", + "traits": { + "smithy.api#documentation": "

The field to apply the placement strategy against. For the spread placement strategy,\n valid values are instanceId (or host, which has the same effect), or any platform or custom\n attribute that is applied to a container instance, such as attribute:ecs.availability-zone.\n For the binpack placement strategy, valid values are cpu and memory. For the random placement\n strategy, this field is not used.

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

The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Developer\n Guide.

" + } + }, + "com.amazonaws.eventbridge#PlacementStrategyField": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.eventbridge#PlacementStrategyType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "random", + "name": "RANDOM" + }, + { + "value": "spread", + "name": "SPREAD" + }, + { + "value": "binpack", + "name": "BINPACK" + } + ] + } + }, "com.amazonaws.eventbridge#PolicyLengthExceededException": { "type": "structure", "members": { @@ -4318,7 +4548,18 @@ "min": 1, "max": 12 }, - "smithy.api#pattern": "(\\d{12}|\\*)" + "smithy.api#pattern": "^(\\d{12}|\\*)$" + } + }, + "com.amazonaws.eventbridge#PropagateTags": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TASK_DEFINITION", + "name": "TASK_DEFINITION" + } + ] } }, "com.amazonaws.eventbridge#PutEvents": { @@ -4392,7 +4633,7 @@ "TraceHeader": { "target": "com.amazonaws.eventbridge#TraceHeader", "traits": { - "smithy.api#documentation": "

An AWS X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event.

\n

To learn more about X-Ray trace headers, see Tracing header in the AWS X-Ray Developer Guide.

" + "smithy.api#documentation": "

An AWS X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the\n trace-id associated with the event.

\n

To learn more about X-Ray trace headers, see Tracing header in the AWS X-Ray Developer Guide.

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

Adds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n

You can configure the following as targets for Events:

\n\n \n\n\n\n

Creating rules with built-in targets is supported only in the AWS Management Console. The\n built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API\n call, EC2 StopInstances API call, and EC2 TerminateInstances API\n call.

\n\n

For some target types, PutTargets provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event goes to by\n using the KinesisParameters argument. To invoke a command on multiple EC2\n instances with one rule, you can use the RunCommandParameters field.

\n\n

To be able to make API calls against the resources that you own, Amazon EventBridge\n (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS\n resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data\n streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on\n IAM roles that you specify in the RoleARN argument in PutTargets.\n For more information, see Authentication\n and Access Control in the Amazon EventBridge User Guide.

\n\n

If another AWS account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's event\n bus as a target of the rules in your account. To send the matched events to the other account,\n specify that account's event bus as the Arn value when you run\n PutTargets. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge (CloudWatch Events)\n Pricing.

\n\n \n

\n Input, InputPath, and InputTransformer are not\n available with PutTarget if the target is an event bus of a different AWS\n account.

\n \n\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between AWS Accounts in the Amazon EventBridge User\n Guide.

\n\n

For more information about enabling cross-account events, see PutPermission.

\n\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:

\n\n \n\n

When you specify InputPath or InputTransformer, you must use\n JSON dot notation, not bracket notation.

\n\n

When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.

\n\n

This action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.

" + "smithy.api#documentation": "

Adds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n

You can configure the following as targets for Events:

\n\n \n\n

Creating rules with built-in targets is supported only in the AWS Management Console. The\n built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API\n call, EC2 StopInstances API call, and EC2 TerminateInstances API\n call.

\n\n

For some target types, PutTargets provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event goes to by\n using the KinesisParameters argument. To invoke a command on multiple EC2\n instances with one rule, you can use the RunCommandParameters field.

\n\n

To be able to make API calls against the resources that you own, Amazon EventBridge\n (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS\n resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data\n streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on\n IAM roles that you specify in the RoleARN argument in PutTargets.\n For more information, see Authentication\n and Access Control in the Amazon EventBridge User Guide.

\n\n

If another AWS account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's event\n bus as a target of the rules in your account. To send the matched events to the other account,\n specify that account's event bus as the Arn value when you run\n PutTargets. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge (CloudWatch Events)\n Pricing.

\n\n \n

\n Input, InputPath, and InputTransformer are not\n available with PutTarget if the target is an event bus of a different AWS\n account.

\n \n\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between AWS Accounts in the Amazon EventBridge User\n Guide.

\n\n

For more information about enabling cross-account events, see PutPermission.

\n\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:

\n\n \n\n

When you specify InputPath or InputTransformer, you must use\n JSON dot notation, not bracket notation.

\n\n

When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.

\n\n

This action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.

" } }, "com.amazonaws.eventbridge#PutTargetsRequest": { @@ -4866,7 +5107,7 @@ "min": 0, "max": 512 }, - "smithy.api#pattern": "[^\\x00-\\x1F\\x7F]+" + "smithy.api#pattern": "^[^\\x00-\\x1F\\x7F]+$" } }, "com.amazonaws.eventbridge#QueryStringParametersMap": { @@ -4885,7 +5126,7 @@ "min": 0, "max": 512 }, - "smithy.api#pattern": "[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+" + "smithy.api#pattern": "^[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+$" } }, "com.amazonaws.eventbridge#RedshiftDataParameters": { @@ -4941,7 +5182,16 @@ "min": 1, "max": 1600 }, - "smithy.api#pattern": "(^arn:aws([a-z]|\\-)*:secretsmanager:[a-z0-9-.]+:.*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)" + "smithy.api#pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:[a-z0-9-.]+:.*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$" + } + }, + "com.amazonaws.eventbridge#ReferenceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } } }, "com.amazonaws.eventbridge#RemovePermission": { @@ -5218,7 +5468,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.eventbridge#ReplayState": { @@ -5420,7 +5670,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.eventbridge#RuleNameList": { @@ -5750,7 +6000,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[a-zA-Z0-9-_]+" + "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" } }, "com.amazonaws.eventbridge#StatementName": { @@ -5946,7 +6196,7 @@ "HttpParameters": { "target": "com.amazonaws.eventbridge#HttpParameters", "traits": { - "smithy.api#documentation": "

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint \n or EventBridge ApiDestination.

\n

If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you \n can use this parameter to specify headers, path parameters, and query string keys/values \n as part of your target invoking request. If you're using ApiDestinations, the corresponding\n Connection can also have these values configured. In case of any conflicting keys, values\n from the Connection take precedence.

" + "smithy.api#documentation": "

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or\n EventBridge ApiDestination.

\n

If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can\n use this parameter to specify headers, path parameters, and query string keys/values as part\n of your target invoking request. If you're using ApiDestinations, the corresponding Connection\n can also have these values configured. In case of any conflicting keys, values from the\n Connection take precedence.

" } }, "RedshiftDataParameters": { @@ -5994,7 +6244,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.eventbridge#TargetIdList": { @@ -6157,7 +6407,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge\n (CloudWatch Events, rules and event buses can be tagged.

" + "smithy.api#documentation": "

Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge\n (CloudWatch Events), rules and event buses can be tagged.

" } }, "com.amazonaws.eventbridge#UntagResourceRequest": { diff --git a/aws/sdk/aws-models/events.json b/aws/sdk/aws-models/events.json index e7c25d038..0c95f26bd 100644 --- a/aws/sdk/aws-models/events.json +++ b/aws/sdk/aws-models/events.json @@ -213,7 +213,7 @@ "min": 12, "max": 12 }, - "smithy.api#pattern": "\\d{12}" + "smithy.api#pattern": "^\\d{12}$" } }, "com.amazonaws.cloudwatchevents#Action": { @@ -223,7 +223,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "events:[a-zA-Z]+" + "smithy.api#pattern": "^events:[a-zA-Z]+$" } }, "com.amazonaws.cloudwatchevents#ActivateEventSource": { @@ -397,7 +397,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.cloudwatchevents#ApiDestinationResponseList": { @@ -504,7 +504,7 @@ "min": 1, "max": 48 }, - "smithy.api#pattern": "[\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.cloudwatchevents#ArchiveResponseList": { @@ -741,6 +741,72 @@ } } }, + "com.amazonaws.cloudwatchevents#CapacityProvider": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.cloudwatchevents#CapacityProviderStrategy": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchevents#CapacityProviderStrategyItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 6 + } + } + }, + "com.amazonaws.cloudwatchevents#CapacityProviderStrategyItem": { + "type": "structure", + "members": { + "capacityProvider": { + "target": "com.amazonaws.cloudwatchevents#CapacityProvider", + "traits": { + "smithy.api#documentation": "

The short name of the capacity provider.

", + "smithy.api#required": {} + } + }, + "weight": { + "target": "com.amazonaws.cloudwatchevents#CapacityProviderStrategyItemWeight", + "traits": { + "smithy.api#documentation": "

The weight value designates the relative percentage of the total number of tasks launched\n that should use the specified capacity provider. The weight value is taken into consideration\n after the base value, if defined, is satisfied.

" + } + }, + "base": { + "target": "com.amazonaws.cloudwatchevents#CapacityProviderStrategyItemBase", + "traits": { + "smithy.api#documentation": "

The base value designates how many tasks, at a minimum, to run on the specified capacity\n provider. Only one capacity provider in a capacity provider strategy can have a base defined.\n If no value is specified, the default value of 0 is used.

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

The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.

" + } + }, + "com.amazonaws.cloudwatchevents#CapacityProviderStrategyItemBase": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100000 + } + } + }, + "com.amazonaws.cloudwatchevents#CapacityProviderStrategyItemWeight": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1000 + } + } + }, "com.amazonaws.cloudwatchevents#ConcurrentModificationException": { "type": "structure", "members": { @@ -844,7 +910,7 @@ "ApiKeyName": { "target": "com.amazonaws.cloudwatchevents#AuthHeaderParameters", "traits": { - "smithy.api#documentation": "

The name of the header to use for the APIKeyValue used for authorization.

" + "smithy.api#documentation": "

The name of the header to use for the APIKeyValue used for\n authorization.

" } } }, @@ -1046,7 +1112,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.cloudwatchevents#ConnectionOAuthClientResponseParameters": { @@ -1470,7 +1536,7 @@ "InvocationHttpParameters": { "target": "com.amazonaws.cloudwatchevents#ConnectionHttpParameters", "traits": { - "smithy.api#documentation": "

A ConnectionHttpParameters object that contains the API key authorization\n parameters to use for the connection. Note that if you include additional parameters for\n the target of a rule via HttpParameters, including query strings, the parameters\n added for the connection take precedence.

" + "smithy.api#documentation": "

A ConnectionHttpParameters object that contains the API key authorization\n parameters to use for the connection. Note that if you include additional parameters for the\n target of a rule via HttpParameters, including query strings, the parameters\n added for the connection take precedence.

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

Deletes the specified rule.

\n

Before you can delete the rule, you must remove all targets, using RemoveTargets.

\n\n

When you delete a rule, incoming events might continue to match to the deleted rule. Allow\n a short period of time for changes to take effect.

\n\n

Managed rules are rules created and managed by another AWS service on your behalf. These\n rules are created by those other AWS services to support functionality in those services. You\n can delete these rules using the Force option, but you should do so only if you\n are sure the other service is not still using that rule.

" + "smithy.api#documentation": "

Deletes the specified rule.

\n

Before you can delete the rule, you must remove all targets, using RemoveTargets.

\n\n

When you delete a rule, incoming events might continue to match to the deleted rule. Allow\n a short period of time for changes to take effect.

\n\n

If you call delete rule multiple times for the same rule, all calls will succeed. When you\n call delete rule for a non-existent custom eventbus, ResourceNotFoundException is\n returned.

\n\n

Managed rules are rules created and managed by another AWS service on your behalf. These\n rules are created by those other AWS services to support functionality in those services. You\n can delete these rules using the Force option, but you should do so only if you\n are sure the other service is not still using that rule.

" } }, "com.amazonaws.cloudwatchevents#DeleteRuleRequest": { @@ -2939,6 +3005,54 @@ "traits": { "smithy.api#documentation": "

Specifies an ECS task group for the task. The maximum length is 255 characters.

" } + }, + "CapacityProviderStrategy": { + "target": "com.amazonaws.cloudwatchevents#CapacityProviderStrategy", + "traits": { + "smithy.api#documentation": "

The capacity provider strategy to use for the task.

\n

If a capacityProviderStrategy is specified, the launchType\n parameter must be omitted. If no capacityProviderStrategy or launchType is\n specified, the defaultCapacityProviderStrategy for the cluster is used.

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

Specifies whether to enable Amazon ECS managed tags for the task. For more information,\n see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer\n Guide.

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

Whether or not to enable the execute command functionality for the containers in this\n task. If true, this enables execute command functionality on all containers in the\n task.

" + } + }, + "PlacementConstraints": { + "target": "com.amazonaws.cloudwatchevents#PlacementConstraints", + "traits": { + "smithy.api#documentation": "

An array of placement constraint objects to use for the task. You can specify up to 10\n constraints per task (including constraints in the task definition and those specified at\n runtime).

" + } + }, + "PlacementStrategy": { + "target": "com.amazonaws.cloudwatchevents#PlacementStrategies", + "traits": { + "smithy.api#documentation": "

The placement strategy objects to use for the task. You can specify a maximum of five\n strategy rules per task.

" + } + }, + "PropagateTags": { + "target": "com.amazonaws.cloudwatchevents#PropagateTags", + "traits": { + "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition to the task. If no value\n is specified, the tags are not propagated. Tags can only be propagated to the task during task\n creation. To add tags to a task after task creation, use the TagResource API action.

" + } + }, + "ReferenceId": { + "target": "com.amazonaws.cloudwatchevents#ReferenceId", + "traits": { + "smithy.api#documentation": "

The reference ID to use for the task.

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

The metadata that you apply to the task to help you categorize and organize them. Each tag\n consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.

" + } } }, "traits": { @@ -3015,7 +3129,7 @@ } }, "traits": { - "smithy.api#documentation": "

An event bus receives events from a source and routes them to rules associated with that\n event bus. Your account's default event bus receives rules from AWS services. A custom event\n bus can receive rules from AWS services as well as your custom applications and services. A\n partner event bus receives events from an event source created by an SaaS partner. These\n events come from the partners services or applications.

" + "smithy.api#documentation": "

An event bus receives events from a source and routes them to rules associated with that\n event bus. Your account's default event bus receives events from AWS services. A custom event\n bus can receive events from your custom applications and services. A partner event bus\n receives events from an event source created by an SaaS partner. These events come from the\n partners services or applications.

" } }, "com.amazonaws.cloudwatchevents#EventBusList": { @@ -3031,7 +3145,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "[/\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^[/\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.cloudwatchevents#EventBusNameOrArn": { @@ -3041,7 +3155,7 @@ "min": 1, "max": 1600 }, - "smithy.api#pattern": "(arn:aws[\\w-]*:events:[a-z]{2}-[a-z]+-[\\w-]+:[0-9]{12}:event-bus\\/)?[/\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^(arn:aws[\\w-]*:events:[a-z]{2}-[a-z]+-[\\w-]+:[0-9]{12}:event-bus\\/)?[/\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.cloudwatchevents#EventId": { @@ -3116,7 +3230,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "aws\\.partner(/[\\.\\-_A-Za-z0-9]+){2,}" + "smithy.api#pattern": "^aws\\.partner(/[\\.\\-_A-Za-z0-9]+){2,}$" } }, "com.amazonaws.cloudwatchevents#EventSourceNamePrefix": { @@ -3126,7 +3240,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "[/\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^[/\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.cloudwatchevents#EventSourceState": { @@ -3186,13 +3300,13 @@ "PathParameterValues": { "target": "com.amazonaws.cloudwatchevents#PathParameterList", "traits": { - "smithy.api#documentation": "

The path parameter values to be used to populate API Gateway REST API or \n EventBridge ApiDestination path wildcards (\"*\").

" + "smithy.api#documentation": "

The path parameter values to be used to populate API Gateway REST API or EventBridge\n ApiDestination path wildcards (\"*\").

" } }, "HeaderParameters": { "target": "com.amazonaws.cloudwatchevents#HeaderParametersMap", "traits": { - "smithy.api#documentation": "

The headers that need to be sent as part of request invoking the API Gateway REST\n API or EventBridge ApiDestination.

" + "smithy.api#documentation": "

The headers that need to be sent as part of request invoking the API Gateway REST API or\n EventBridge ApiDestination.

" } }, "QueryStringParameters": { @@ -3203,7 +3317,7 @@ } }, "traits": { - "smithy.api#documentation": "

These are custom parameter to be used when the target is an API Gateway REST APIs\n or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters\n specified on the Connection, with any values from the Connection taking precedence.

" + "smithy.api#documentation": "

These are custom parameter to be used when the target is an API Gateway REST APIs or\n EventBridge ApiDestinations. In the latter case, these are merged with any\n InvocationParameters specified on the Connection, with any values from the Connection taking\n precedence.

" } }, "com.amazonaws.cloudwatchevents#HttpsEndpoint": { @@ -3240,7 +3354,7 @@ "InputTemplate": { "target": "com.amazonaws.cloudwatchevents#TransformerInput", "traits": { - "smithy.api#documentation": "

Input template where you specify placeholders that will be filled with the values of the\n keys from InputPathsMap to customize the data sent to the target. Enclose each\n InputPathsMaps value in brackets: <value> The\n InputTemplate must be valid JSON.

\n\n

If InputTemplate is a JSON object (surrounded by curly braces), the following\n restrictions apply:

\n \n

The following example shows the syntax for using InputPathsMap and\n InputTemplate.

\n

\n \"InputTransformer\":\n

\n

\n {\n

\n

\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n

\n

\n \"InputTemplate\": \" is in state \"\n

\n

\n }\n

\n

To have the InputTemplate include quote marks within a JSON string, escape\n each quote marks with a slash, as in the following example:

\n

\n \"InputTransformer\":\n

\n

\n {\n

\n

\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n

\n

\n \"InputTemplate\": \" is in state \\\"\\\"\"\n

\n

\n }\n

\n

The InputTemplate can also be valid JSON with varibles in quotes or out,\n as in the following example:

\n

\n \"InputTransformer\":\n

\n

\n {\n

\n

\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n

\n

\n \"InputTemplate\": '{\"myInstance\": ,\"myStatus\":\n \" is in state \\\"\\\"\"}'\n

\n

\n }\n

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

Input template where you specify placeholders that will be filled with the values of the\n keys from InputPathsMap to customize the data sent to the target. Enclose each\n InputPathsMaps value in brackets: <value> The\n InputTemplate must be valid JSON.

\n\n

If InputTemplate is a JSON object (surrounded by curly braces), the following\n restrictions apply:

\n \n

The following example shows the syntax for using InputPathsMap and\n InputTemplate.

\n

\n \"InputTransformer\":\n

\n

\n {\n

\n

\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n

\n

\n \"InputTemplate\": \" is in state \"\n

\n

\n }\n

\n

To have the InputTemplate include quote marks within a JSON string, escape\n each quote marks with a slash, as in the following example:

\n

\n \"InputTransformer\":\n

\n

\n {\n

\n

\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n

\n

\n \"InputTemplate\": \" is in state \\\"\\\"\"\n

\n

\n }\n

\n

The InputTemplate can also be valid JSON with varibles in quotes or out, as\n in the following example:

\n

\n \"InputTransformer\":\n

\n

\n {\n

\n

\n \"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\":\n \"$.detail.status\"},\n

\n

\n \"InputTemplate\": '{\"myInstance\": ,\"myStatus\": \" is\n in state \\\"\\\"\"}'\n

\n

\n }\n

", "smithy.api#required": {} } } @@ -3256,7 +3370,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "[A-Za-z0-9\\_\\-]+" + "smithy.api#pattern": "^[A-Za-z0-9\\_\\-]+$" } }, "com.amazonaws.cloudwatchevents#Integer": { @@ -4188,7 +4302,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "[\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.cloudwatchevents#NonPartnerEventBusNameOrArn": { @@ -4198,7 +4312,7 @@ "min": 1, "max": 1600 }, - "smithy.api#pattern": "(arn:aws[\\w-]*:events:[a-z]{2}-[a-z]+-[\\w-]+:[0-9]{12}:event-bus\\/)?[\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^(arn:aws[\\w-]*:events:[a-z]{2}-[a-z]+-[\\w-]+:[0-9]{12}:event-bus\\/)?[\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.cloudwatchevents#OperationDisabledException": { @@ -4284,13 +4398,13 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "aws\\.partner/[\\.\\-_A-Za-z0-9]+/[/\\.\\-_A-Za-z0-9]*" + "smithy.api#pattern": "^aws\\.partner/[\\.\\-_A-Za-z0-9]+/[/\\.\\-_A-Za-z0-9]*$" } }, "com.amazonaws.cloudwatchevents#PathParameter": { "type": "string", "traits": { - "smithy.api#pattern": "^(?!\\s*$).+" + "smithy.api#pattern": "^(?!\\s*$).+$" } }, "com.amazonaws.cloudwatchevents#PathParameterList": { @@ -4299,6 +4413,122 @@ "target": "com.amazonaws.cloudwatchevents#PathParameter" } }, + "com.amazonaws.cloudwatchevents#PlacementConstraint": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.cloudwatchevents#PlacementConstraintType", + "traits": { + "smithy.api#documentation": "

The type of constraint. Use distinctInstance to ensure that each task in a particular\n group is running on a different container instance. Use memberOf to restrict the selection to\n a group of valid candidates.

" + } + }, + "expression": { + "target": "com.amazonaws.cloudwatchevents#PlacementConstraintExpression", + "traits": { + "smithy.api#documentation": "

A cluster query language expression to apply to the constraint. You cannot specify an\n expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.\n

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

An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer\n Guide.

" + } + }, + "com.amazonaws.cloudwatchevents#PlacementConstraintExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.cloudwatchevents#PlacementConstraintType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "distinctInstance", + "name": "DISTINCT_INSTANCE" + }, + { + "value": "memberOf", + "name": "MEMBER_OF" + } + ] + } + }, + "com.amazonaws.cloudwatchevents#PlacementConstraints": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchevents#PlacementConstraint" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.cloudwatchevents#PlacementStrategies": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchevents#PlacementStrategy" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.cloudwatchevents#PlacementStrategy": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.cloudwatchevents#PlacementStrategyType", + "traits": { + "smithy.api#documentation": "

The type of placement strategy. The random placement strategy randomly places tasks on\n available candidates. The spread placement strategy spreads placement across available\n candidates evenly based on the field parameter. The binpack strategy places tasks on available\n candidates that have the least available amount of the resource that is specified with the\n field parameter. For example, if you binpack on memory, a task is placed on the instance with\n the least amount of remaining memory (but still enough to run the task).

" + } + }, + "field": { + "target": "com.amazonaws.cloudwatchevents#PlacementStrategyField", + "traits": { + "smithy.api#documentation": "

The field to apply the placement strategy against. For the spread placement strategy,\n valid values are instanceId (or host, which has the same effect), or any platform or custom\n attribute that is applied to a container instance, such as attribute:ecs.availability-zone.\n For the binpack placement strategy, valid values are cpu and memory. For the random placement\n strategy, this field is not used.

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

The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Developer\n Guide.

" + } + }, + "com.amazonaws.cloudwatchevents#PlacementStrategyField": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.cloudwatchevents#PlacementStrategyType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "random", + "name": "RANDOM" + }, + { + "value": "spread", + "name": "SPREAD" + }, + { + "value": "binpack", + "name": "BINPACK" + } + ] + } + }, "com.amazonaws.cloudwatchevents#PolicyLengthExceededException": { "type": "structure", "members": { @@ -4318,7 +4548,18 @@ "min": 1, "max": 12 }, - "smithy.api#pattern": "(\\d{12}|\\*)" + "smithy.api#pattern": "^(\\d{12}|\\*)$" + } + }, + "com.amazonaws.cloudwatchevents#PropagateTags": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TASK_DEFINITION", + "name": "TASK_DEFINITION" + } + ] } }, "com.amazonaws.cloudwatchevents#PutEvents": { @@ -4392,7 +4633,7 @@ "TraceHeader": { "target": "com.amazonaws.cloudwatchevents#TraceHeader", "traits": { - "smithy.api#documentation": "

An AWS X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event.

\n

To learn more about X-Ray trace headers, see Tracing header in the AWS X-Ray Developer Guide.

" + "smithy.api#documentation": "

An AWS X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the\n trace-id associated with the event.

\n

To learn more about X-Ray trace headers, see Tracing header in the AWS X-Ray Developer Guide.

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

Adds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n

You can configure the following as targets for Events:

\n\n \n\n\n\n

Creating rules with built-in targets is supported only in the AWS Management Console. The\n built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API\n call, EC2 StopInstances API call, and EC2 TerminateInstances API\n call.

\n\n

For some target types, PutTargets provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event goes to by\n using the KinesisParameters argument. To invoke a command on multiple EC2\n instances with one rule, you can use the RunCommandParameters field.

\n\n

To be able to make API calls against the resources that you own, Amazon EventBridge\n (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS\n resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data\n streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on\n IAM roles that you specify in the RoleARN argument in PutTargets.\n For more information, see Authentication\n and Access Control in the Amazon EventBridge User Guide.

\n\n

If another AWS account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's event\n bus as a target of the rules in your account. To send the matched events to the other account,\n specify that account's event bus as the Arn value when you run\n PutTargets. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge (CloudWatch Events)\n Pricing.

\n\n \n

\n Input, InputPath, and InputTransformer are not\n available with PutTarget if the target is an event bus of a different AWS\n account.

\n \n\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between AWS Accounts in the Amazon EventBridge User\n Guide.

\n\n

For more information about enabling cross-account events, see PutPermission.

\n\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:

\n\n \n\n

When you specify InputPath or InputTransformer, you must use\n JSON dot notation, not bracket notation.

\n\n

When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.

\n\n

This action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.

" + "smithy.api#documentation": "

Adds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n

You can configure the following as targets for Events:

\n\n \n\n

Creating rules with built-in targets is supported only in the AWS Management Console. The\n built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API\n call, EC2 StopInstances API call, and EC2 TerminateInstances API\n call.

\n\n

For some target types, PutTargets provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event goes to by\n using the KinesisParameters argument. To invoke a command on multiple EC2\n instances with one rule, you can use the RunCommandParameters field.

\n\n

To be able to make API calls against the resources that you own, Amazon EventBridge\n (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS\n resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data\n streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on\n IAM roles that you specify in the RoleARN argument in PutTargets.\n For more information, see Authentication\n and Access Control in the Amazon EventBridge User Guide.

\n\n

If another AWS account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's event\n bus as a target of the rules in your account. To send the matched events to the other account,\n specify that account's event bus as the Arn value when you run\n PutTargets. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge (CloudWatch Events)\n Pricing.

\n\n \n

\n Input, InputPath, and InputTransformer are not\n available with PutTarget if the target is an event bus of a different AWS\n account.

\n \n\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between AWS Accounts in the Amazon EventBridge User\n Guide.

\n\n

For more information about enabling cross-account events, see PutPermission.

\n\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:

\n\n \n\n

When you specify InputPath or InputTransformer, you must use\n JSON dot notation, not bracket notation.

\n\n

When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.

\n\n

This action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.

" } }, "com.amazonaws.cloudwatchevents#PutTargetsRequest": { @@ -4866,7 +5107,7 @@ "min": 0, "max": 512 }, - "smithy.api#pattern": "[^\\x00-\\x1F\\x7F]+" + "smithy.api#pattern": "^[^\\x00-\\x1F\\x7F]+$" } }, "com.amazonaws.cloudwatchevents#QueryStringParametersMap": { @@ -4885,7 +5126,7 @@ "min": 0, "max": 512 }, - "smithy.api#pattern": "[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+" + "smithy.api#pattern": "^[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+$" } }, "com.amazonaws.cloudwatchevents#RedshiftDataParameters": { @@ -4941,7 +5182,16 @@ "min": 1, "max": 1600 }, - "smithy.api#pattern": "(^arn:aws([a-z]|\\-)*:secretsmanager:[a-z0-9-.]+:.*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)" + "smithy.api#pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:[a-z0-9-.]+:.*)|(\\$(\\.[\\w_-]+(\\[(\\d+|\\*)\\])*)*)$" + } + }, + "com.amazonaws.cloudwatchevents#ReferenceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } } }, "com.amazonaws.cloudwatchevents#RemovePermission": { @@ -5218,7 +5468,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.cloudwatchevents#ReplayState": { @@ -5420,7 +5670,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.cloudwatchevents#RuleNameList": { @@ -5750,7 +6000,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[a-zA-Z0-9-_]+" + "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" } }, "com.amazonaws.cloudwatchevents#StatementName": { @@ -5946,7 +6196,7 @@ "HttpParameters": { "target": "com.amazonaws.cloudwatchevents#HttpParameters", "traits": { - "smithy.api#documentation": "

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint \n or EventBridge ApiDestination.

\n

If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you \n can use this parameter to specify headers, path parameters, and query string keys/values \n as part of your target invoking request. If you're using ApiDestinations, the corresponding\n Connection can also have these values configured. In case of any conflicting keys, values\n from the Connection take precedence.

" + "smithy.api#documentation": "

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or\n EventBridge ApiDestination.

\n

If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can\n use this parameter to specify headers, path parameters, and query string keys/values as part\n of your target invoking request. If you're using ApiDestinations, the corresponding Connection\n can also have these values configured. In case of any conflicting keys, values from the\n Connection take precedence.

" } }, "RedshiftDataParameters": { @@ -5994,7 +6244,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[\\.\\-_A-Za-z0-9]+" + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" } }, "com.amazonaws.cloudwatchevents#TargetIdList": { @@ -6157,7 +6407,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge\n (CloudWatch Events, rules and event buses can be tagged.

" + "smithy.api#documentation": "

Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge\n (CloudWatch Events), rules and event buses can be tagged.

" } }, "com.amazonaws.cloudwatchevents#UntagResourceRequest": { diff --git a/aws/sdk/aws-models/glue.json b/aws/sdk/aws-models/glue.json index b54724e46..9501bf26c 100644 --- a/aws/sdk/aws-models/glue.json +++ b/aws/sdk/aws-models/glue.json @@ -517,7 +517,7 @@ "name": "glue" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "AWS Glue\n

Defines the public endpoint for the AWS Glue service.

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

Defines the public endpoint for the Glue service.

", "smithy.api#title": "AWS Glue" } }, @@ -542,13 +542,13 @@ "JobName": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of a job to be executed.

" + "smithy.api#documentation": "

The name of a job to be run.

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

The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that AWS Glue itself consumes.

\n

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" + "smithy.api#documentation": "

The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that Glue itself consumes.

\n

For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

" } }, "Timeout": { @@ -713,7 +713,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the catalog in which the partition is to be created. Currently, this should be\n the AWS account ID.

" + "smithy.api#documentation": "

The ID of the catalog in which the partition is to be created. Currently, this should be\n the Amazon Web Services account ID.

" } }, "DatabaseName": { @@ -776,7 +776,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which the connections reside. If none is provided, the AWS\n account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services\n account ID is used by default.

" } }, "ConnectionNameList": { @@ -837,7 +837,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the partition to be deleted resides. If none is provided,\n the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the partition to be deleted resides. If none is provided,\n the Amazon Web Services account ID is used by default.

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

Deletes multiple tables at once.

\n \n

After completing this operation, you no longer have access to the table versions and\n partitions that belong to the deleted table. AWS Glue deletes these \"orphaned\" resources\n asynchronously in a timely manner, at the discretion of the service.

\n

To ensure the immediate deletion of all related resources, before calling\n BatchDeleteTable, use DeleteTableVersion or\n BatchDeleteTableVersion, and DeletePartition or\n BatchDeletePartition, to delete any resources that belong to the\n table.

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

Deletes multiple tables at once.

\n \n

After completing this operation, you no longer have access to the table versions and\n partitions that belong to the deleted table. Glue deletes these \"orphaned\" resources\n asynchronously in a timely manner, at the discretion of the service.

\n

To ensure the immediate deletion of all related resources, before calling\n BatchDeleteTable, use DeleteTableVersion or\n BatchDeleteTableVersion, and DeletePartition or\n BatchDeletePartition, to delete any resources that belong to the\n table.

\n " } }, "com.amazonaws.glue#BatchDeleteTableNameList": { @@ -930,7 +930,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the table resides. If none is provided, the AWS account\n ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account\n ID is used by default.

" } }, "DatabaseName": { @@ -1004,7 +1004,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the tables reside. If none is provided, the AWS account\n ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account\n ID is used by default.

" } }, "DatabaseName": { @@ -1232,7 +1232,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the Amazon Web Services account ID is used by default.

" } }, "DatabaseName": { @@ -1587,7 +1587,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the catalog in which the partition is to be updated. Currently, this should be\n the AWS account ID.

" + "smithy.api#documentation": "

The ID of the catalog in which the partition is to be updated. Currently, this should be\n the Amazon Web Services account ID.

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

Cancels (stops) a task run. Machine learning task runs are asynchronous tasks that AWS\n Glue runs on your behalf as part of various machine learning workflows. You can cancel a\n machine learning task run at any time by calling CancelMLTaskRun with a task\n run's parent transform's TransformID and the task run's TaskRunId.

" + "smithy.api#documentation": "

Cancels (stops) a task run. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can cancel a\n machine learning task run at any time by calling CancelMLTaskRun with a task\n run's parent transform's TransformID and the task run's TaskRunId.

" } }, "com.amazonaws.glue#CancelMLTaskRunRequest": { @@ -1851,7 +1851,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies a table definition in the AWS Glue Data Catalog.

" + "smithy.api#documentation": "

Specifies a table definition in the Glue Data Catalog.

" } }, "com.amazonaws.glue#CatalogGetterPageSize": { @@ -1930,7 +1930,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies an AWS Glue Data Catalog target.

" + "smithy.api#documentation": "

Specifies an Glue Data Catalog target.

" } }, "com.amazonaws.glue#CatalogTargetList": { @@ -1968,7 +1968,7 @@ "DataFormat": { "target": "com.amazonaws.glue#DataFormat", "traits": { - "smithy.api#documentation": "

The data format of the schema definition. Currently only AVRO is supported.

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

The data format of the schema definition. Currently AVRO and JSON are supported.

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

Classifiers are triggered during a crawl task. A classifier checks whether a given file is\n in a format it can handle. If it is, the classifier creates a schema in the form of a\n StructType object that matches that data format.

\n

You can use the standard classifiers that AWS Glue provides, or you can write your own\n classifiers to best categorize your data sources and specify the appropriate schemas to use\n for them. A classifier can be a grok classifier, an XML classifier,\n a JSON classifier, or a custom CSV classifier, as specified in one\n of the fields in the Classifier object.

" + "smithy.api#documentation": "

Classifiers are triggered during a crawl task. A classifier checks whether a given file is\n in a format it can handle. If it is, the classifier creates a schema in the form of a\n StructType object that matches that data format.

\n

You can use the standard classifiers that Glue provides, or you can write your own\n classifiers to best categorize your data sources and specify the appropriate schemas to use\n for them. A classifier can be a grok classifier, an XML classifier,\n a JSON classifier, or a custom CSV classifier, as specified in one\n of the fields in the Classifier object.

" } }, "com.amazonaws.glue#ClassifierList": { @@ -2730,7 +2730,7 @@ "ConnectionProperties": { "target": "com.amazonaws.glue#ConnectionProperties", "traits": { - "smithy.api#documentation": "

These key-value pairs define parameters for the connection:

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

These key-value pairs define parameters for the connection:

\n " } }, "PhysicalConnectionRequirements": { @@ -2781,7 +2781,7 @@ "ConnectionType": { "target": "com.amazonaws.glue#ConnectionType", "traits": { - "smithy.api#documentation": "

The type of the connection. Currently, these types are supported:

\n\t \n

SFTP is not supported.

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

The type of the connection. Currently, these types are supported:

\n\t \n

SFTP is not supported.

", "smithy.api#required": {} } }, @@ -2831,12 +2831,12 @@ "AwsKmsKeyId": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

An AWS KMS key that is used to encrypt the connection password.

\n\t\n

If connection password protection is enabled, the caller of CreateConnection\n and UpdateConnection needs at least kms:Encrypt permission on the\n specified AWS KMS key, to encrypt passwords before storing them in the Data Catalog.

\n \n\t

You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.

" + "smithy.api#documentation": "

An KMS key that is used to encrypt the connection password.

\n\t\n

If connection password protection is enabled, the caller of CreateConnection\n and UpdateConnection needs at least kms:Encrypt permission on the\n specified KMS key, to encrypt passwords before storing them in the Data Catalog.

\n \n\t

You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.

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

The data structure used by the Data Catalog to encrypt the password as part of\n CreateConnection or UpdateConnection and store it in the\n ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog\n encryption or only password encryption.

\n\t\n\t

When a CreationConnection request arrives containing a password, the Data\n Catalog first encrypts the password using your AWS KMS key. It then encrypts the whole\n connection object again if catalog encryption is also enabled.

\n \n

This encryption requires that you set AWS KMS key permissions to enable or restrict access\n on the password key according to your security requirements. For example, you might want only\n administrators to have decrypt permission on the password key.

" + "smithy.api#documentation": "

The data structure used by the Data Catalog to encrypt the password as part of\n CreateConnection or UpdateConnection and store it in the\n ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog\n encryption or only password encryption.

\n\t\n\t

When a CreationConnection request arrives containing a password, the Data\n Catalog first encrypts the password using your KMS key. It then encrypts the whole\n connection object again if catalog encryption is also enabled.

\n \n

This encryption requires that you set KMS key permissions to enable or restrict access\n on the password key according to your security requirements. For example, you might want only\n administrators to have decrypt permission on the password key.

" } }, "com.amazonaws.glue#ConnectionProperties": { @@ -3226,7 +3226,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies a crawler program that examines a data source and uses classifiers to try to\n determine its schema. If successful, the crawler records metadata concerning the data source\n in the AWS Glue Data Catalog.

" + "smithy.api#documentation": "

Specifies a crawler program that examines a data source and uses classifiers to try to\n determine its schema. If successful, the crawler records metadata concerning the data source\n in the Glue Data Catalog.

" } }, "com.amazonaws.glue#CrawlerConfiguration": { @@ -3444,7 +3444,7 @@ "CatalogTargets": { "target": "com.amazonaws.glue#CatalogTargetList", "traits": { - "smithy.api#documentation": "

Specifies AWS Glue Data Catalog targets.

" + "smithy.api#documentation": "

Specifies Glue Data Catalog targets.

" } } }, @@ -3543,7 +3543,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which to create the connection. If none is provided, the AWS\n account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog in which to create the connection. If none is provided, the Amazon Web Services\n account ID is used by default.

" } }, "ConnectionInput": { @@ -3605,7 +3605,7 @@ "DatabaseName": { "target": "com.amazonaws.glue#DatabaseName", "traits": { - "smithy.api#documentation": "

The AWS Glue database where results are written, such as:\n arn:aws:daylight:us-east-1::database/sometable/*.

" + "smithy.api#documentation": "

The Glue database where results are written, such as:\n arn:aws:daylight:us-east-1::database/sometable/*.

" } }, "Description": { @@ -3672,7 +3672,7 @@ "Tags": { "target": "com.amazonaws.glue#TagsMap", "traits": { - "smithy.api#documentation": "

The tags to use with this crawler request. You may use tags to limit access to the\n crawler. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer\n guide.

" + "smithy.api#documentation": "

The tags to use with this crawler request. You may use tags to limit access to the\n crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer\n guide.

" } } } @@ -3770,7 +3770,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which to create the database. If none is provided, the AWS\n account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog in which to create the database. If none is provided, the Amazon Web Services\n account ID is used by default.

" } }, "DatabaseInput": { @@ -3868,7 +3868,7 @@ "NumberOfNodes": { "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

The number of AWS Glue Data Processing Units (DPUs) to allocate to this\n DevEndpoint.

" + "smithy.api#documentation": "

The number of Glue Data Processing Units (DPUs) to allocate to this\n DevEndpoint.

" } }, "WorkerType": { @@ -3880,7 +3880,7 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

\n \n

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Development endpoints that are created without specifying a Glue version default to Glue 0.9.

\n\t\n\t

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

\n \n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Development endpoints that are created without specifying a Glue version default to Glue 0.9.

\n\t\n\t

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" } }, "NumberOfWorkers": { @@ -3910,7 +3910,7 @@ "Tags": { "target": "com.amazonaws.glue#TagsMap", "traits": { - "smithy.api#documentation": "

The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

" + "smithy.api#documentation": "

The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.

" } }, "Arguments": { @@ -3969,7 +3969,7 @@ "NumberOfNodes": { "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint.

" + "smithy.api#documentation": "

The number of Glue Data Processing Units (DPUs) allocated to this DevEndpoint.

" } }, "WorkerType": { @@ -3981,7 +3981,7 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

\n \n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

" } }, "NumberOfWorkers": { @@ -4035,7 +4035,7 @@ "Arguments": { "target": "com.amazonaws.glue#MapValue", "traits": { - "smithy.api#documentation": "

The map of arguments used to configure this DevEndpoint.

\n\t\n\t

Valid arguments are:

\n\t \n\t\n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + "smithy.api#documentation": "

The map of arguments used to configure this DevEndpoint.

\n\t\n\t

Valid arguments are:

\n\t \n\t\n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" } } } @@ -4148,14 +4148,14 @@ "Command": { "target": "com.amazonaws.glue#JobCommand", "traits": { - "smithy.api#documentation": "

The JobCommand that executes this job.

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

The JobCommand that runs this job.

", "smithy.api#required": {} } }, "DefaultArguments": { "target": "com.amazonaws.glue#GenericMap", "traits": { - "smithy.api#documentation": "

The default arguments for this job.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that AWS Glue itself consumes.

\n

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" + "smithy.api#documentation": "

The default arguments for this job.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that Glue itself consumes.

\n

For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

" } }, "NonOverridableArguments": { @@ -4182,7 +4182,7 @@ "smithy.api#deprecated": { "message": "This property is deprecated, use MaxCapacity instead." }, - "smithy.api#documentation": "

This parameter is deprecated. Use MaxCapacity instead.

\n\t\n

The number of AWS Glue data processing units (DPUs) to allocate to this Job. You can\n allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the AWS Glue pricing\n page.

" + "smithy.api#documentation": "

This parameter is deprecated. Use MaxCapacity instead.

\n\t\n

The number of Glue data processing units (DPUs) to allocate to this Job. You can\n allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the Glue pricing\n page.

" } }, "Timeout": { @@ -4194,7 +4194,7 @@ "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the AWS Glue\n pricing page.

\n\t\t \n\t

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n \n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:

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

For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.

\n\t\t \n\t

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n \n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:

\n \n

For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.

" } }, "SecurityConfiguration": { @@ -4206,7 +4206,7 @@ "Tags": { "target": "com.amazonaws.glue#TagsMap", "traits": { - "smithy.api#documentation": "

The tags to use with this job. You may use tags to limit access to the job. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

" + "smithy.api#documentation": "

The tags to use with this job. You may use tags to limit access to the job. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.

" } }, "NotificationProperty": { @@ -4218,7 +4218,7 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Jobs that are created without specifying a Glue version default to Glue 0.9.

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Jobs that are created without specifying a Glue version default to Glue 0.9.

" } }, "NumberOfWorkers": { @@ -4259,7 +4259,7 @@ "JsonPath": { "target": "com.amazonaws.glue#JsonPath", "traits": { - "smithy.api#documentation": "

A JsonPath string defining the JSON data for the classifier to classify.\n AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

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

A JsonPath string defining the JSON data for the classifier to classify.\n Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

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

Creates an AWS Glue machine learning transform. This operation creates the transform and\n all the necessary parameters to train it.

\n\t\n\t

Call this operation as the first step in the process of using a machine learning transform\n (such as the FindMatches transform) for deduplicating data. You can provide an\n optional Description, in addition to the parameters that you want to use for your\n algorithm.

\n\n

You must also specify certain parameters for the tasks that AWS Glue runs on your\n behalf as part of learning from your data and creating a high-quality machine learning\n transform. These parameters include Role, and optionally,\n AllocatedCapacity, Timeout, and MaxRetries. For more\n information, see Jobs.

" + "smithy.api#documentation": "

Creates an Glue machine learning transform. This operation creates the transform and\n all the necessary parameters to train it.

\n\t\n\t

Call this operation as the first step in the process of using a machine learning transform\n (such as the FindMatches transform) for deduplicating data. You can provide an\n optional Description, in addition to the parameters that you want to use for your\n algorithm.

\n\n

You must also specify certain parameters for the tasks that Glue runs on your\n behalf as part of learning from your data and creating a high-quality machine learning\n transform. These parameters include Role, and optionally,\n AllocatedCapacity, Timeout, and MaxRetries. For more\n information, see Jobs.

" } }, "com.amazonaws.glue#CreateMLTransformRequest": { @@ -4322,7 +4322,7 @@ "InputRecordTables": { "target": "com.amazonaws.glue#GlueTables", "traits": { - "smithy.api#documentation": "

A list of AWS Glue table definitions used by the transform.

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

A list of Glue table definitions used by the transform.

", "smithy.api#required": {} } }, @@ -4336,20 +4336,20 @@ "Role": { "target": "com.amazonaws.glue#RoleString", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.

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

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.

\n\n\t\t ", "smithy.api#required": {} } }, "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

" + "smithy.api#documentation": "

This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.

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

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the AWS Glue pricing\n page.

\n\t\t\n\t\t\t

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n \n\t\t\n\t

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

\t \n \n\t\t\n

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" + "smithy.api#documentation": "

The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the Glue pricing\n page.

\n\t\t\n\t\t\t

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n \n\t\t\n\t

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

\t \n \n\t\t\n

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" } }, "WorkerType": { @@ -4379,7 +4379,7 @@ "Tags": { "target": "com.amazonaws.glue#TagsMap", "traits": { - "smithy.api#documentation": "

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

" + "smithy.api#documentation": "

The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.

" } }, "TransformEncryption": { @@ -4513,7 +4513,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The AWS account ID of the catalog in which the partition is to be created.

" + "smithy.api#documentation": "

The Amazon Web Services account ID of the catalog in which the partition is to be created.

" } }, "DatabaseName": { @@ -4591,7 +4591,7 @@ "Tags": { "target": "com.amazonaws.glue#TagsMap", "traits": { - "smithy.api#documentation": "

AWS tags that contain a key value pair and may be searched by console, command line, or API.

" + "smithy.api#documentation": "

Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API.

" } } } @@ -4676,7 +4676,7 @@ "DataFormat": { "target": "com.amazonaws.glue#DataFormat", "traits": { - "smithy.api#documentation": "

The data format of the schema definition. Currently only AVRO is supported.

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

The data format of the schema definition. Currently AVRO and JSON are supported.

", "smithy.api#required": {} } }, @@ -4695,7 +4695,7 @@ "Tags": { "target": "com.amazonaws.glue#TagsMap", "traits": { - "smithy.api#documentation": "

AWS tags that contain a key value pair and may be searched by console, command line, or API. If specified, follows the AWS tags-on-create pattern.

" + "smithy.api#documentation": "

Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API. If specified, follows the Amazon Web Services tags-on-create pattern.

" } }, "SchemaDefinition": { @@ -4742,7 +4742,7 @@ "DataFormat": { "target": "com.amazonaws.glue#DataFormat", "traits": { - "smithy.api#documentation": "

The data format of the schema definition. Currently only AVRO is supported.

" + "smithy.api#documentation": "

The data format of the schema definition. Currently AVRO and JSON are supported.

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

Creates a new security configuration. A security configuration is a set of security properties that can be used by AWS Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in AWS Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints.

" + "smithy.api#documentation": "

Creates a new security configuration. A security configuration is a set of security properties that can be used by Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints.

" } }, "com.amazonaws.glue#CreateSecurityConfigurationRequest": { @@ -4964,7 +4964,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which to create the Table.\n If none is supplied, the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog in which to create the Table.\n If none is supplied, the Amazon Web Services account ID is used by default.

" } }, "DatabaseName": { @@ -5088,7 +5088,7 @@ "Tags": { "target": "com.amazonaws.glue#TagsMap", "traits": { - "smithy.api#documentation": "

The tags to use with this trigger. You may use tags to limit access to the trigger.\n For more information about tags in AWS Glue, see\n AWS Tags in AWS\n Glue in the developer guide.

" + "smithy.api#documentation": "

The tags to use with this trigger. You may use tags to limit access to the trigger.\n For more information about tags in Glue, see\n Amazon Web Services Tags in Glue in the developer guide.

" } } } @@ -5145,7 +5145,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which to create the function. If none is provided, the AWS\n account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog in which to create the function. If none is provided, the Amazon Web Services\n account ID is used by default.

" } }, "DatabaseName": { @@ -5444,6 +5444,10 @@ { "value": "AVRO", "name": "AVRO" + }, + { + "value": "JSON", + "name": "JSON" } ] } @@ -5454,12 +5458,12 @@ "DataLakePrincipalIdentifier": { "target": "com.amazonaws.glue#DataLakePrincipalString", "traits": { - "smithy.api#documentation": "

An identifier for the AWS Lake Formation principal.

" + "smithy.api#documentation": "

An identifier for the Lake Formation principal.

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

The AWS Lake Formation principal.

" + "smithy.api#documentation": "

The Lake Formation principal.

" } }, "com.amazonaws.glue#DataLakePrincipalString": { @@ -5782,7 +5786,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the Amazon Web Services account ID is used by default.

" } }, "DatabaseName": { @@ -5854,7 +5858,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the Amazon Web Services account ID is used by default.

" } }, "DatabaseName": { @@ -5922,7 +5926,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which the connection resides. If none is provided, the AWS\n account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services\n account ID is used by default.

" } }, "ConnectionName": { @@ -5961,7 +5965,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a specified crawler from the AWS Glue Data Catalog, unless the crawler state is\n RUNNING.

" + "smithy.api#documentation": "

Removes a specified crawler from the Glue Data Catalog, unless the crawler state is\n RUNNING.

" } }, "com.amazonaws.glue#DeleteCrawlerRequest": { @@ -6003,7 +6007,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a specified database from a Data Catalog.

\n \n

After completing this operation, you no longer have access to the tables (and all table\n versions and partitions that might belong to the tables) and the user-defined functions in\n the deleted database. AWS Glue deletes these \"orphaned\" resources asynchronously in a timely\n manner, at the discretion of the service.

\n

To ensure the immediate deletion of all related resources, before calling\n DeleteDatabase, use DeleteTableVersion or\n BatchDeleteTableVersion, DeletePartition or\n BatchDeletePartition, DeleteUserDefinedFunction, and\n DeleteTable or BatchDeleteTable, to delete any resources that\n belong to the database.

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

Removes a specified database from a Data Catalog.

\n \n

After completing this operation, you no longer have access to the tables (and all table\n versions and partitions that might belong to the tables) and the user-defined functions in\n the deleted database. Glue deletes these \"orphaned\" resources asynchronously in a timely\n manner, at the discretion of the service.

\n

To ensure the immediate deletion of all related resources, before calling\n DeleteDatabase, use DeleteTableVersion or\n BatchDeleteTableVersion, DeletePartition or\n BatchDeletePartition, DeleteUserDefinedFunction, and\n DeleteTable or BatchDeleteTable, to delete any resources that\n belong to the database.

\n " } }, "com.amazonaws.glue#DeleteDatabaseRequest": { @@ -6012,7 +6016,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which the database resides. If none is provided, the AWS\n account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services\n account ID is used by default.

" } }, "Name": { @@ -6139,7 +6143,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an AWS Glue machine learning transform. Machine learning transforms are a special\n type of transform that use machine learning to learn the details of the transformation to be\n performed by learning from examples provided by humans. These transformations are then saved\n by AWS Glue. If you no longer need a transform, you can delete it by calling\n DeleteMLTransforms. However, any AWS Glue jobs that still reference the deleted\n transform will no longer succeed.

" + "smithy.api#documentation": "

Deletes an Glue machine learning transform. Machine learning transforms are a special\n type of transform that use machine learning to learn the details of the transformation to be\n performed by learning from examples provided by humans. These transformations are then saved\n by Glue. If you no longer need a transform, you can delete it by calling\n DeleteMLTransforms. However, any Glue jobs that still reference the deleted\n transform will no longer succeed.

" } }, "com.amazonaws.glue#DeleteMLTransformRequest": { @@ -6265,7 +6269,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the partition to be deleted resides. If none is provided,\n the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the partition to be deleted resides. If none is provided,\n the Amazon Web Services account ID is used by default.

" } }, "DatabaseName": { @@ -6318,7 +6322,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delete the entire registry including schema and all of its versions. To get the status of the delete operation, you can call the GetRegistry API after the asynchronous call. Deleting a registry will disable all online operations for the registry such as the UpdateRegistry, CreateSchema, UpdateSchema, and RegisterSchemaVersion APIs.

" + "smithy.api#documentation": "

Delete the entire registry including schema and all of its versions. To get the status of the delete operation, you can call the GetRegistry API after the asynchronous call. Deleting a registry will deactivate all online operations for the registry such as the UpdateRegistry, CreateSchema, UpdateSchema, and RegisterSchemaVersion APIs.

" } }, "com.amazonaws.glue#DeleteRegistryInput": { @@ -6397,7 +6401,7 @@ "ResourceArn": { "target": "com.amazonaws.glue#GlueResourceArn", "traits": { - "smithy.api#documentation": "

The ARN of the AWS Glue resource for the resource policy to be deleted.

" + "smithy.api#documentation": "

The ARN of the Glue resource for the resource policy to be deleted.

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

Deletes the entire schema set, including the schema set and all of its versions. To get the status of the delete operation, you can call GetSchema API after the asynchronous call. Deleting a registry will disable all online operations for the schema, such as the GetSchemaByDefinition, and RegisterSchemaVersion APIs.

" + "smithy.api#documentation": "

Deletes the entire schema set, including the schema set and all of its versions. To get the status of the delete operation, you can call GetSchema API after the asynchronous call. Deleting a registry will deactivate all online operations for the schema, such as the GetSchemaByDefinition, and RegisterSchemaVersion APIs.

" } }, "com.amazonaws.glue#DeleteSchemaInput": { @@ -6588,7 +6592,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a table definition from the Data Catalog.

\n \n

After completing this operation, you no longer have access to the table versions and\n partitions that belong to the deleted table. AWS Glue deletes these \"orphaned\" resources\n asynchronously in a timely manner, at the discretion of the service.

\n

To ensure the immediate deletion of all related resources, before calling\n DeleteTable, use DeleteTableVersion or\n BatchDeleteTableVersion, and DeletePartition or\n BatchDeletePartition, to delete any resources that belong to the\n table.

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

Removes a table definition from the Data Catalog.

\n \n

After completing this operation, you no longer have access to the table versions and\n partitions that belong to the deleted table. Glue deletes these \"orphaned\" resources\n asynchronously in a timely manner, at the discretion of the service.

\n

To ensure the immediate deletion of all related resources, before calling\n DeleteTable, use DeleteTableVersion or\n BatchDeleteTableVersion, and DeletePartition or\n BatchDeletePartition, to delete any resources that belong to the\n table.

\n " } }, "com.amazonaws.glue#DeleteTableRequest": { @@ -6597,7 +6601,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the table resides. If none is provided, the AWS account\n ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account\n ID is used by default.

" } }, "DatabaseName": { @@ -6652,7 +6656,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the tables reside. If none is provided, the AWS account\n ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account\n ID is used by default.

" } }, "DatabaseName": { @@ -6763,7 +6767,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the function to be deleted is\n located. If none is supplied, the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the function to be deleted is\n located. If none is supplied, the Amazon Web Services account ID is used by default.

" } }, "DatabaseName": { @@ -6921,7 +6925,7 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

\n \n

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Development endpoints that are created without specifying a Glue version default to Glue 0.9.

\n\t\n\t

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

\n \n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Development endpoints that are created without specifying a Glue version default to Glue 0.9.

\n\t\n\t

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" } }, "NumberOfWorkers": { @@ -6933,7 +6937,7 @@ "NumberOfNodes": { "target": "com.amazonaws.glue#IntegerValue", "traits": { - "smithy.api#documentation": "

The number of AWS Glue Data Processing Units (DPUs) allocated to this\n DevEndpoint.

" + "smithy.api#documentation": "

The number of Glue Data Processing Units (DPUs) allocated to this\n DevEndpoint.

" } }, "AvailabilityZone": { @@ -7005,7 +7009,7 @@ "Arguments": { "target": "com.amazonaws.glue#MapValue", "traits": { - "smithy.api#documentation": "

A map of arguments used to configure the DevEndpoint.

\n

Valid arguments are:

\n\t \n\t\n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + "smithy.api#documentation": "

A map of arguments used to configure the DevEndpoint.

\n

Valid arguments are:

\n\t \n\t\n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" } } }, @@ -7112,7 +7116,7 @@ "scanRate": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The percentage of the configured read capacity units to use by the AWS Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.

\n\t\n\t

The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).

" + "smithy.api#documentation": "

The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.

\n\t\n\t

The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).

" } } }, @@ -7143,7 +7147,7 @@ } }, "traits": { - "smithy.api#documentation": "

An edge represents a directed connection between two AWS Glue components that are part of the workflow the\n edge belongs to.

" + "smithy.api#documentation": "

An edge represents a directed connection between two Glue components that are part of the workflow the\n edge belongs to.

" } }, "com.amazonaws.glue#EdgeList": { @@ -7180,7 +7184,7 @@ "SseAwsKmsKeyId": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The ID of the AWS KMS key to use for encryption at rest.

" + "smithy.api#documentation": "

The ID of the KMS key to use for encryption at rest.

" } } }, @@ -7531,7 +7535,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the catalog to migrate. Currently, this should be the AWS account ID.

" + "smithy.api#documentation": "

The ID of the catalog to migrate. Currently, this should be the Amazon Web Services account ID.

" } } } @@ -7693,7 +7697,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the Amazon Web Services account ID is used by default.

" } }, "DatabaseName": { @@ -7778,7 +7782,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the Amazon Web Services account ID is used by default.

" } }, "DatabaseName": { @@ -7853,7 +7857,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which the connection resides. If none is provided, the AWS\n account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services\n account ID is used by default.

" } }, "Name": { @@ -7866,7 +7870,7 @@ "HidePassword": { "target": "com.amazonaws.glue#Boolean", "traits": { - "smithy.api#documentation": "

Allows you to retrieve the connection metadata without returning the password. For\n instance, the AWS Glue console uses this flag to retrieve the connection, and does not display\n the password. Set this parameter when the caller might not have permission to use the AWS KMS\n key to decrypt the password, but it does have permission to access the rest of the connection\n properties.

" + "smithy.api#documentation": "

Allows you to retrieve the connection metadata without returning the password. For\n instance, the AWS Glue console uses this flag to retrieve the connection, and does not display\n the password. Set this parameter when the caller might not have permission to use the KMS\n key to decrypt the password, but it does have permission to access the rest of the connection\n properties.

" } } } @@ -7939,7 +7943,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which the connections reside. If none is provided, the AWS\n account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services\n account ID is used by default.

" } }, "Filter": { @@ -7951,7 +7955,7 @@ "HidePassword": { "target": "com.amazonaws.glue#Boolean", "traits": { - "smithy.api#documentation": "

Allows you to retrieve the connection metadata without returning the password. For\n instance, the AWS Glue console uses this flag to retrieve the connection, and does not display\n the password. Set this parameter when the caller might not have permission to use the AWS KMS\n key to decrypt the password, but it does have permission to access the rest of the connection\n properties.

" + "smithy.api#documentation": "

Allows you to retrieve the connection metadata without returning the password. For\n instance, the AWS Glue console uses this flag to retrieve the connection, and does not display\n the password. Set this parameter when the caller might not have permission to use the KMS\n key to decrypt the password, but it does have permission to access the rest of the connection\n properties.

" } }, "NextToken": { @@ -8175,7 +8179,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog to retrieve the security configuration for. If none is\n provided, the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog to retrieve the security configuration for. If none is\n provided, the Amazon Web Services account ID is used by default.

" } } } @@ -8226,7 +8230,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which the database resides. If none is provided, the AWS\n account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog in which the database resides. If none is provided, the Amazon Web Services\n account ID is used by default.

" } }, "Name": { @@ -8286,7 +8290,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog from which to retrieve Databases. If none is\n provided, the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog from which to retrieve Databases. If none is\n provided, the Amazon Web Services account ID is used by default.

" } }, "NextToken": { @@ -8401,7 +8405,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about a specified development endpoint.

\n \n

When you create a development endpoint in a virtual private cloud (VPC), AWS Glue returns only\n a private IP address, and the public IP address field is not populated. When you create a\n non-VPC development endpoint, AWS Glue returns only a public IP address.

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

Retrieves information about a specified development endpoint.

\n \n

When you create a development endpoint in a virtual private cloud (VPC), Glue returns only\n a private IP address, and the public IP address field is not populated. When you create a\n non-VPC development endpoint, Glue returns only a public IP address.

\n " } }, "com.amazonaws.glue#GetDevEndpointRequest": { @@ -8450,7 +8454,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves all the development endpoints in this AWS account.

\n \n

When you create a development endpoint in a virtual private cloud (VPC), AWS Glue returns only a private IP address\n and the public IP address field is not populated. When you create a non-VPC development\n endpoint, AWS Glue returns only a public IP address.

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

Retrieves all the development endpoints in this AWS account.

\n \n

When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address\n and the public IP address field is not populated. When you create a non-VPC development\n endpoint, Glue returns only a public IP address.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8821,7 +8825,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets details for a specific task run on a machine learning transform. Machine learning\n task runs are asynchronous tasks that AWS Glue runs on your behalf as part of various machine\n learning workflows. You can check the stats of any task run by calling\n GetMLTaskRun with the TaskRunID and its parent transform's\n TransformID.

" + "smithy.api#documentation": "

Gets details for a specific task run on a machine learning transform. Machine learning\n task runs are asynchronous tasks that Glue runs on your behalf as part of various machine\n learning workflows. You can check the stats of any task run by calling\n GetMLTaskRun with the TaskRunID and its parent transform's\n TransformID.

" } }, "com.amazonaws.glue#GetMLTaskRunRequest": { @@ -8931,7 +8935,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of runs for a machine learning transform. Machine learning task runs are\n asynchronous tasks that AWS Glue runs on your behalf as part of various machine learning\n workflows. You can get a sortable, filterable list of machine learning task runs by calling\n GetMLTaskRuns with their parent transform's TransformID and other\n optional parameters as documented in this section.

\n\t\n\t

This operation returns a list of historic runs and must be paginated.

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

Gets a list of runs for a machine learning transform. Machine learning task runs are\n asynchronous tasks that Glue runs on your behalf as part of various machine learning\n workflows. You can get a sortable, filterable list of machine learning task runs by calling\n GetMLTaskRuns with their parent transform's TransformID and other\n optional parameters as documented in this section.

\n\t\n\t

This operation returns a list of historic runs and must be paginated.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -9015,7 +9019,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets an AWS Glue machine learning transform artifact and all its corresponding metadata.\n Machine learning transforms are a special type of transform that use machine learning to learn\n the details of the transformation to be performed by learning from examples provided by\n humans. These transformations are then saved by AWS Glue. You can retrieve their metadata by\n calling GetMLTransform.

" + "smithy.api#documentation": "

Gets an Glue machine learning transform artifact and all its corresponding metadata.\n Machine learning transforms are a special type of transform that use machine learning to learn\n the details of the transformation to be performed by learning from examples provided by\n humans. These transformations are then saved by Glue. You can retrieve their metadata by\n calling GetMLTransform.

" } }, "com.amazonaws.glue#GetMLTransformRequest": { @@ -9072,7 +9076,7 @@ "InputRecordTables": { "target": "com.amazonaws.glue#GlueTables", "traits": { - "smithy.api#documentation": "

A list of AWS Glue table definitions used by the transform.

" + "smithy.api#documentation": "

A list of Glue table definitions used by the transform.

" } }, "Parameters": { @@ -9108,13 +9112,13 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

" + "smithy.api#documentation": "

This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.

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

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the AWS Glue pricing\n page.

\n\t\t\n

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" + "smithy.api#documentation": "

The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the Glue pricing\n page.

\n\t\t\n

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" } }, "WorkerType": { @@ -9172,7 +9176,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a sortable, filterable list of existing AWS Glue machine learning transforms. Machine\n learning transforms are a special type of transform that use machine learning to learn the\n details of the transformation to be performed by learning from examples provided by humans.\n These transformations are then saved by AWS Glue, and you can retrieve their metadata by\n calling GetMLTransforms.

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

Gets a sortable, filterable list of existing Glue machine learning transforms. Machine\n learning transforms are a special type of transform that use machine learning to learn the\n details of the transformation to be performed by learning from examples provided by humans.\n These transformations are then saved by Glue, and you can retrieve their metadata by\n calling GetMLTransforms.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -9406,7 +9410,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the partition in question resides. If none is provided,\n the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the partition in question resides. If none is provided,\n the Amazon Web Services account ID is used by default.

" } }, "DatabaseName": { @@ -9483,7 +9487,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside. If none is provided,\n the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside. If none is provided,\n the Amazon Web Services account ID is used by default.

" } }, "DatabaseName": { @@ -9503,7 +9507,7 @@ "Expression": { "target": "com.amazonaws.glue#PredicateString", "traits": { - "smithy.api#documentation": "

An expression that filters the partitions to be returned.

\n

The expression uses SQL syntax similar to the SQL WHERE filter clause. The\n SQL statement parser JSQLParser parses the expression.

\n

\n Operators: The following are the operators that you can use in the\n Expression API call:

\n
\n
=
\n
\n

Checks whether the values of the two operands are equal; if yes, then the condition becomes\n true.

\n

Example: Assume 'variable a' holds 10 and 'variable b' holds 20.

\n

(a = b) is not true.

\n
\n
< >
\n
\n

Checks whether the values of two operands are equal; if the values are not equal,\n then the condition becomes true.

\n

Example: (a < > b) is true.

\n
\n
>
\n
\n

Checks whether the value of the left operand is greater than the value of the right\n operand; if yes, then the condition becomes true.

\n

Example: (a > b) is not true.

\n
\n
<
\n
\n

Checks whether the value of the left operand is less than the value of the right\n operand; if yes, then the condition becomes true.

\n

Example: (a < b) is true.

\n
\n
>=
\n
\n

Checks whether the value of the left operand is greater than or equal to the value\n of the right operand; if yes, then the condition becomes true.

\n

Example: (a >= b) is not true.

\n
\n
<=
\n
\n

Checks whether the value of the left operand is less than or equal to the value of\n the right operand; if yes, then the condition becomes true.

\n

Example: (a <= b) is true.

\n
\n
AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL
\n
\n

Logical operators.

\n
\n
\n

\n Supported Partition Key Types: The following are the supported\n partition keys.

\n \n

If an invalid type is encountered, an exception is thrown.

\n

The following list shows the valid operators on each type. When you define a crawler, the\n partitionKey type is created as a STRING, to be compatible with the catalog\n partitions.

\n \n

\n Sample API Call:

" + "smithy.api#documentation": "

An expression that filters the partitions to be returned.

\n

The expression uses SQL syntax similar to the SQL WHERE filter clause. The\n SQL statement parser JSQLParser parses the expression.

\n

\n Operators: The following are the operators that you can use in the\n Expression API call:

\n
\n
=
\n
\n

Checks whether the values of the two operands are equal; if yes, then the condition becomes\n true.

\n

Example: Assume 'variable a' holds 10 and 'variable b' holds 20.

\n

(a = b) is not true.

\n
\n
< >
\n
\n

Checks whether the values of two operands are equal; if the values are not equal,\n then the condition becomes true.

\n

Example: (a < > b) is true.

\n
\n
>
\n
\n

Checks whether the value of the left operand is greater than the value of the right\n operand; if yes, then the condition becomes true.

\n

Example: (a > b) is not true.

\n
\n
<
\n
\n

Checks whether the value of the left operand is less than the value of the right\n operand; if yes, then the condition becomes true.

\n

Example: (a < b) is true.

\n
\n
>=
\n
\n

Checks whether the value of the left operand is greater than or equal to the value\n of the right operand; if yes, then the condition becomes true.

\n

Example: (a >= b) is not true.

\n
\n
<=
\n
\n

Checks whether the value of the left operand is less than or equal to the value of\n the right operand; if yes, then the condition becomes true.

\n

Example: (a <= b) is true.

\n
\n
AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL
\n
\n

Logical operators.

\n
\n
\n

\n Supported Partition Key Types: The following are the supported\n partition keys.

\n \n

If an type is encountered that is not valid, an exception is thrown.

\n

The following list shows the valid operators on each type. When you define a crawler, the\n partitionKey type is created as a STRING, to be compatible with the catalog\n partitions.

\n \n

\n Sample API Call:

" } }, "NextToken": { @@ -9607,7 +9611,7 @@ "AdditionalPlanOptionsMap": { "target": "com.amazonaws.glue#AdditionalPlanOptionsMap", "traits": { - "smithy.api#documentation": "

A map to hold additional optional key-value parameters.

\n\t\n\t

Currently, these key-value pairs are supported:

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

A map to hold additional optional key-value parameters.

\n\t\n\t

Currently, these key-value pairs are supported:

\n\t\n\t " } } } @@ -9731,7 +9735,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the resource policies set on individual resources by AWS Resource Access Manager\n during cross-account permission grants. Also retrieves the Data Catalog resource\n policy.

\n

If you enabled metadata encryption in Data Catalog settings, and you do not have\n permission on the AWS KMS key, the operation can't return the Data Catalog resource\n policy.

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

Retrieves the resource policies set on individual resources by Resource Access Manager\n during cross-account permission grants. Also retrieves the Data Catalog resource\n policy.

\n

If you enabled metadata encryption in Data Catalog settings, and you do not have\n permission on the KMS key, the operation can't return the Data Catalog resource\n policy.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -9812,7 +9816,7 @@ "ResourceArn": { "target": "com.amazonaws.glue#GlueResourceArn", "traits": { - "smithy.api#documentation": "

The ARN of the AWS Glue resource for which to retrieve the resource policy. If not\n supplied, the Data Catalog resource policy is returned. Use GetResourcePolicies\n to view all existing resource policies. For more information see Specifying AWS Glue Resource ARNs.\n

" + "smithy.api#documentation": "

The ARN of the Glue resource for which to retrieve the resource policy. If not\n supplied, the Data Catalog resource policy is returned. Use GetResourcePolicies\n to view all existing resource policies. For more information see Specifying Glue Resource ARNs.\n

" } } } @@ -9935,7 +9939,7 @@ "DataFormat": { "target": "com.amazonaws.glue#DataFormat", "traits": { - "smithy.api#documentation": "

The data format of the schema definition. Currently only AVRO is supported.

" + "smithy.api#documentation": "

The data format of the schema definition. Currently only AVRO and JSON are supported.

" } }, "Status": { @@ -10000,7 +10004,7 @@ "DataFormat": { "target": "com.amazonaws.glue#DataFormat", "traits": { - "smithy.api#documentation": "

The data format of the schema definition. Currently only AVRO is supported.

" + "smithy.api#documentation": "

The data format of the schema definition. Currently AVRO and JSON are supported.

" } }, "Compatibility": { @@ -10114,7 +10118,7 @@ "DataFormat": { "target": "com.amazonaws.glue#DataFormat", "traits": { - "smithy.api#documentation": "

The data format of the schema definition. Currently only AVRO is supported.

" + "smithy.api#documentation": "

The data format of the schema definition. Currently AVRO and JSON are supported.

" } }, "SchemaArn": { @@ -10363,7 +10367,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the table resides. If none is provided, the AWS account\n ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account\n ID is used by default.

" } }, "DatabaseName": { @@ -10428,7 +10432,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the tables reside. If none is provided, the AWS account\n ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account\n ID is used by default.

" } }, "DatabaseName": { @@ -10510,7 +10514,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the tables reside. If none is provided, the AWS account\n ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account\n ID is used by default.

" } }, "DatabaseName": { @@ -10598,7 +10602,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the tables reside. If none is provided, the AWS account\n ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account\n ID is used by default.

" } }, "DatabaseName": { @@ -10849,7 +10853,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the function to be retrieved is located. If none is\n provided, the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the function to be retrieved is located. If none is\n provided, the Amazon Web Services account ID is used by default.

" } }, "DatabaseName": { @@ -10919,7 +10923,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the functions to be retrieved are located. If none is\n provided, the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the functions to be retrieved are located. If none is\n provided, the Amazon Web Services account ID is used by default.

" } }, "DatabaseName": { @@ -11280,32 +11284,32 @@ "DatabaseName": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

A database name in the AWS Glue Data Catalog.

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

A database name in the Glue Data Catalog.

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

A table name in the AWS Glue Data Catalog.

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

A table name in the Glue Data Catalog.

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

A unique identifier for the AWS Glue Data Catalog.

" + "smithy.api#documentation": "

A unique identifier for the Glue Data Catalog.

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

The name of the connection to the AWS Glue Data Catalog.

" + "smithy.api#documentation": "

The name of the connection to the Glue Data Catalog.

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

The database and table in the AWS Glue Data Catalog that is used for input or output data.

" + "smithy.api#documentation": "

The database and table in the Glue Data Catalog that is used for input or output data.

" } }, "com.amazonaws.glue#GlueTables": { @@ -11460,7 +11464,7 @@ } ], "traits": { - "smithy.api#documentation": "

Imports an existing Amazon Athena Data Catalog to AWS Glue

" + "smithy.api#documentation": "

Imports an existing Amazon Athena Data Catalog to Glue.

" } }, "com.amazonaws.glue#ImportCatalogToGlueRequest": { @@ -11469,7 +11473,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the catalog to import. Currently, this should be the AWS account ID.

" + "smithy.api#documentation": "

The ID of the catalog to import. Currently, this should be the Amazon Web Services account ID.

" } } } @@ -11626,13 +11630,13 @@ "Command": { "target": "com.amazonaws.glue#JobCommand", "traits": { - "smithy.api#documentation": "

The JobCommand that executes this job.

" + "smithy.api#documentation": "

The JobCommand that runs this job.

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

The default arguments for this job, specified as name-value pairs.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that AWS Glue itself consumes.

\n

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" + "smithy.api#documentation": "

The default arguments for this job, specified as name-value pairs.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that Glue itself consumes.

\n

For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

" } }, "NonOverridableArguments": { @@ -11659,7 +11663,7 @@ "smithy.api#deprecated": { "message": "This property is deprecated, use MaxCapacity instead." }, - "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n\t \n

The number of AWS Glue data processing units (DPUs) allocated to runs of this job. You can\n allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the AWS Glue pricing\n page.

\n\t

" + "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n\t \n

The number of Glue data processing units (DPUs) allocated to runs of this job. You can\n allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the Glue pricing\n page.

\n\t

" } }, "Timeout": { @@ -11671,7 +11675,7 @@ "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the AWS Glue\n pricing page.

\n\t \n\t

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n\t\n\t

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL\n job:

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

For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.

\n\t \n\t

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n\t\n\t

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL\n job:

\n \n

For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.

" } }, "WorkerType": { @@ -11701,7 +11705,7 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Jobs that are created without specifying a Glue version default to Glue 0.9.

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Jobs that are created without specifying a Glue version default to Glue 0.9.

" } } }, @@ -11806,18 +11810,18 @@ "ScriptLocation": { "target": "com.amazonaws.glue#ScriptLocationString", "traits": { - "smithy.api#documentation": "

Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that executes a\n job.

" + "smithy.api#documentation": "

Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that runs a\n job.

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

The Python version being used to execute a Python shell job. Allowed values are 2 or 3.

" + "smithy.api#documentation": "

The Python version being used to run a Python shell job. Allowed values are 2 or 3.

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

Specifies code executed when a job is run.

" + "smithy.api#documentation": "

Specifies code that runs when a job is run.

" } }, "com.amazonaws.glue#JobList": { @@ -11903,13 +11907,13 @@ "JobRunState": { "target": "com.amazonaws.glue#JobRunState", "traits": { - "smithy.api#documentation": "

The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see AWS Glue Job Run Statuses.

" + "smithy.api#documentation": "

The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.

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

The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that AWS Glue itself consumes.

\n

For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" + "smithy.api#documentation": "

The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that Glue itself consumes.

\n

For information about how to specify and consume your own job arguments, see the Calling Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

" } }, "ErrorMessage": { @@ -11930,7 +11934,7 @@ "smithy.api#deprecated": { "message": "This property is deprecated, use MaxCapacity instead." }, - "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n\n

The number of AWS Glue data processing units (DPUs) allocated to this JobRun.\n From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the AWS Glue\n pricing page.

" + "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n\n

The number of Glue data processing units (DPUs) allocated to this JobRun.\n From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.

" } }, "ExecutionTime": { @@ -11948,7 +11952,7 @@ "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the AWS Glue\n pricing page.

\n\n

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n\n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:

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

The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.

\n\n

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n\n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:

\n " } }, "WorkerType": { @@ -11972,7 +11976,7 @@ "LogGroupName": { "target": "com.amazonaws.glue#GenericString", "traits": { - "smithy.api#documentation": "

The name of the log group for secure logging that can be server-side encrypted in Amazon\n CloudWatch using AWS KMS. This name can be /aws-glue/jobs/, in which case the\n default encryption is NONE. If you add a role name and\n SecurityConfiguration name (in other words,\n /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security\n configuration is used to encrypt the log group.

" + "smithy.api#documentation": "

The name of the log group for secure logging that can be server-side encrypted in Amazon\n CloudWatch using KMS. This name can be /aws-glue/jobs/, in which case the\n default encryption is NONE. If you add a role name and\n SecurityConfiguration name (in other words,\n /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security\n configuration is used to encrypt the log group.

" } }, "NotificationProperty": { @@ -11984,7 +11988,7 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Jobs that are created without specifying a Glue version default to Glue 0.9.

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Jobs that are created without specifying a Glue version default to Glue 0.9.

" } } }, @@ -12063,13 +12067,13 @@ "Command": { "target": "com.amazonaws.glue#JobCommand", "traits": { - "smithy.api#documentation": "

The JobCommand that executes this job (required).

" + "smithy.api#documentation": "

The JobCommand that runs this job (required).

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

The default arguments for this job.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that AWS Glue itself consumes.

\n

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" + "smithy.api#documentation": "

The default arguments for this job.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that Glue itself consumes.

\n

For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

" } }, "NonOverridableArguments": { @@ -12096,7 +12100,7 @@ "smithy.api#deprecated": { "message": "This property is deprecated, use MaxCapacity instead." }, - "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n \n

The number of AWS Glue data processing units (DPUs) to allocate to this job. You can\n allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the AWS Glue pricing\n page.

" + "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n \n

The number of Glue data processing units (DPUs) to allocate to this job. You can\n allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the Glue pricing\n page.

" } }, "Timeout": { @@ -12108,7 +12112,7 @@ "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

\n \n\t

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\t \n\t \n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:

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

For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.

\n \n\t

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\t \n\t \n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:

\n\n \t\t\n\t

For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.

" } }, "WorkerType": { @@ -12138,7 +12142,7 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

" + "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

" } } }, @@ -12177,7 +12181,7 @@ "JsonPath": { "target": "com.amazonaws.glue#JsonPath", "traits": { - "smithy.api#documentation": "

A JsonPath string defining the JSON data for the classifier to classify.\n AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

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

A JsonPath string defining the JSON data for the classifier to classify.\n Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

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

Retrieves the names of all crawler resources in this AWS account, or the\n resources with the specified tag. This operation allows you to see which\n resources are available in your account, and their names.

\n\n

This operation takes the optional Tags field, which you can use as a filter on\n the response so that tagged resources can be retrieved as a group. If you choose to use tags\n filtering, only resources with the tag are retrieved.

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

Retrieves the names of all crawler resources in this Amazon Web Services account, or the\n resources with the specified tag. This operation allows you to see which\n resources are available in your account, and their names.

\n\n

This operation takes the optional Tags field, which you can use as a filter on\n the response so that tagged resources can be retrieved as a group. If you choose to use tags\n filtering, only resources with the tag are retrieved.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -12449,7 +12453,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the names of all DevEndpoint resources in this AWS account, or the\n resources with the specified tag. This operation allows you to see which resources are\n available in your account, and their names.

\n\n

This operation takes the optional Tags field, which you can use as a filter on\n the response so that tagged resources can be retrieved as a group. If you choose to use tags\n filtering, only resources with the tag are retrieved.

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

Retrieves the names of all DevEndpoint resources in this Amazon Web Services account, or the\n resources with the specified tag. This operation allows you to see which resources are\n available in your account, and their names.

\n\n

This operation takes the optional Tags field, which you can use as a filter on\n the response so that tagged resources can be retrieved as a group. If you choose to use tags\n filtering, only resources with the tag are retrieved.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -12520,7 +12524,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the names of all job resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

\n\t\n\t

This operation takes the optional Tags field, which you can use as a filter on\n the response so that tagged resources can be retrieved as a group. If you choose to use tags\n filtering, only resources with the tag are retrieved.

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

Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

\n\t\n\t

This operation takes the optional Tags field, which you can use as a filter on\n the response so that tagged resources can be retrieved as a group. If you choose to use tags\n filtering, only resources with the tag are retrieved.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -12591,7 +12595,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a sortable, filterable list of existing AWS Glue machine learning transforms in this AWS account,\n or the resources with the specified tag. This operation takes the optional Tags field, which you can use as\n a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag\n filtering, only resources with the tags are retrieved.\n

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

Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account,\n or the resources with the specified tag. This operation takes the optional Tags field, which you can use as\n a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag\n filtering, only resources with the tags are retrieved.\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -12883,7 +12887,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the names of all trigger resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

\n\n

This operation takes the optional Tags field, which you can use as a filter on\n the response so that tagged resources can be retrieved as a group. If you choose to use tags\n filtering, only resources with the tag are retrieved.

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

Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

\n\n

This operation takes the optional Tags field, which you can use as a filter on\n the response so that tagged resources can be retrieved as a group. If you choose to use tags\n filtering, only resources with the tag are retrieved.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -13169,7 +13173,7 @@ "InputRecordTables": { "target": "com.amazonaws.glue#GlueTables", "traits": { - "smithy.api#documentation": "

A list of AWS Glue table definitions used by the transform.

" + "smithy.api#documentation": "

A list of Glue table definitions used by the transform.

" } }, "Parameters": { @@ -13187,7 +13191,7 @@ "LabelCount": { "target": "com.amazonaws.glue#LabelCount", "traits": { - "smithy.api#documentation": "

A count identifier for the labeling files generated by AWS Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.

" + "smithy.api#documentation": "

A count identifier for the labeling files generated by Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.

" } }, "Schema": { @@ -13199,19 +13203,19 @@ "Role": { "target": "com.amazonaws.glue#RoleString", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.

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

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.

\n\n\t\t " } }, "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

" + "smithy.api#documentation": "

This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.

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

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the AWS Glue pricing\n page.

\n\t\t\n\t\t

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n \n\t\t\n\t

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" + "smithy.api#documentation": "

The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the Glue pricing\n page.

\n\t\t\n\t\t

\n MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

\n \n\t\t\n\t

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" } }, "WorkerType": { @@ -13270,7 +13274,7 @@ "MlUserDataEncryptionMode": { "target": "com.amazonaws.glue#MLUserDataEncryptionModeString", "traits": { - "smithy.api#documentation": "

The encryption mode applied to user data. Valid values are:

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

The encryption mode applied to user data. Valid values are:

\n\t\n\t ", "smithy.api#required": {} } }, @@ -13559,13 +13563,13 @@ "Type": { "target": "com.amazonaws.glue#NodeType", "traits": { - "smithy.api#documentation": "

The type of AWS Glue component represented by the node.

" + "smithy.api#documentation": "

The type of Glue component represented by the node.

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

The name of the AWS Glue component represented by the node.

" + "smithy.api#documentation": "

The name of the Glue component represented by the node.

" } }, "UniqueId": { @@ -13594,7 +13598,7 @@ } }, "traits": { - "smithy.api#documentation": "

A node represents an AWS Glue component such as a trigger, or job, etc., that is part of a workflow.

" + "smithy.api#documentation": "

A node represents an Glue component such as a trigger, or job, etc., that is part of a workflow.

" } }, "com.amazonaws.glue#NodeIdList": { @@ -13991,7 +13995,7 @@ "Values": { "target": "com.amazonaws.glue#ValueStringList", "traits": { - "smithy.api#documentation": "

The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.

\n\t\n\t

The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise AWS Glue will add the values to the wrong keys.

" + "smithy.api#documentation": "

The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.

\n\t\n\t

The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.

" } }, "LastAccessTime": { @@ -14317,7 +14321,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog to set the security configuration for. If none is provided, the\n AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog to set the security configuration for. If none is provided, the\n Amazon Web Services account ID is used by default.

" } }, "DataCatalogEncryptionSettings": { @@ -14393,7 +14397,7 @@ "EnableHybrid": { "target": "com.amazonaws.glue#EnableHybridValues", "traits": { - "smithy.api#documentation": "

If 'TRUE', indicates that you are using both methods to grant cross-account\n access to Data Catalog resources:

\n \n

Must be set to 'TRUE' if you have already used the Management Console to\n grant cross-account access, otherwise the call fails. Default is 'FALSE'.

" + "smithy.api#documentation": "

If 'TRUE', indicates that you are using both methods to grant cross-account\n access to Data Catalog resources:

\n \n

Must be set to 'TRUE' if you have already used the Management Console to\n grant cross-account access, otherwise the call fails. Default is 'FALSE'.

" } } } @@ -14723,7 +14727,7 @@ } }, "traits": { - "smithy.api#documentation": "

When crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. For more information, see Incremental Crawls in AWS Glue in the developer guide.

" + "smithy.api#documentation": "

When crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. For more information, see Incremental Crawls in Glue in the developer guide.

" } }, "com.amazonaws.glue#RegisterSchemaVersion": { @@ -15496,7 +15500,7 @@ } }, "traits": { - "smithy.api#documentation": "

The unique ID of the schema in the AWS Glue schema registry.

" + "smithy.api#documentation": "

The unique ID of the schema in the Glue schema registry.

" } }, "com.amazonaws.glue#SchemaListDefinition": { @@ -15582,7 +15586,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object that references a schema stored in the AWS Glue Schema Registry.

" + "smithy.api#documentation": "

An object that references a schema stored in the Glue Schema Registry.

" } }, "com.amazonaws.glue#SchemaRegistryNameString": { @@ -15913,7 +15917,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines a non-overlapping region of a table's partitions, allowing\n multiple requests to be executed in parallel.

" + "smithy.api#documentation": "

Defines a non-overlapping region of a table's partitions, allowing\n multiple requests to be run in parallel.

" } }, "com.amazonaws.glue#SerDeInfo": { @@ -16196,7 +16200,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables you to provide additional labels (examples of truth) to be used to teach the\n machine learning transform and improve its quality. This API operation is generally used as\n part of the active learning workflow that starts with the\n StartMLLabelingSetGenerationTaskRun call and that ultimately results in\n improving the quality of your machine learning transform.

\n\n

After the StartMLLabelingSetGenerationTaskRun finishes, AWS Glue machine learning\n will have generated a series of questions for humans to answer. (Answering these questions is\n often called 'labeling' in the machine learning workflows). In the case of the\n FindMatches transform, these questions are of the form, “What is the correct\n way to group these rows together into groups composed entirely of matching records?” After the\n labeling process is finished, users upload their answers/labels with a call to\n StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes,\n all future runs of the machine learning transform use the new and improved labels and perform\n a higher-quality transformation.

\n\n

By default, StartMLLabelingSetGenerationTaskRun continually learns from and\n combines all labels that you upload unless you set Replace to true. If you set\n Replace to true, StartImportLabelsTaskRun deletes and forgets all\n previously uploaded labels and learns only from the exact set that you upload. Replacing\n labels can be helpful if you realize that you previously uploaded incorrect labels, and you\n believe that they are having a negative effect on your transform quality.

\n\n

You can check on the status of your task run by calling the GetMLTaskRun\n operation.

" + "smithy.api#documentation": "

Enables you to provide additional labels (examples of truth) to be used to teach the\n machine learning transform and improve its quality. This API operation is generally used as\n part of the active learning workflow that starts with the\n StartMLLabelingSetGenerationTaskRun call and that ultimately results in\n improving the quality of your machine learning transform.

\n\n

After the StartMLLabelingSetGenerationTaskRun finishes, Glue machine learning\n will have generated a series of questions for humans to answer. (Answering these questions is\n often called 'labeling' in the machine learning workflows). In the case of the\n FindMatches transform, these questions are of the form, “What is the correct\n way to group these rows together into groups composed entirely of matching records?” After the\n labeling process is finished, users upload their answers/labels with a call to\n StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes,\n all future runs of the machine learning transform use the new and improved labels and perform\n a higher-quality transformation.

\n\n

By default, StartMLLabelingSetGenerationTaskRun continually learns from and\n combines all labels that you upload unless you set Replace to true. If you set\n Replace to true, StartImportLabelsTaskRun deletes and forgets all\n previously uploaded labels and learns only from the exact set that you upload. Replacing\n labels can be helpful if you realize that you previously uploaded incorrect labels, and you\n believe that they are having a negative effect on your transform quality.

\n\n

You can check on the status of your task run by calling the GetMLTaskRun\n operation.

" } }, "com.amazonaws.glue#StartImportLabelsTaskRunRequest": { @@ -16286,7 +16290,7 @@ "Arguments": { "target": "com.amazonaws.glue#GenericMap", "traits": { - "smithy.api#documentation": "

The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that AWS Glue itself consumes.

\n

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" + "smithy.api#documentation": "

The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

\n

You can specify arguments here that your own job-execution script\n consumes, as well as arguments that Glue itself consumes.

\n

For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.

\n

For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

" } }, "AllocatedCapacity": { @@ -16295,7 +16299,7 @@ "smithy.api#deprecated": { "message": "This property is deprecated, use MaxCapacity instead." }, - "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n\n

The number of AWS Glue data processing units (DPUs) to allocate to this JobRun.\n From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the AWS Glue\n pricing page.

" + "smithy.api#documentation": "

This field is deprecated. Use MaxCapacity instead.

\n\n

The number of Glue data processing units (DPUs) to allocate to this JobRun.\n From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.

" } }, "Timeout": { @@ -16307,7 +16311,7 @@ "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the AWS Glue\n pricing page.

\n\n

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n\n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job, or an Apache Spark ETL job:

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

The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.

\n\n

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

\n\n

The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job, or an Apache Spark ETL job:

\n " } }, "SecurityConfiguration": { @@ -16376,7 +16380,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a task to estimate the quality of the transform.

\n\t\n\t

When you provide label sets as examples of truth, AWS Glue machine learning uses some of\n those examples to learn from them. The rest of the labels are used as a test to estimate\n quality.

\n\t\n\t

Returns a unique identifier for the run. You can call GetMLTaskRun to get more\n information about the stats of the EvaluationTaskRun.

" + "smithy.api#documentation": "

Starts a task to estimate the quality of the transform.

\n\t\n\t

When you provide label sets as examples of truth, Glue machine learning uses some of\n those examples to learn from them. The rest of the labels are used as a test to estimate\n quality.

\n\t\n\t

Returns a unique identifier for the run. You can call GetMLTaskRun to get more\n information about the stats of the EvaluationTaskRun.

" } }, "com.amazonaws.glue#StartMLEvaluationTaskRunRequest": { @@ -16428,7 +16432,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts the active learning workflow for your machine learning transform to improve the\n transform's quality by generating label sets and adding labels.

\n\t\n\t

When the StartMLLabelingSetGenerationTaskRun finishes, AWS Glue will have\n generated a \"labeling set\" or a set of questions for humans to answer.

\n \n

In the case of the FindMatches transform, these questions are of the form,\n “What is the correct way to group these rows together into groups composed entirely of\n matching records?”

\n \n

After the labeling process is finished, you can upload your labels with a call to\n StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes,\n all future runs of the machine learning transform will use the new and improved labels and\n perform a higher-quality transformation.

" + "smithy.api#documentation": "

Starts the active learning workflow for your machine learning transform to improve the\n transform's quality by generating label sets and adding labels.

\n\t\n\t

When the StartMLLabelingSetGenerationTaskRun finishes, Glue will have\n generated a \"labeling set\" or a set of questions for humans to answer.

\n \n

In the case of the FindMatches transform, these questions are of the form,\n “What is the correct way to group these rows together into groups composed entirely of\n matching records?”

\n \n

After the labeling process is finished, you can upload your labels with a call to\n StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes,\n all future runs of the machine learning transform will use the new and improved labels and\n perform a higher-quality transformation.

" } }, "com.amazonaws.glue#StartMLLabelingSetGenerationTaskRunRequest": { @@ -16837,7 +16841,7 @@ "SchemaReference": { "target": "com.amazonaws.glue#SchemaReference", "traits": { - "smithy.api#documentation": "

An object that references a schema stored in the AWS Glue Schema Registry.

\n\t\n\t

When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.

" + "smithy.api#documentation": "

An object that references a schema stored in the Glue Schema Registry.

\n\t\n\t

When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.

" } } }, @@ -16990,7 +16994,7 @@ "IsRegisteredWithLakeFormation": { "target": "com.amazonaws.glue#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the table has been registered with AWS Lake Formation.

" + "smithy.api#documentation": "

Indicates whether the table has been registered with Lake Formation.

" } }, "TargetTable": { @@ -17272,7 +17276,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds tags to a resource. A tag is a label you can assign to an AWS resource.\n In AWS Glue, you can tag only certain resources. For information about what\n resources you can tag, see AWS Tags in AWS Glue.

" + "smithy.api#documentation": "

Adds tags to a resource. A tag is a label you can assign to an Amazon Web Services resource.\n In Glue, you can tag only certain resources. For information about what\n resources you can tag, see Amazon Web Services Tags in Glue.

" } }, "com.amazonaws.glue#TagResourceRequest": { @@ -17281,7 +17285,7 @@ "ResourceArn": { "target": "com.amazonaws.glue#GlueResourceArn", "traits": { - "smithy.api#documentation": "

The ARN of the AWS Glue resource to which to add the tags. For more\n information about AWS Glue resource ARNs, see the AWS Glue ARN string pattern.

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

The ARN of the Glue resource to which to add the tags. For more\n information about Glue resource ARNs, see the Glue ARN string pattern.

", "smithy.api#required": {} } }, @@ -17640,7 +17644,7 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

" + "smithy.api#documentation": "

This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.

" } }, "CreatedBefore": { @@ -18164,7 +18168,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the Amazon Web Services account ID is used by default.

" } }, "DatabaseName": { @@ -18243,7 +18247,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the partitions in question reside.\n If none is supplied, the Amazon Web Services account ID is used by default.

" } }, "DatabaseName": { @@ -18324,7 +18328,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which the connection resides. If none is provided, the AWS\n account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog in which the connection resides. If none is provided, the Amazon Web Services\n account ID is used by default.

" } }, "Name": { @@ -18395,7 +18399,7 @@ "DatabaseName": { "target": "com.amazonaws.glue#DatabaseName", "traits": { - "smithy.api#documentation": "

The AWS Glue database where results are stored, such as:\n arn:aws:daylight:us-east-1::database/sometable/*.

" + "smithy.api#documentation": "

The Glue database where results are stored, such as:\n arn:aws:daylight:us-east-1::database/sometable/*.

" } }, "Description": { @@ -18601,7 +18605,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog in which the metadata database resides. If none is provided,\n the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog in which the metadata database resides. If none is provided,\n the Amazon Web Services account ID is used by default.

" } }, "Name": { @@ -18702,7 +18706,7 @@ "AddArguments": { "target": "com.amazonaws.glue#MapValue", "traits": { - "smithy.api#documentation": "

The map of arguments to add the map of arguments used to configure the\n DevEndpoint.

\n\t\t\n\t

Valid arguments are:

\n\t \n\t\n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + "smithy.api#documentation": "

The map of arguments to add the map of arguments used to configure the\n DevEndpoint.

\n\t\t\n\t

Valid arguments are:

\n\t \n\t\n

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" } } } @@ -18816,7 +18820,7 @@ "JsonPath": { "target": "com.amazonaws.glue#JsonPath", "traits": { - "smithy.api#documentation": "

A JsonPath string defining the JSON data for the classifier to classify.\n AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

" + "smithy.api#documentation": "

A JsonPath string defining the JSON data for the classifier to classify.\n Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

" } } }, @@ -18890,13 +18894,13 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "

This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see AWS Glue Versions in the developer guide.

" + "smithy.api#documentation": "

This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.

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

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the AWS Glue pricing\n page.

\n\t\t\n

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" + "smithy.api#documentation": "

The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of\n processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more\n information, see the Glue pricing\n page.

\n\t\t\n

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" } }, "WorkerType": { @@ -18971,7 +18975,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the partition to be updated resides. If none is provided,\n the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the partition to be updated resides. If none is provided,\n the Amazon Web Services account ID is used by default.

" } }, "DatabaseName": { @@ -19196,7 +19200,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the table resides. If none is provided, the AWS account\n ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the table resides. If none is provided, the Amazon Web Services account\n ID is used by default.

" } }, "DatabaseName": { @@ -19319,7 +19323,7 @@ "CatalogId": { "target": "com.amazonaws.glue#CatalogIdString", "traits": { - "smithy.api#documentation": "

The ID of the Data Catalog where the function to be updated is located. If none is\n provided, the AWS account ID is used by default.

" + "smithy.api#documentation": "

The ID of the Data Catalog where the function to be updated is located. If none is\n provided, the Amazon Web Services account ID is used by default.

" } }, "DatabaseName": { @@ -19699,7 +19703,7 @@ "Graph": { "target": "com.amazonaws.glue#WorkflowGraph", "traits": { - "smithy.api#documentation": "

The graph representing all the AWS Glue components that belong to the workflow as nodes and directed\n connections between them as edges.

" + "smithy.api#documentation": "

The graph representing all the Glue components that belong to the workflow as nodes and directed\n connections between them as edges.

" } }, "MaxConcurrentRuns": { @@ -19710,7 +19714,7 @@ } }, "traits": { - "smithy.api#documentation": "

A workflow represents a flow in which AWS Glue components should be executed to complete a logical\n task.

" + "smithy.api#documentation": "

A workflow represents a flow in which Glue components should be run to complete a logical\n task.

" } }, "com.amazonaws.glue#WorkflowGraph": { @@ -19719,7 +19723,7 @@ "Nodes": { "target": "com.amazonaws.glue#NodeList", "traits": { - "smithy.api#documentation": "

A list of the the AWS Glue components belong to the workflow represented as nodes.

" + "smithy.api#documentation": "

A list of the the Glue components belong to the workflow represented as nodes.

" } }, "Edges": { @@ -19730,7 +19734,7 @@ } }, "traits": { - "smithy.api#documentation": "

A workflow graph represents the complete workflow containing all the AWS Glue components present in the\n workflow and all the directed connections between them.

" + "smithy.api#documentation": "

A workflow graph represents the complete workflow containing all the Glue components present in the\n workflow and all the directed connections between them.

" } }, "com.amazonaws.glue#WorkflowNames": { @@ -19751,7 +19755,7 @@ "Name": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

Name of the workflow that was executed.

" + "smithy.api#documentation": "

Name of the workflow that was run.

" } }, "WorkflowRunId": { @@ -19805,7 +19809,7 @@ "Graph": { "target": "com.amazonaws.glue#WorkflowGraph", "traits": { - "smithy.api#documentation": "

The graph representing all the AWS Glue components that belong to the workflow as nodes and directed\n connections between them as edges.

" + "smithy.api#documentation": "

The graph representing all the Glue components that belong to the workflow as nodes and directed\n connections between them as edges.

" } } }, diff --git a/aws/sdk/aws-models/greengrassv2.json b/aws/sdk/aws-models/greengrassv2.json index 76e008db0..5bdd9316e 100644 --- a/aws/sdk/aws-models/greengrassv2.json +++ b/aws/sdk/aws-models/greengrassv2.json @@ -45,6 +45,231 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.greengrassv2#AssociateClientDeviceWithCoreDeviceEntry": { + "type": "structure", + "members": { + "thingName": { + "target": "com.amazonaws.greengrassv2#IoTThingName", + "traits": { + "smithy.api#documentation": "

The name of the AWS IoT thing that represents the client device to associate.

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

Contains a request to associate a client device with a core device. The BatchAssociateClientDeviceWithCoreDevice operation consumes a list of these\n requests.

" + } + }, + "com.amazonaws.greengrassv2#AssociateClientDeviceWithCoreDeviceEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#AssociateClientDeviceWithCoreDeviceEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.greengrassv2#AssociateClientDeviceWithCoreDeviceErrorEntry": { + "type": "structure", + "members": { + "thingName": { + "target": "com.amazonaws.greengrassv2#IoTThingName", + "traits": { + "smithy.api#documentation": "

The name of the AWS IoT thing whose associate request failed.

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

The error code for the request.

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

A message that provides additional information about the error.

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

Contains an error that occurs from a request to associate a client device with a core\n device. The BatchAssociateClientDeviceWithCoreDevice operation returns a list of these\n errors.

" + } + }, + "com.amazonaws.greengrassv2#AssociateClientDeviceWithCoreDeviceErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#AssociateClientDeviceWithCoreDeviceErrorEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.greengrassv2#AssociatedClientDevice": { + "type": "structure", + "members": { + "thingName": { + "target": "com.amazonaws.greengrassv2#IoTThingName", + "traits": { + "smithy.api#documentation": "

The name of the AWS IoT thing that represents the associated client device.

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

The time that the client device was associated, expressed in ISO 8601 format.

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

Contains information about a client device that is associated to a core device for cloud\n discovery.

" + } + }, + "com.amazonaws.greengrassv2#AssociatedClientDeviceList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#AssociatedClientDevice" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.greengrassv2#BatchAssociateClientDeviceWithCoreDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#BatchAssociateClientDeviceWithCoreDeviceRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#BatchAssociateClientDeviceWithCoreDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associate a list of client devices with a core device. Use this API operation to specify\n which client devices can discover a core device through cloud discovery. With cloud discovery,\n client devices connect to AWS IoT Greengrass to retrieve associated core devices' connectivity information\n and certificates. For more information, see Configure cloud\n discovery in the AWS IoT Greengrass V2 Developer Guide.

\n \n \n

Client devices are local IoT devices that connect to and communicate with an AWS IoT Greengrass core\n device over MQTT. You can connect client devices to a core device to sync MQTT messages and\n data to AWS IoT Core and interact with client devices in AWS IoT Greengrass components. For more information,\n see Interact with\n local IoT devices in the AWS IoT Greengrass V2 Developer Guide.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/greengrass/v2/coreDevices/{coreDeviceThingName}/associateClientDevices", + "code": 200 + } + } + }, + "com.amazonaws.greengrassv2#BatchAssociateClientDeviceWithCoreDeviceRequest": { + "type": "structure", + "members": { + "entries": { + "target": "com.amazonaws.greengrassv2#AssociateClientDeviceWithCoreDeviceEntryList", + "traits": { + "smithy.api#documentation": "

The list of client devices to associate.

" + } + }, + "coreDeviceThingName": { + "target": "com.amazonaws.greengrassv2#IoTThingName", + "traits": { + "smithy.api#documentation": "

The name of the core device. This is also the name of the AWS IoT thing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#BatchAssociateClientDeviceWithCoreDeviceResponse": { + "type": "structure", + "members": { + "errorEntries": { + "target": "com.amazonaws.greengrassv2#AssociateClientDeviceWithCoreDeviceErrorList", + "traits": { + "smithy.api#documentation": "

The list of any errors for the entries in the request. Each error entry contains the name\n of the AWS IoT thing that failed to associate.

" + } + } + } + }, + "com.amazonaws.greengrassv2#BatchDisassociateClientDeviceFromCoreDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#BatchDisassociateClientDeviceFromCoreDeviceRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#BatchDisassociateClientDeviceFromCoreDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociate a list of client devices from a core device. After you disassociate a client\n device from a core device, the client device won't be able to use cloud discovery to retrieve\n the core device's connectivity information and certificates.

", + "smithy.api#http": { + "method": "POST", + "uri": "/greengrass/v2/coreDevices/{coreDeviceThingName}/disassociateClientDevices", + "code": 200 + } + } + }, + "com.amazonaws.greengrassv2#BatchDisassociateClientDeviceFromCoreDeviceRequest": { + "type": "structure", + "members": { + "entries": { + "target": "com.amazonaws.greengrassv2#DisassociateClientDeviceFromCoreDeviceEntryList", + "traits": { + "smithy.api#documentation": "

The list of client devices to disassociate.

" + } + }, + "coreDeviceThingName": { + "target": "com.amazonaws.greengrassv2#IoTThingName", + "traits": { + "smithy.api#documentation": "

The name of the core device. This is also the name of the AWS IoT thing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#BatchDisassociateClientDeviceFromCoreDeviceResponse": { + "type": "structure", + "members": { + "errorEntries": { + "target": "com.amazonaws.greengrassv2#DisassociateClientDeviceFromCoreDeviceErrorList", + "traits": { + "smithy.api#documentation": "

The list of errors (if any) for the entries in the request. Each error entry contains the\n name of the AWS IoT thing that failed to disassociate.

" + } + } + } + }, "com.amazonaws.greengrassv2#CancelDeployment": { "type": "operation", "input": { @@ -1263,6 +1488,71 @@ "com.amazonaws.greengrassv2#DescriptionString": { "type": "string" }, + "com.amazonaws.greengrassv2#DisassociateClientDeviceFromCoreDeviceEntry": { + "type": "structure", + "members": { + "thingName": { + "target": "com.amazonaws.greengrassv2#IoTThingName", + "traits": { + "smithy.api#documentation": "

The name of the AWS IoT thing that represents the client device to disassociate.

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

Contains a request to disassociate a client device from a core device. The BatchDisassociateClientDeviceWithCoreDevice operation consumes a list of these\n requests.

" + } + }, + "com.amazonaws.greengrassv2#DisassociateClientDeviceFromCoreDeviceEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#DisassociateClientDeviceFromCoreDeviceEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.greengrassv2#DisassociateClientDeviceFromCoreDeviceErrorEntry": { + "type": "structure", + "members": { + "thingName": { + "target": "com.amazonaws.greengrassv2#IoTThingName", + "traits": { + "smithy.api#documentation": "

The name of the AWS IoT thing whose disassociate request failed.

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

The error code for the request.

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

A message that provides additional information about the error.

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

Contains an error that occurs from a request to disassociate a client device from a core\n device. The BatchDisassociateClientDeviceWithCoreDevice operation returns a list of these\n errors.

" + } + }, + "com.amazonaws.greengrassv2#DisassociateClientDeviceFromCoreDeviceErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#DisassociateClientDeviceFromCoreDeviceErrorEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.greengrassv2#EffectiveDeployment": { "type": "structure", "members": { @@ -1770,6 +2060,12 @@ "type": "service", "version": "2020-11-30", "operations": [ + { + "target": "com.amazonaws.greengrassv2#BatchAssociateClientDeviceWithCoreDevice" + }, + { + "target": "com.amazonaws.greengrassv2#BatchDisassociateClientDeviceFromCoreDevice" + }, { "target": "com.amazonaws.greengrassv2#CancelDeployment" }, @@ -1800,6 +2096,9 @@ { "target": "com.amazonaws.greengrassv2#GetDeployment" }, + { + "target": "com.amazonaws.greengrassv2#ListClientDevicesAssociatedWithCoreDevice" + }, { "target": "com.amazonaws.greengrassv2#ListComponents" }, @@ -2205,6 +2504,15 @@ "smithy.api#documentation": "

Contains information about the timeout configuration for a job.

" } }, + "com.amazonaws.greengrassv2#IoTThingName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, "com.amazonaws.greengrassv2#IsLatestForTarget": { "type": "boolean" }, @@ -2586,6 +2894,90 @@ } } }, + "com.amazonaws.greengrassv2#ListClientDevicesAssociatedWithCoreDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#ListClientDevicesAssociatedWithCoreDeviceRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#ListClientDevicesAssociatedWithCoreDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#AccessDeniedException" + }, + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.greengrassv2#ThrottlingException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a paginated list of client devices that are associated with a core\n device.

", + "smithy.api#http": { + "method": "GET", + "uri": "/greengrass/v2/coreDevices/{coreDeviceThingName}/associatedClientDevices", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.greengrassv2#ListClientDevicesAssociatedWithCoreDeviceRequest": { + "type": "structure", + "members": { + "coreDeviceThingName": { + "target": "com.amazonaws.greengrassv2#IoTThingName", + "traits": { + "smithy.api#documentation": "

The name of the core device. This is also the name of the AWS IoT thing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.greengrassv2#DefaultMaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to be returned per paginated request.

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

The token to be used for the next set of paginated results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.greengrassv2#ListClientDevicesAssociatedWithCoreDeviceResponse": { + "type": "structure", + "members": { + "associatedClientDevices": { + "target": "com.amazonaws.greengrassv2#AssociatedClientDeviceList", + "traits": { + "smithy.api#documentation": "

A list that describes the client devices that are associated with the core device.

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

The token for the next set of results, or null if there are no additional results.

" + } + } + } + }, "com.amazonaws.greengrassv2#ListComponentVersions": { "type": "operation", "input": { @@ -2612,7 +3004,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a paginated list of all versions for a component.

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

Retrieves a paginated list of all versions for a component. Greater versions are listed first.

", "smithy.api#http": { "method": "GET", "uri": "/greengrass/v2/components/{arn}/versions", diff --git a/aws/sdk/aws-models/groundstation.json b/aws/sdk/aws-models/groundstation.json index 9af96283a..9fe4f04b6 100644 --- a/aws/sdk/aws-models/groundstation.json +++ b/aws/sdk/aws-models/groundstation.json @@ -3544,4 +3544,4 @@ } } } -} +} \ No newline at end of file diff --git a/aws/sdk/aws-models/iam.json b/aws/sdk/aws-models/iam.json index 8d8c03f2e..44507a51b 100644 --- a/aws/sdk/aws-models/iam.json +++ b/aws/sdk/aws-models/iam.json @@ -1084,6 +1084,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ConcurrentModification", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

The request was rejected because multiple requests to change this object were submitted\n simultaneously. Wait a few minutes and submit your request again.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -2147,6 +2151,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReportExpired", + "httpResponseCode": 410 + }, "smithy.api#documentation": "

The request was rejected because the most recent credential report has expired. To\n generate a new credential report, use GenerateCredentialReport. For more\n information about credential report expiration, see Getting credential reports in the\n IAM User Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 410 @@ -2160,6 +2168,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReportNotPresent", + "httpResponseCode": 410 + }, "smithy.api#documentation": "

The request was rejected because the credential report does not exist. To generate a\n credential report, use GenerateCredentialReport.

", "smithy.api#error": "client", "smithy.api#httpError": 410 @@ -2173,6 +2185,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReportInProgress", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The request was rejected because the credential report is still being generated.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -2315,6 +2331,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DeleteConflict", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

The request was rejected because it attempted to delete a resource that has attached\n subordinate entities. The error message describes these entities.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -3244,6 +3264,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DuplicateCertificate", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

The request was rejected because the same certificate is associated with an IAM user in\n the account.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -3257,6 +3281,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DuplicateSSHPublicKey", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the SSH public key is already associated with the\n specified IAM user.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3332,6 +3360,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "EntityAlreadyExists", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

The request was rejected because it attempted to create a resource that already\n exists.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -3407,6 +3439,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "EntityTemporarilyUnmodifiable", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

The request was rejected because it referenced an entity that is temporarily unmodifiable,\n such as a user name that was deleted and then recreated. The error indicates that the request\n is likely to succeed if you try again after waiting several minutes. The error message\n describes the entity.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -5370,6 +5406,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidAuthenticationCode", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

The request was rejected because the authentication code was not recognized. The error\n message describes the specific error.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -5383,6 +5423,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidCertificate", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the certificate is invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5396,6 +5440,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidInput", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because an invalid or out-of-range value was supplied for an\n input parameter.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5409,6 +5457,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidPublicKey", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the public key is malformed or otherwise invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5422,6 +5474,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidUserType", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the type of user for the transaction was\n incorrect.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5435,6 +5491,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "KeyPairMismatch", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the public key certificate and the private key do not\n match.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5448,6 +5508,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "LimitExceeded", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

The request was rejected because it attempted to create resources beyond the current AWS\n account limits. The error message describes the limit exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -8007,6 +8071,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "MalformedCertificate", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the certificate was malformed or expired. The error\n message describes the specific error.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -8020,6 +8088,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "MalformedPolicyDocument", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the policy document was malformed. The error message\n describes the specific error.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -8116,6 +8188,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "NoSuchEntity", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The request was rejected because it referenced a resource entity that does not exist. The\n error message describes the resource.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -8241,6 +8317,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "PasswordPolicyViolation", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the provided password did not meet the requirements\n imposed by the account password policy.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -8395,6 +8475,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "PolicyEvaluation", + "httpResponseCode": 500 + }, "smithy.api#documentation": "

The request failed because a provided policy could not be successfully evaluated. An\n additional detailed message indicates the source of the failure.

", "smithy.api#error": "server", "smithy.api#httpError": 500 @@ -8474,6 +8558,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "PolicyNotAttachable", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request failed because AWS service role policies can only be attached to the\n service-linked role for that service.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -9031,6 +9119,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReportGenerationLimitExceeded", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

The request failed because the maximum number of concurrent requests for this account are\n already running.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -9670,6 +9762,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ServiceFailure", + "httpResponseCode": 500 + }, "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception or\n failure.

", "smithy.api#error": "server", "smithy.api#httpError": 500 @@ -9735,6 +9831,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "NotSupportedService", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified service does not support service-specific credentials.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -10671,6 +10771,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "UnmodifiableEntity", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because only the service that depends on the service-linked role\n can modify or delete the role on your behalf. The error message includes the name of the\n service that depends on this service-linked role. You must request the change through that\n service.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -10684,6 +10788,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "UnrecognizedPublicKeyEncoding", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the public key encoding format is unsupported or\n unrecognized.

", "smithy.api#error": "client", "smithy.api#httpError": 400 diff --git a/aws/sdk/aws-models/iotanalytics.json b/aws/sdk/aws-models/iotanalytics.json index 8cbc36a86..573fcbc5f 100644 --- a/aws/sdk/aws-models/iotanalytics.json +++ b/aws/sdk/aws-models/iotanalytics.json @@ -503,7 +503,7 @@ "s3Paths": { "target": "com.amazonaws.iotanalytics#S3PathChannelMessages", "traits": { - "smithy.api#documentation": "

Specifies one or more keys that identify the Amazon Simple Storage Service (Amazon S3) objects that save your\n channel messages.

" + "smithy.api#documentation": "

Specifies one or more keys that identify the Amazon Simple Storage Service (Amazon S3) objects that save your\n channel messages.

\n

You must use the full path for the key.

\n

Example path: channel/mychannel/__dt=2020-02-29 00:00:00/1582940490000_1582940520000_123456789012_mychannel_0_2118.0.json.gz\n

" } } }, @@ -1040,7 +1040,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a data store, which is a repository for messages.

", + "smithy.api#documentation": "

Creates a data store, which is a repository for messages. \n Only data stores that are used to save pipeline data can be configured with ParquetConfiguration.

", "smithy.api#http": { "method": "POST", "uri": "/datastores", @@ -1081,6 +1081,12 @@ "traits": { "smithy.api#documentation": "

Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON \n and Parquet.

\n

The default file format is JSON. You can specify only one format.

\n

You can't change the file format after you create the data store.

" } + }, + "datastorePartitions": { + "target": "com.amazonaws.iotanalytics#DatastorePartitions", + "traits": { + "smithy.api#documentation": "

\n Contains information about the partitions in a data store.\n

" + } } } }, @@ -1819,6 +1825,12 @@ "traits": { "smithy.api#documentation": "

Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON \n and Parquet.

\n

The default file format is JSON. You can specify only one format.

\n

You can't change the file format after you create the data store.

" } + }, + "datastorePartitions": { + "target": "com.amazonaws.iotanalytics#DatastorePartitions", + "traits": { + "smithy.api#documentation": "

\n Contains information about the partitions in a data store.\n

" + } } }, "traits": { @@ -1860,6 +1872,40 @@ "smithy.api#pattern": "^[a-zA-Z0-9_]+$" } }, + "com.amazonaws.iotanalytics#DatastorePartition": { + "type": "structure", + "members": { + "attributePartition": { + "target": "com.amazonaws.iotanalytics#Partition", + "traits": { + "smithy.api#documentation": "

\n A partition defined by an attributeName.\n

" + } + }, + "timestampPartition": { + "target": "com.amazonaws.iotanalytics#TimestampPartition", + "traits": { + "smithy.api#documentation": "

\n A partition defined by an attributeName and a timestamp format.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A single partition in a data store.\n

" + } + }, + "com.amazonaws.iotanalytics#DatastorePartitions": { + "type": "structure", + "members": { + "partitions": { + "target": "com.amazonaws.iotanalytics#Partitions", + "traits": { + "smithy.api#documentation": "

\n A list of partitions in a data store.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Contains information about partitions in a data store.\n

" + } + }, "com.amazonaws.iotanalytics#DatastoreStatistics": { "type": "structure", "members": { @@ -1983,6 +2029,12 @@ "traits": { "smithy.api#documentation": "

The file format of the data in the data store.

" } + }, + "datastorePartitions": { + "target": "com.amazonaws.iotanalytics#DatastorePartitions", + "traits": { + "smithy.api#documentation": "

\n Contains information about the partitions in a data store.\n

" + } } }, "traits": { @@ -2857,7 +2909,7 @@ "min": 1, "max": 150 }, - "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" } }, "com.amazonaws.iotanalytics#GlueTableName": { @@ -2867,7 +2919,7 @@ "min": 1, "max": 150 }, - "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" } }, "com.amazonaws.iotanalytics#Image": { @@ -3656,7 +3708,8 @@ "smithy.api#length": { "min": 1, "max": 128 - } + }, + "smithy.api#pattern": "^\\p{ASCII}*$" } }, "com.amazonaws.iotanalytics#MessagePayload": { @@ -3692,7 +3745,7 @@ "com.amazonaws.iotanalytics#OutputFileName": { "type": "string", "traits": { - "smithy.api#pattern": "[\\w\\.-]{1,255}" + "smithy.api#pattern": "^[\\w\\.-]{1,255}$" } }, "com.amazonaws.iotanalytics#OutputFileUriValue": { @@ -3724,6 +3777,43 @@ "smithy.api#documentation": "

Contains the configuration information of the Parquet format.

" } }, + "com.amazonaws.iotanalytics#Partition": { + "type": "structure", + "members": { + "attributeName": { + "target": "com.amazonaws.iotanalytics#PartitionAttributeName", + "traits": { + "smithy.api#documentation": "

\n The attribute name of the partition.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A single partition.\n

" + } + }, + "com.amazonaws.iotanalytics#PartitionAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_]+$" + } + }, + "com.amazonaws.iotanalytics#Partitions": { + "type": "list", + "member": { + "target": "com.amazonaws.iotanalytics#DatastorePartition" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, "com.amazonaws.iotanalytics#Pipeline": { "type": "structure", "members": { @@ -4403,7 +4493,7 @@ "columns": { "target": "com.amazonaws.iotanalytics#Columns", "traits": { - "smithy.api#documentation": "

Specifies one or more columns that store your data.

\n

Each schema can have up to 100 columns. Each column can have up to 100 nested types

" + "smithy.api#documentation": "

Specifies one or more columns that store your data.

\n

Each schema can have up to 100 columns. Each column can have up to 100 nested types.

" } } }, @@ -4755,6 +4845,37 @@ "com.amazonaws.iotanalytics#Timestamp": { "type": "timestamp" }, + "com.amazonaws.iotanalytics#TimestampFormat": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s\\[\\]_,.'/:-]*$" + } + }, + "com.amazonaws.iotanalytics#TimestampPartition": { + "type": "structure", + "members": { + "attributeName": { + "target": "com.amazonaws.iotanalytics#PartitionAttributeName", + "traits": { + "smithy.api#documentation": "

\n The attribute name of the partition defined by a timestamp.\n

", + "smithy.api#required": {} + } + }, + "timestampFormat": { + "target": "com.amazonaws.iotanalytics#TimestampFormat", + "traits": { + "smithy.api#documentation": "

\n The timestamp format of a partition defined by a timestamp. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A partition defined by a timestamp.\n

" + } + }, "com.amazonaws.iotanalytics#TriggeringDataset": { "type": "structure", "members": { diff --git a/aws/sdk/aws-models/kendra.json b/aws/sdk/aws-models/kendra.json index bf923489c..15dc05297 100644 --- a/aws/sdk/aws-models/kendra.json +++ b/aws/sdk/aws-models/kendra.json @@ -352,6 +352,61 @@ "target": "com.amazonaws.kendra#AttributeFilter" } }, + "com.amazonaws.kendra#AuthenticationConfiguration": { + "type": "structure", + "members": { + "BasicAuthentication": { + "target": "com.amazonaws.kendra#BasicAuthenticationConfigurationList", + "traits": { + "smithy.api#documentation": "

The list of configuration information that's required to connect to and \n crawl a website host using basic authentication credentials.

\n

The list includes the name and port number of the website host.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides the configuration information to connect to websites that require\n user authentication.

" + } + }, + "com.amazonaws.kendra#BasicAuthenticationConfiguration": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.kendra#Host", + "traits": { + "smithy.api#documentation": "

The name of the website host you want to connect to using \n authentication credentials.

\n

For example, the host name of https://a.example.com/page1.html is \n \"a.example.com\".

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.kendra#Port", + "traits": { + "smithy.api#documentation": "

The port number of the website host you want to connect to using \n authentication credentials.

\n

For example, the port for https://a.example.com/page1.html is 443, \n the standard port for HTTPS.

", + "smithy.api#required": {} + } + }, + "Credentials": { + "target": "com.amazonaws.kendra#SecretArn", + "traits": { + "smithy.api#documentation": "

Your secret ARN, which you can create in AWS Secrets Manager\n

\n

You use a secret if basic authentication credentials are required to connect \n to a website. The secret stores your credentials of user name and password.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides the configuration information to connect to websites that require\n basic user authentication.

" + } + }, + "com.amazonaws.kendra#BasicAuthenticationConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#BasicAuthenticationConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, "com.amazonaws.kendra#BatchDeleteDocument": { "type": "operation", "input": { @@ -664,20 +719,20 @@ "StorageCapacityUnits": { "target": "com.amazonaws.kendra#StorageCapacityUnit", "traits": { - "smithy.api#documentation": "

The amount of extra storage capacity for an index. Each capacity\n unit provides 150 Gb of storage space or 500,000 documents,\n whichever is reached first.

", + "smithy.api#documentation": "

The amount of extra storage capacity for an index. \n A single capacity unit provides 30 GB of storage space or 100,000 documents, \n whichever is reached first.

", "smithy.api#required": {} } }, "QueryCapacityUnits": { "target": "com.amazonaws.kendra#QueryCapacityUnit", "traits": { - "smithy.api#documentation": "

The amount of extra query capacity for an index. Each capacity\n unit provides 0.5 queries per second and 40,000 queries per\n day.

", + "smithy.api#documentation": "

The amount of extra query capacity for an index and \n GetQuerySuggestions \n capacity.

\n

A single extra capacity unit for an index provides 0.1 queries per second or approximately \n 8,000 queries per day.

\n

\n GetQuerySuggestions capacity is five times the \n provisioned query capacity for an index, or the base capacity of 2.5 calls per second, \n whichever is higher. For example, the base capacity for an index is 0.1 queries per \n second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. \n If you add another 0.1 queries per second to total 0.2 queries per second for an index, the \n GetQuerySuggestions capacity is 2.5 calls per second \n (higher than five times 0.2 queries per second).

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Specifies capacity units configured for your index. You can add\n and remove capacity units to tune an index to your\n requirements.

" + "smithy.api#documentation": "

Specifies capacity units configured for your enterprise edition index. \n You can add and remove capacity units to tune an index to your\n requirements.

" } }, "com.amazonaws.kendra#ChangeDetectingColumns": { @@ -1431,6 +1486,16 @@ ] } }, + "com.amazonaws.kendra#CrawlDepth": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 10 + } + } + }, "com.amazonaws.kendra#CreateDataSource": { "type": "operation", "input": { @@ -1696,7 +1761,7 @@ "Edition": { "target": "com.amazonaws.kendra#IndexEdition", "traits": { - "smithy.api#documentation": "

The Amazon Kendra edition to use for the index. Choose\n DEVELOPER_EDITION for indexes intended for development,\n testing, or proof of concept. Use ENTERPRISE_EDITION for your\n production databases. Once you set the edition for an index, it can't be\n changed.

\n

The Edition parameter is optional. If you don't supply a\n value, the default is ENTERPRISE_EDITION.

" + "smithy.api#documentation": "

The Amazon Kendra edition to use for the index. Choose\n DEVELOPER_EDITION for indexes intended for development,\n testing, or proof of concept. Use ENTERPRISE_EDITION for your\n production databases. Once you set the edition for an index, it can't be\n changed.

\n

The Edition parameter is optional. If you don't supply a\n value, the default is ENTERPRISE_EDITION.

\n

For more information on quota limits for enterprise and developer editions, \n see Quotas.

" } }, "RoleArn": { @@ -2002,6 +2067,9 @@ "traits": { "smithy.api#documentation": "

Provides configuration for data sources that connect to Google\n Drive.

" } + }, + "WebCrawlerConfiguration": { + "target": "com.amazonaws.kendra#WebCrawlerConfiguration" } }, "traits": { @@ -2391,6 +2459,10 @@ { "value": "GOOGLEDRIVE", "name": "GOOGLEDRIVE" + }, + { + "value": "WEBCRAWLER", + "name": "WEBCRAWLER" } ] } @@ -4348,6 +4420,16 @@ ] } }, + "com.amazonaws.kendra#Host": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 253 + }, + "smithy.api#pattern": "^([^\\s]*)$" + } + }, "com.amazonaws.kendra#Importance": { "type": "integer", "traits": { @@ -5165,6 +5247,26 @@ "smithy.api#box": {} } }, + "com.amazonaws.kendra#MaxContentSizePerPageInMegaBytes": { + "type": "float", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0.000001, + "max": 50 + } + } + }, + "com.amazonaws.kendra#MaxLinksPerPage": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, "com.amazonaws.kendra#MaxResultsIntegerForListDataSourceSyncJobsRequest": { "type": "integer", "traits": { @@ -5225,6 +5327,16 @@ } } }, + "com.amazonaws.kendra#MaxUrlsPerMinuteCrawlRate": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 300 + } + } + }, "com.amazonaws.kendra#MetricValue": { "type": "string", "traits": { @@ -5401,6 +5513,16 @@ ] } }, + "com.amazonaws.kendra#Port": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 65535 + } + } + }, "com.amazonaws.kendra#Principal": { "type": "structure", "members": { @@ -5461,6 +5583,34 @@ ] } }, + "com.amazonaws.kendra#ProxyConfiguration": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.kendra#Host", + "traits": { + "smithy.api#documentation": "

The name of the website host you want to connect to \n via a web proxy server.

\n

For example, the host name of https://a.example.com/page1.html \n is \"a.example.com\".

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.kendra#Port", + "traits": { + "smithy.api#documentation": "

The port number of the website host you want to connect \n to via a web proxy server.

\n

For example, the port for https://a.example.com/page1.html\n is 443, the standard port for HTTPS.

", + "smithy.api#required": {} + } + }, + "Credentials": { + "target": "com.amazonaws.kendra#SecretArn", + "traits": { + "smithy.api#documentation": "

Your secret ARN, which you can create in AWS Secrets Manager\n

\n

The credentials are optional. You use a secret if web proxy credentials \n are required to connect to a website host. Amazon Kendra currently support basic \n authentication to connect to a web proxy server. The secret stores your \n credentials.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides the configuration information for a web proxy to connect to \n website hosts.

" + } + }, "com.amazonaws.kendra#Query": { "type": "operation", "input": { @@ -6617,6 +6767,49 @@ } } }, + "com.amazonaws.kendra#SeedUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(https?):\\/\\/([^\\s]*)$" + } + }, + "com.amazonaws.kendra#SeedUrlConfiguration": { + "type": "structure", + "members": { + "SeedUrls": { + "target": "com.amazonaws.kendra#SeedUrlList", + "traits": { + "smithy.api#documentation": "

The list of seed or starting point URLs of the \n websites you want to crawl.

\n

The list can include a maximum of 100 seed URLs.

", + "smithy.api#required": {} + } + }, + "WebCrawlerMode": { + "target": "com.amazonaws.kendra#WebCrawlerMode", + "traits": { + "smithy.api#documentation": "

You can choose one of the following modes:

\n \n

The default mode is set to HOST_ONLY.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides the configuration information of the seed or starting point URLs to crawl.

\n

\n When selecting websites to index, you must adhere to \n the Amazon Acceptable Use Policy \n and all other Amazon terms. Remember that you must only use the Amazon Kendra web \n crawler to index your own webpages, or webpages that you have authorization \n to index.\n

" + } + }, + "com.amazonaws.kendra#SeedUrlList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#SeedUrl" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.kendra#ServerSideEncryptionConfiguration": { "type": "structure", "members": { @@ -6905,6 +7098,9 @@ "traits": { "smithy.api#documentation": "

A Boolean value that specifies whether local\n groups are disabled (True) or enabled (False).\n

" } + }, + "SslCertificateS3Path": { + "target": "com.amazonaws.kendra#S3Path" } }, "traits": { @@ -6927,6 +7123,14 @@ "type": "string", "traits": { "smithy.api#enum": [ + { + "value": "SHAREPOINT_2013", + "name": "SHAREPOINT_2013" + }, + { + "value": "SHAREPOINT_2016", + "name": "SHAREPOINT_2016" + }, { "value": "SHAREPOINT_ONLINE", "name": "SHAREPOINT_ONLINE" @@ -6944,6 +7148,43 @@ "smithy.api#pattern": "^\\P{C}*$" } }, + "com.amazonaws.kendra#SiteMap": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(https?):\\/\\/([^\\s]*)$" + } + }, + "com.amazonaws.kendra#SiteMapsConfiguration": { + "type": "structure", + "members": { + "SiteMaps": { + "target": "com.amazonaws.kendra#SiteMapsList", + "traits": { + "smithy.api#documentation": "

The list of sitemap URLs of the websites \n you want to crawl.

\n

The list can include a maximum of three sitemap URLs.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides the configuration information of the sitemap URLs to crawl.

\n

\n When selecting websites to index, you must adhere to \n the Amazon Acceptable Use Policy \n and all other Amazon terms. Remember that you must only use the Amazon Kendra web \n crawler to index your own webpages, or webpages that you have authorization \n to index.\n

" + } + }, + "com.amazonaws.kendra#SiteMapsList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#SiteMap" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, "com.amazonaws.kendra#SortOrder": { "type": "string", "traits": { @@ -8086,6 +8327,26 @@ "smithy.api#pattern": "^(https?|ftp|file):\\/\\/([^\\s]*)$" } }, + "com.amazonaws.kendra#Urls": { + "type": "structure", + "members": { + "SeedUrlConfiguration": { + "target": "com.amazonaws.kendra#SeedUrlConfiguration", + "traits": { + "smithy.api#documentation": "

Provides the configuration of the seed or starting point URLs of the websites \n you want to crawl.

\n

You can choose to crawl only the website host names, or the website host names \n with subdomains, or the website host names with subdomains and other domains \n that the webpages link to.

\n

You can list up to 100 seed URLs.

" + } + }, + "SiteMapsConfiguration": { + "target": "com.amazonaws.kendra#SiteMapsConfiguration", + "traits": { + "smithy.api#documentation": "

Provides the configuration of the sitemap URLs of the websites you want to crawl.

\n

Only URLs belonging to the same website host names are crawled. You can list up to \n three sitemap URLs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides the configuration information of the URLs to crawl.

\n

\n When selecting websites to index, you must adhere to \n the Amazon Acceptable Use Policy \n and all other Amazon terms. Remember that you must only use the Amazon Kendra web \n crawler to index your own webpages, or webpages that you have authorization to \n index.\n

" + } + }, "com.amazonaws.kendra#UserAccount": { "type": "string", "traits": { @@ -8217,6 +8478,88 @@ }, "smithy.api#pattern": "^[-0-9a-zA-Z]+$" } + }, + "com.amazonaws.kendra#WebCrawlerConfiguration": { + "type": "structure", + "members": { + "Urls": { + "target": "com.amazonaws.kendra#Urls", + "traits": { + "smithy.api#documentation": "

Specifies the seed or starting point URLs of the \n websites or the sitemap URLs of the websites you want to crawl.

\n

You can include website subdomains. You can list up to 100 seed \n URLs and up to three sitemap URLs.

\n

\n When selecting websites to index, you must adhere to \n the Amazon Acceptable Use Policy \n and all other Amazon terms. Remember that you must only use the Amazon Kendra \n web crawler to index your own webpages, or webpages that you have \n authorization to index.\n

", + "smithy.api#required": {} + } + }, + "CrawlDepth": { + "target": "com.amazonaws.kendra#CrawlDepth", + "traits": { + "smithy.api#documentation": "

Specifies the number of levels in a website that you want to crawl.

\n

The first level begins from the website seed or starting point URL. \n For example, if a website has 3 levels – index level (i.e. seed in this \n example), sections level, and subsections level – and you are only \n interested in crawling information up to the sections level (i.e. \n levels 0-1), you can set your depth to 1.

\n

The default crawl depth is set to 2.

" + } + }, + "MaxLinksPerPage": { + "target": "com.amazonaws.kendra#MaxLinksPerPage", + "traits": { + "smithy.api#documentation": "

The maximum number of URLs on a webpage to include when crawling a website. \n This number is per webpage.

\n

As a website’s webpages are crawled, any URLs the webpages link to are\n also crawled. URLs on a webpage are crawled in order of appearance.

\n

The default maximum links per page is 100.

" + } + }, + "MaxContentSizePerPageInMegaBytes": { + "target": "com.amazonaws.kendra#MaxContentSizePerPageInMegaBytes", + "traits": { + "smithy.api#documentation": "

The maximum size (in MB) of a webpage or attachment to crawl.

\n

Files larger than this size (in MB) are skipped/not crawled.

\n

The default maximum size of a webpage or attachment is set to 50 MB.

" + } + }, + "MaxUrlsPerMinuteCrawlRate": { + "target": "com.amazonaws.kendra#MaxUrlsPerMinuteCrawlRate", + "traits": { + "smithy.api#documentation": "

The maximum number of URLs crawled per website host per minute.

\n

A minimum of one URL is required.

\n

The default maximum number of URLs crawled per website host per minute is 300.

" + } + }, + "UrlInclusionPatterns": { + "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", + "traits": { + "smithy.api#documentation": "

The regular expression pattern to include certain URLs to crawl.

\n

If there is a regular expression pattern to exclude certain URLs that \n conflicts with the include pattern, the exclude pattern takes precedence.

" + } + }, + "UrlExclusionPatterns": { + "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", + "traits": { + "smithy.api#documentation": "

The regular expression pattern to exclude certain URLs to crawl.

\n

If there is a regular expression pattern to include certain URLs that \n conflicts with the exclude pattern, the exclude pattern takes precedence.

" + } + }, + "ProxyConfiguration": { + "target": "com.amazonaws.kendra#ProxyConfiguration", + "traits": { + "smithy.api#documentation": "

Provides configuration information required to connect to your internal \n websites via a web proxy.

\n

You must provide the website host name and port number. For example, the \n host name of https://a.example.com/page1.html is \"a.example.com\" and the \n port is 443, the standard port for HTTPS.

\n

Web proxy credentials are optional and you can use them to connect to a \n web proxy server that requires basic authentication. To store web proxy \n credentials, you use a secret in AWS Secrets Manager.

" + } + }, + "AuthenticationConfiguration": { + "target": "com.amazonaws.kendra#AuthenticationConfiguration", + "traits": { + "smithy.api#documentation": "

Provides configuration information required to connect to websites using \n authentication.

\n

You can connect to websites using basic authentication of user name and password.

\n

You must provide the website host name and port number. For example, the host name \n of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the \n standard port for HTTPS. You use a secret in AWS Secrets Manager to store \n your authentication credentials.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides the configuration information required for Amazon Kendra \n web crawler.

" + } + }, + "com.amazonaws.kendra#WebCrawlerMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HOST_ONLY", + "name": "HOST_ONLY" + }, + { + "value": "SUBDOMAINS", + "name": "SUBDOMAINS" + }, + { + "value": "EVERYTHING", + "name": "EVERYTHING" + } + ] + } } } } diff --git a/aws/sdk/aws-models/kms.json b/aws/sdk/aws-models/kms.json index 053824216..0bcfff747 100644 --- a/aws/sdk/aws-models/kms.json +++ b/aws/sdk/aws-models/kms.json @@ -75,14 +75,20 @@ "TargetKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

String that contains the key identifier referred to by the alias.

" + "smithy.api#documentation": "

String that contains the key identifier of the CMK associated with the alias.

" } }, "CreationDate": { - "target": "com.amazonaws.kms#DateType" + "target": "com.amazonaws.kms#DateType", + "traits": { + "smithy.api#documentation": "

Date and time that the alias was most recently created in the account and Region. Formatted as Unix time.

" + } }, "LastUpdatedDate": { - "target": "com.amazonaws.kms#DateType" + "target": "com.amazonaws.kms#DateType", + "traits": { + "smithy.api#documentation": "

Date and time that the alias was most recently associated with a CMK in the account and Region. Formatted as Unix time.

" + } } }, "traits": { @@ -150,7 +156,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels the deletion of a customer master key (CMK). When this operation succeeds, the key\n state of the CMK is Disabled. To enable the CMK, use EnableKey.

\n

For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master\n Keys in the AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n

\n Required permissions: kms:CancelKeyDeletion (key policy)

\n

\n Related operations: ScheduleKeyDeletion\n

" + "smithy.api#documentation": "

Cancels the deletion of a customer master key (CMK). When this operation succeeds, the key\n state of the CMK is Disabled. To enable the CMK, use EnableKey.

\n

For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master\n Keys in the AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n

\n Required permissions: kms:CancelKeyDeletion (key policy)

\n

\n Related operations: ScheduleKeyDeletion\n

" } }, "com.amazonaws.kms#CancelKeyDeletionRequest": { @@ -159,7 +165,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The unique identifier for the customer master key (CMK) for which to cancel\n deletion.

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Identifies the customer master key (CMK) whose deletion is being canceled.

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } } @@ -403,7 +409,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a friendly name for a customer master key (CMK). You can use an alias to identify\n a CMK in the AWS KMS console, in the DescribeKey operation and in\n cryptographic operations, such as Encrypt and GenerateDataKey.

\n

You can also change the CMK that's associated with the alias (UpdateAlias) or delete the alias (DeleteAlias) at any time. These operations don't\n affect the underlying CMK.

\n

You can associate the alias with any customer managed CMK in the same AWS Region. Each\n alias is associated with only on CMK at a time, but a CMK can have multiple aliases. A valid\n CMK is required. You can't create an alias without a CMK.

\n

The alias must be unique in the account and Region, but you can have aliases with the same\n name in different Regions. For detailed information about aliases, see Using aliases in the\n AWS Key Management Service Developer Guide.

\n

This operation does not return a response. To get the alias that you created, use the\n ListAliases operation.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on an alias in a different AWS account.

\n \n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Creates a friendly name for a customer master key (CMK).

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the CMK. For details, see Using ABAC in AWS KMS in the AWS Key Management Service Developer Guide.

\n \n

You can use an alias to identify a CMK in the AWS KMS console, in the DescribeKey operation and in cryptographic operations, such as Encrypt and\n GenerateDataKey. You can also change the CMK that's associated with the\n alias (UpdateAlias) or delete the alias (DeleteAlias) at\n any time. These operations don't affect the underlying CMK.

\n

You can associate the alias with any customer managed CMK in the same AWS Region. Each\n alias is associated with only one CMK at a time, but a CMK can have multiple aliases. A valid\n CMK is required. You can't create an alias without a CMK.

\n

The alias must be unique in the account and Region, but you can have aliases with the same\n name in different Regions. For detailed information about aliases, see Using aliases in the\n AWS Key Management Service Developer Guide.

\n

This operation does not return a response. To get the alias that you created, use the\n ListAliases operation.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on an alias in a different AWS account.

\n \n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#CreateAliasRequest": { @@ -419,7 +425,7 @@ "TargetKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Associates the alias with the specified customer managed CMK. The CMK must be\n in the same AWS Region.

\n

A valid CMK ID is required. If you supply a null or empty string value, this operation\n returns an error.

\n

For help finding the key ID and ARN, see Finding the Key ID and\n ARN in the AWS Key Management Service Developer Guide.

\n \n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Associates the alias with the specified customer managed CMK. The CMK must be\n in the same AWS Region.

\n

A valid CMK ID is required. If you supply a null or empty string value, this operation\n returns an error.

\n

For help finding the key ID and ARN, see Finding the Key ID and\n ARN in the AWS Key Management Service Developer Guide.

\n \n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } } @@ -539,7 +545,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a grant to a customer master key (CMK). The grant allows the grantee principal to use\n the CMK when the conditions specified in the grant are met. When setting permissions, grants\n are an alternative to key policies.

\n

To create a grant that allows a cryptographic operation only when the request includes a particular\n encryption\n context, use the Constraints parameter. For details, see GrantConstraints.

\n

You can create grants on symmetric and asymmetric CMKs. However, if the grant allows an\n operation that the CMK does not support, CreateGrant fails with a\n ValidationException.

\n\n \n

For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide. For more information about grants, see Grants in the\n \n AWS Key Management Service Developer Guide\n .

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key\n ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:CreateGrant (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Adds a grant to a customer master key (CMK).

\n

A grant is a policy instrument that allows AWS principals to use AWS\n KMS customer master keys (CMKs) in cryptographic operations. It also can allow them to view a\n CMK (DescribeKey) and create and manage grants. When authorizing access to a\n CMK, grants are considered along with key policies and IAM policies. Grants are often used for\n temporary permissions because you can create one, use its permissions, and delete it without\n changing your key policies or IAM policies.

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n AWS Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

The CreateGrant operation returns a GrantToken and a\n GrantId.

\n \n

For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide. For more information about grants, see Grants in the\n \n AWS Key Management Service Developer Guide\n .

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key\n ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:CreateGrant (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#CreateGrantRequest": { @@ -548,14 +554,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The unique identifier for the customer master key (CMK) that the grant applies to.

\n \n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a\ndifferent AWS account, you must use the key ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Identifies the customer master key (CMK) for the grant. The grant gives principals permission to use this CMK.

\n \n

Specify the key ID or key ARN of the CMK. To specify a CMK in a\ndifferent AWS account, you must use the key ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, "GranteePrincipal": { "target": "com.amazonaws.kms#PrincipalIdType", "traits": { - "smithy.api#documentation": "

The principal that is given permission to perform the operations that the grant\n permits.

\n

To specify the principal, use the Amazon Resource Name (ARN) of an AWS\n principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated\n users, and assumed role users. For examples of the ARN syntax to use for specifying a\n principal, see AWS Identity and Access\n Management (IAM) in the Example ARNs section of the AWS General\n Reference.

", + "smithy.api#documentation": "

The identity that gets the permissions specified in the grant.

\n

To specify the principal, use the Amazon Resource Name (ARN) of an AWS\n principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated\n users, and assumed role users. For examples of the ARN syntax to use for specifying a\n principal, see AWS Identity and Access\n Management (IAM) in the Example ARNs section of the AWS General\n Reference.

", "smithy.api#required": {} } }, @@ -568,20 +574,20 @@ "Operations": { "target": "com.amazonaws.kms#GrantOperationList", "traits": { - "smithy.api#documentation": "

A list of operations that the grant permits.

", + "smithy.api#documentation": "

A list of operations that the grant permits.

\n

The operation must be supported on the CMK. For example, you cannot create a grant for a\n symmetric CMK that allows the Sign operation, or a grant for an asymmetric\n CMK that allows the GenerateDataKey operation. If you try, AWS KMS returns a\n ValidationError exception. For details, see Grant operations in the\n AWS Key Management Service Developer Guide.

", "smithy.api#required": {} } }, "Constraints": { "target": "com.amazonaws.kms#GrantConstraints", "traits": { - "smithy.api#documentation": "

Allows a cryptographic operation only when the encryption context matches or includes the encryption\n context specified in this structure. For more information about encryption context, see Encryption\n Context in the \n AWS Key Management Service Developer Guide\n .

\n

Grant constraints are not applied to operations that do not support an encryption context,\n such as cryptographic operations with asymmetric CMKs and management operations, such as\n DescribeKey or RetireGrant.

" + "smithy.api#documentation": "

Specifies a grant constraint.

\n

AWS KMS supports the EncryptionContextEquals and\n EncryptionContextSubset grant constraints. Each constraint value can include up\n to 8 encryption context pairs. The encryption context value in each constraint cannot exceed\n 384 characters.

\n

These grant constraints allow a cryptographic operation only when the encryption context in the\n request matches (EncryptionContextEquals) or includes\n (EncryptionContextSubset) the encryption context specified in this structure.\n For more information about encryption context, see Encryption Context in the\n \n AWS Key Management Service Developer Guide\n . For information about grant constraints, see Using\n grant constraints in the AWS Key Management Service Developer Guide.

\n

The encryption context grant constraints are supported only on operations that include an\n encryption context. You cannot use an encryption context grant constraint for cryptographic\n operations with asymmetric CMKs or for management operations, such as DescribeKey or RetireGrant.

" } }, "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" } }, "Name": { @@ -598,7 +604,7 @@ "GrantToken": { "target": "com.amazonaws.kms#GrantTokenType", "traits": { - "smithy.api#documentation": "

The grant token.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The grant token.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" } }, "GrantId": { @@ -650,7 +656,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a unique customer managed customer master key (CMK) in your AWS\n account and Region.

\n\n

You can use the CreateKey operation to create symmetric or asymmetric\n CMKs.

\n \n

For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n\n\n

To create different types of CMKs, use the following guidance:

\n\n
\n
Asymmetric CMKs
\n
\n

To create an asymmetric CMK, use the CustomerMasterKeySpec parameter to\n specify the type of key material in the CMK. Then, use the KeyUsage\n parameter to determine whether the CMK will be used to encrypt and decrypt or sign and\n verify. You can't change these properties after the CMK is created.

\n

\n
\n
Symmetric CMKs
\n
\n

When creating a symmetric CMK, you don't need to specify the\n CustomerMasterKeySpec or KeyUsage parameters. The default\n value for CustomerMasterKeySpec, SYMMETRIC_DEFAULT, and the\n default value for KeyUsage, ENCRYPT_DECRYPT, are the only\n valid values for symmetric CMKs.

\n

\n
\n
Imported Key Material
\n
\n

To import your own key material, begin by creating a symmetric CMK with no key\n material. To do this, use the Origin parameter of CreateKey\n with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt\n your key material. Then, use ImportKeyMaterial with your import token\n to import the key material. For step-by-step instructions, see Importing Key Material in the \n AWS Key Management Service Developer Guide\n . You\n cannot import the key material into an asymmetric CMK.

\n

\n
\n
Custom Key Stores
\n
\n

To create a symmetric CMK in a custom key store, use the\n CustomKeyStoreId parameter to specify the custom key store. You must also\n use the Origin parameter with a value of AWS_CLOUDHSM. The\n AWS CloudHSM cluster that is associated with the custom key store must have at least two active\n HSMs in different Availability Zones in the AWS Region.

\n

You cannot create an asymmetric CMK in a custom key store. For information about\n custom key stores in AWS KMS see Using Custom Key Stores in\n the \n AWS Key Management Service Developer Guide\n .

\n
\n
\n

\n Cross-account use: No. You cannot use this operation to\n create a CMK in a different AWS account.

\n\n

\n Required permissions: kms:CreateKey (IAM policy). To use the\n Tags parameter, kms:TagResource (IAM policy). For examples and information about related\n permissions, see Allow a user to create\n CMKs in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Creates a unique customer managed customer master key (CMK) in your AWS\n account and Region.

\n\n

You can use the CreateKey operation to create symmetric or asymmetric\n CMKs.

\n \n

For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n\n\n

To create different types of CMKs, use the following guidance:

\n\n
\n
Asymmetric CMKs
\n
\n

To create an asymmetric CMK, use the CustomerMasterKeySpec parameter to\n specify the type of key material in the CMK. Then, use the KeyUsage\n parameter to determine whether the CMK will be used to encrypt and decrypt or sign and\n verify. You can't change these properties after the CMK is created.

\n

\n
\n
Symmetric CMKs
\n
\n

When creating a symmetric CMK, you don't need to specify the\n CustomerMasterKeySpec or KeyUsage parameters. The default\n value for CustomerMasterKeySpec, SYMMETRIC_DEFAULT, and the\n default value for KeyUsage, ENCRYPT_DECRYPT, are the only\n valid values for symmetric CMKs.

\n

\n
\n
Multi-Region primary keys
\n
Imported key material
\n
\n

To create a multi-Region primary key in the local AWS Region,\n use the MultiRegion parameter with a value of True. To create\n a multi-Region replica key, that is, a CMK with the same key ID and\n key material as a primary key, but in a different AWS Region, use the ReplicateKey operation. To change a replica key to a primary key, and its\n primary key to a replica key, use the UpdatePrimaryRegion\n operation.

\n

This operation supports multi-Region keys, an AWS KMS feature that lets you create multiple\n interoperable CMKs in different AWS Regions. Because these CMKs have the same key ID, key\n material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt\n it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide.

\n

You can create symmetric and asymmetric multi-Region keys and multi-Region keys with\n imported key material. You cannot create multi-Region keys in a custom key store.

\n

\n
\n
\n

To import your own key material, begin by creating a symmetric CMK with no key\n material. To do this, use the Origin parameter of CreateKey\n with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt\n your key material. Then, use ImportKeyMaterial with your import token\n to import the key material. For step-by-step instructions, see Importing Key Material in the \n AWS Key Management Service Developer Guide\n . You\n cannot import the key material into an asymmetric CMK.

\n

To create a multi-Region primary key with imported key material, use the\n Origin parameter of CreateKey with a value of\n EXTERNAL and the MultiRegion parameter with a value of\n True. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide.

\n

\n
\n
Custom key store
\n
\n

To create a symmetric CMK in a custom key store, use the\n CustomKeyStoreId parameter to specify the custom key store. You must also\n use the Origin parameter with a value of AWS_CLOUDHSM. The\n AWS CloudHSM cluster that is associated with the custom key store must have at least two active\n HSMs in different Availability Zones in the AWS Region.

\n

You cannot create an asymmetric CMK or a multi-Region CMK in a custom key store. For\n information about custom key stores in AWS KMS see Using Custom Key Stores in\n the \n AWS Key Management Service Developer Guide\n .

\n
\n
\n

\n Cross-account use: No. You cannot use this operation to\n create a CMK in a different AWS account.

\n\n

\n Required permissions: kms:CreateKey (IAM policy). To use the\n Tags parameter, kms:TagResource (IAM policy). For examples and information about related\n permissions, see Allow a user to create\n CMKs in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#CreateKeyRequest": { @@ -665,31 +671,31 @@ "Description": { "target": "com.amazonaws.kms#DescriptionType", "traits": { - "smithy.api#documentation": "

A description of the CMK.

\n

Use a description that helps you decide whether the CMK is appropriate for a task.

" + "smithy.api#documentation": "

A description of the CMK.

\n

Use a description that helps you decide whether the CMK is\n appropriate for a task. The default value is an empty string (no description).

" } }, "KeyUsage": { "target": "com.amazonaws.kms#KeyUsageType", "traits": { - "smithy.api#documentation": "

Determines the cryptographic operations for which you can use the CMK. The default value\n is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You\n can't change the KeyUsage value after the CMK is created.

\n

Select only one valid value.

\n " + "smithy.api#documentation": "

Determines the cryptographic operations for which you can use the CMK. The default value is\n ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't\n change the KeyUsage value after the CMK is created.

\n

Select only one valid value.

\n " } }, "CustomerMasterKeySpec": { "target": "com.amazonaws.kms#CustomerMasterKeySpec", "traits": { - "smithy.api#documentation": "

Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT,\n creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a\n key spec for your CMK, see How to Choose Your CMK\n Configuration in the AWS Key Management Service Developer\n Guide.

\n

The CustomerMasterKeySpec determines whether the CMK contains a symmetric key\n or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms\n that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK\n is created. To further restrict the algorithms that can be used with the CMK, use a condition\n key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer\n Guide.

\n \n

\n AWS services that\n are integrated with AWS KMS use symmetric CMKs to protect your data. These\n services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or\n asymmetric, see Identifying Symmetric and Asymmetric\n CMKs in the AWS Key Management Service Developer\n Guide.

\n \n

AWS KMS supports the following key specs for CMKs:

\n " + "smithy.api#documentation": "

Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT,\n creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a\n key spec for your CMK, see How to Choose Your CMK\n Configuration in the AWS Key Management Service Developer\n Guide.

\n

The CustomerMasterKeySpec determines whether the CMK contains a symmetric key\n or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms\n that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK\n is created. To further restrict the algorithms that can be used with the CMK, use a condition\n key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer\n Guide.

\n \n

\n AWS services that\n are integrated with AWS KMS use symmetric CMKs to protect your data. These\n services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or\n asymmetric, see Identifying Symmetric and Asymmetric\n CMKs in the AWS Key Management Service Developer\n Guide.

\n \n

AWS KMS supports the following key specs for CMKs:

\n " } }, "Origin": { "target": "com.amazonaws.kms#OriginType", "traits": { - "smithy.api#documentation": "

The source of the key material for the CMK. You cannot change the origin after you create\n the CMK. The default is AWS_KMS, which means AWS KMS creates the key\n material.

\n

When the parameter value is EXTERNAL, AWS KMS creates a CMK without key\n material so that you can import key material from your existing key management infrastructure.\n For more information about importing key material into AWS KMS, see Importing Key Material in the\n AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.

\n

When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS\n custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also\n use the CustomKeyStoreId parameter to identify the custom key store. This value\n is valid only for symmetric CMKs.

" + "smithy.api#documentation": "

The source of the key material for the CMK. You cannot change the origin after you create\n the CMK. The default is AWS_KMS, which means that AWS KMS creates the key\n material.

\n

To create a CMK with no key material (for imported key material), set the value to\n EXTERNAL. For more information about importing key material into AWS KMS, see\n Importing Key\n Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.

\n

To create a CMK in an AWS KMS custom key store and create its key material in the associated\n AWS CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the\n CustomKeyStoreId parameter to identify the custom key store. This value is\n valid only for symmetric CMKs.

" } }, "CustomKeyStoreId": { "target": "com.amazonaws.kms#CustomKeyStoreIdType", "traits": { - "smithy.api#documentation": "

Creates the CMK in the specified custom key store and the key material in its associated\n AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the\n Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster\n that is associated with the custom key store must have at least two active HSMs, each in a\n different Availability Zone in the Region.

\n

This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a\n custom key store.

\n

To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

\n

The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

" + "smithy.api#documentation": "

Creates the CMK in the specified custom key store and the key material in its associated\n AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the\n Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster\n that is associated with the custom key store must have at least two active HSMs, each in a\n different Availability Zone in the Region.

\n

This parameter is valid only for symmetric CMKs and regional CMKs. You cannot create an\n asymmetric CMK or a multi-Region CMK in a custom key store.

\n

To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

\n

The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

" } }, "BypassPolicyLockoutSafetyCheck": { @@ -701,7 +707,13 @@ "Tags": { "target": "com.amazonaws.kms#TagList", "traits": { - "smithy.api#documentation": "

One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the\n tag value are required, but the tag value can be an empty (null) string.

\n

When you add tags to an AWS resource, AWS generates a cost allocation\n report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs,\n see Tagging Keys.

\n

Use this parameter to tag the CMK when it is created. To add tags to an\n existing CMK, use the TagResource operation.

\n

To use this parameter, you must have kms:TagResource permission in an IAM policy.

" + "smithy.api#documentation": "

Assigns one or more tags to the CMK. Use this parameter to tag the CMK when it is created.\n To tag an existing CMK, use the TagResource operation.

\n \n

Tagging or untagging a CMK can allow or deny permission to the\n CMK. For details, see Using ABAC in AWS KMS in the AWS Key Management Service Developer Guide.

\n \n

To use this parameter, you must have kms:TagResource permission in an IAM policy.

\n

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are\n required, but the tag value can be an empty (null) string. You cannot have more than one tag\n on a CMK with the same tag key. If you specify an existing tag key with a different tag value,\n AWS KMS replaces the current tag value with the specified one.

\n

When you assign tags to an AWS resource, AWS generates a cost allocation\n report with usage and costs aggregated by tags. Tags can also be used to control access to a CMK. For details,\n see Tagging Keys.

" + } + }, + "MultiRegion": { + "target": "com.amazonaws.kms#NullableBooleanType", + "traits": { + "smithy.api#documentation": "

Creates a multi-Region primary key that you can replicate into other AWS Regions. You\n cannot change this value after you create the CMK.

\n

For a multi-Region key, set this parameter to True. For a single-Region CMK,\n omit this parameter or set it to False. The default value is\n False.

\n

This operation supports multi-Region keys, an AWS KMS feature that lets you create multiple\n interoperable CMKs in different AWS Regions. Because these CMKs have the same key ID, key\n material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt\n it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide.

\n

This value creates a primary key, not a replica. To create a\n replica key, use the ReplicateKey operation.

\n

You can create a symmetric or asymmetric multi-Region CMK, and you can create a\n multi-Region CMK with imported key material. However, you cannot create a multi-Region CMK in\n a custom key store.

" } } } @@ -823,13 +835,13 @@ "ConnectionState": { "target": "com.amazonaws.kms#ConnectionStateType", "traits": { - "smithy.api#documentation": "

Indicates whether the custom key store is connected to its AWS CloudHSM cluster.

\n

You can create and use CMKs in your custom key stores only when its connection state is\n CONNECTED.

\n

The value is DISCONNECTED if the key store has never been connected or you\n use the DisconnectCustomKeyStore operation to disconnect it. If the value is\n CONNECTED but you are having trouble using the custom key store, make sure that\n its associated AWS CloudHSM cluster is active and contains at least one active HSM.

\n

A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For\n help resolving a connection failure, see Troubleshooting a Custom Key Store in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Indicates whether the custom key store is connected to its AWS CloudHSM cluster.

\n

You can create and use CMKs in your custom key stores only when its connection state is\n CONNECTED.

\n

The value is DISCONNECTED if the key store has never been connected or you\n use the DisconnectCustomKeyStore operation to disconnect it. If the value is\n CONNECTED but you are having trouble using the custom key store, make sure that\n its associated AWS CloudHSM cluster is active and contains at least one active HSM.

\n

A value of FAILED indicates that an attempt to connect was unsuccessful. The\n ConnectionErrorCode field in the response indicates the cause of the failure.\n For help resolving a connection failure, see Troubleshooting a Custom Key Store in the\n AWS Key Management Service Developer Guide.

" } }, "ConnectionErrorCode": { "target": "com.amazonaws.kms#ConnectionErrorCodeType", "traits": { - "smithy.api#documentation": "

Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.

\n

Valid values are:

\n " + "smithy.api#documentation": "

Describes the connection error. This field appears in the response only when the\n ConnectionState is FAILED. For help resolving these errors, see\n How to\n Fix a Connection Failure in AWS Key Management Service Developer Guide.

\n

Valid values are:

\n " } }, "CreationDate": { @@ -976,7 +988,7 @@ } ], "traits": { - "smithy.api#documentation": "

Decrypts ciphertext that was encrypted by a AWS KMS customer master key (CMK) using any of\n the following operations:

\n \n

You can use this operation to decrypt ciphertext that was encrypted under a symmetric or\n asymmetric CMK. When the CMK is asymmetric, you must specify the CMK and the encryption\n algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

The Decrypt operation also decrypts ciphertext that was encrypted outside of AWS KMS by the\n public key in an AWS KMS asymmetric CMK. However, it cannot decrypt ciphertext produced by other\n libraries, such as the AWS Encryption\n SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that\n is incompatible with AWS KMS.

\n

If the ciphertext was encrypted under a symmetric CMK, the KeyId parameter is\n optional. AWS KMS can get this information from metadata that it adds to the symmetric\n ciphertext blob. This feature adds durability to your implementation by ensuring that\n authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost\n track of the CMK ID. However, specifying the CMK is always recommended as a best practice.\n When you use the KeyId parameter to specify a CMK, AWS KMS only uses the CMK you\n specify. If the ciphertext was encrypted under a different CMK, the Decrypt\n operation fails. This practice ensures that you use the CMK that you intend.

\n

Whenever possible, use key policies to give users permission to call the\n Decrypt operation on a particular CMK, instead of using IAM policies.\n Otherwise, you might create an IAM user policy that gives the user Decrypt\n permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other\n accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy\n for Decrypt permissions, limit the user to particular CMKs or particular trusted\n accounts. For details, see Best practices for IAM policies in the AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. You can decrypt a ciphertext\n using a CMK in a different AWS account.

\n \n

\n Required permissions: kms:Decrypt (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Decrypts ciphertext that was encrypted by a AWS KMS customer master key (CMK) using any of\n the following operations:

\n \n

You can use this operation to decrypt ciphertext that was encrypted under a symmetric or\n asymmetric CMK. When the CMK is asymmetric, you must specify the CMK and the encryption\n algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

The Decrypt operation also decrypts ciphertext that was encrypted outside of AWS KMS by the\n public key in an AWS KMS asymmetric CMK. However, it cannot decrypt ciphertext produced by other\n libraries, such as the AWS Encryption\n SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that\n is incompatible with AWS KMS.

\n

If the ciphertext was encrypted under a symmetric CMK, the KeyId parameter is\n optional. AWS KMS can get this information from metadata that it adds to the symmetric\n ciphertext blob. This feature adds durability to your implementation by ensuring that\n authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost\n track of the CMK ID. However, specifying the CMK is always recommended as a best practice.\n When you use the KeyId parameter to specify a CMK, AWS KMS only uses the CMK you\n specify. If the ciphertext was encrypted under a different CMK, the Decrypt\n operation fails. This practice ensures that you use the CMK that you intend.

\n

Whenever possible, use key policies to give users permission to call the\n Decrypt operation on a particular CMK, instead of using IAM policies.\n Otherwise, you might create an IAM user policy that gives the user Decrypt\n permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other\n accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy\n for Decrypt permissions, limit the user to particular CMKs or particular trusted\n accounts. For details, see Best practices for IAM policies in the AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. You can decrypt a ciphertext\n using a CMK in a different AWS account.

\n \n

\n Required permissions: kms:Decrypt (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DecryptRequest": { @@ -998,13 +1010,13 @@ "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a newly created\n grant that has not yet achieved eventual consistency. Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" } }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the customer master key (CMK) that AWS KMS uses to decrypt the ciphertext. Enter a\n key ID of the CMK that was used to encrypt the ciphertext.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric CMK.\n If you used a symmetric CMK, AWS KMS can get the CMK from metadata that it adds to the\n symmetric ciphertext blob. However, it is always recommended as a best practice. This practice\n ensures that you use the CMK that you intend.

\n \n

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" + "smithy.api#documentation": "

Specifies the customer master key (CMK) that AWS KMS uses to decrypt the ciphertext. Enter a\n key ID of the CMK that was used to encrypt the ciphertext.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric CMK.\n If you used a symmetric CMK, AWS KMS can get the CMK from metadata that it adds to the\n symmetric ciphertext blob. However, it is always recommended as a best practice. This practice\n ensures that you use the CMK that you intend.

\n \n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" } }, "EncryptionAlgorithm": { @@ -1058,7 +1070,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified alias.

\n

Because an alias is not a property of a CMK, you can delete and change the aliases of a\n CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.

\n

Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to\n create a new alias. To associate an existing alias with a different customer master key (CMK),\n call UpdateAlias.

\n

\n Cross-account use: No. You cannot perform this operation on an alias in a different AWS account.

\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Deletes the specified alias.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the CMK. For details, see Using ABAC in AWS KMS in the AWS Key Management Service Developer Guide.

\n \n

Because an alias is not a property of a CMK, you can delete and change the aliases of a\n CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.

\n

Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to\n create a new alias. To associate an existing alias with a different customer master key (CMK),\n call UpdateAlias.

\n

\n Cross-account use: No. You cannot perform this operation on an alias in a different AWS account.

\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DeleteAliasRequest": { @@ -1096,7 +1108,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a custom key store. This operation does not delete the AWS CloudHSM cluster that is\n associated with the custom key store, or affect any users or keys in the cluster.

\n

The custom key store that you delete cannot contain any AWS KMS customer master keys (CMKs). Before\n deleting the key store, verify that you will never need to use any of the CMKs in the key\n store for any cryptographic operations. Then, use ScheduleKeyDeletion to\n delete the AWS KMS customer master keys (CMKs) from the key store. When the scheduled waiting\n period expires, the ScheduleKeyDeletion operation deletes the CMKs. Then it makes\n a best effort to delete the key material from the associated cluster. However, you might need\n to manually delete the orphaned key\n material from the cluster and its backups.

\n

After all CMKs are deleted from AWS KMS, use DisconnectCustomKeyStore to\n disconnect the key store from AWS KMS. Then, you can delete the custom key store.

\n

Instead of deleting the custom key store, consider using DisconnectCustomKeyStore to disconnect it from AWS KMS. While the key store is\n disconnected, you cannot create or use the CMKs in the key store. But, you do not need to\n delete CMKs and you can reconnect a disconnected custom key store at any time.

\n

If the operation succeeds, it returns a JSON object with no\nproperties.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

\n\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.

\n \n

\n Required permissions: kms:DeleteCustomKeyStore (IAM policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Deletes a custom key store. This operation does not delete the AWS CloudHSM cluster that is\n associated with the custom key store, or affect any users or keys in the cluster.

\n

The custom key store that you delete cannot contain any AWS KMS customer master keys (CMKs). Before\n deleting the key store, verify that you will never need to use any of the CMKs in the key\n store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete the\n AWS KMS customer master keys (CMKs) from the key store. When the scheduled waiting period\n expires, the ScheduleKeyDeletion operation deletes the CMKs. Then it makes a best\n effort to delete the key material from the associated cluster. However, you might need to\n manually delete the orphaned key\n material from the cluster and its backups.

\n

After all CMKs are deleted from AWS KMS, use DisconnectCustomKeyStore to\n disconnect the key store from AWS KMS. Then, you can delete the custom key store.

\n

Instead of deleting the custom key store, consider using DisconnectCustomKeyStore to disconnect it from AWS KMS. While the key store is\n disconnected, you cannot create or use the CMKs in the key store. But, you do not need to\n delete CMKs and you can reconnect a disconnected custom key store at any time.

\n

If the operation succeeds, it returns a JSON object with no\nproperties.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

\n\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.

\n \n

\n Required permissions: kms:DeleteCustomKeyStore (IAM policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DeleteCustomKeyStoreRequest": { @@ -1141,7 +1153,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes key material that you previously imported. This operation makes the specified\n customer master key (CMK) unusable. For more information about importing key material into\n AWS KMS, see Importing Key\n Material in the AWS Key Management Service Developer Guide.

\n

When the specified CMK is in the PendingDeletion state, this operation does\n not change the CMK's state. Otherwise, it changes the CMK's state to\n PendingImport.

\n

After you delete key material, you can use ImportKeyMaterial to reimport\n the same key material into the CMK.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:DeleteImportedKeyMaterial (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Deletes key material that you previously imported. This operation makes the specified\n customer master key (CMK) unusable. For more information about importing key material into\n AWS KMS, see Importing Key\n Material in the AWS Key Management Service Developer Guide.

\n

When the specified CMK is in the PendingDeletion state, this operation does\n not change the CMK's state. Otherwise, it changes the CMK's state to\n PendingImport.

\n

After you delete key material, you can use ImportKeyMaterial to reimport\n the same key material into the CMK.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:DeleteImportedKeyMaterial (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DeleteImportedKeyMaterialRequest": { @@ -1150,7 +1162,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the CMK from which you are deleting imported key material. The\n Origin of the CMK must be EXTERNAL.

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Identifies the CMK from which you are deleting imported key material. The\n Origin of the CMK must be EXTERNAL.

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } } @@ -1181,12 +1193,15 @@ { "target": "com.amazonaws.kms#CustomKeyStoreNotFoundException" }, + { + "target": "com.amazonaws.kms#InvalidMarkerException" + }, { "target": "com.amazonaws.kms#KMSInternalException" } ], "traits": { - "smithy.api#documentation": "

Gets information about custom key stores in the account and region.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

\n

By default, this operation returns information about all custom key\n stores in the account and region. To get only information about a particular custom key store,\n use either the CustomKeyStoreName or CustomKeyStoreId parameter (but\n not both).

\n

To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the\n ConnectionState element in the response. If an attempt to connect the custom\n key store failed, the ConnectionState value is FAILED and the\n ConnectionErrorCode element in the response indicates the cause of the failure.\n For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.

\n

Custom key stores have a DISCONNECTED connection state if the key store has\n never been connected or you use the DisconnectCustomKeyStore operation to\n disconnect it. If your custom key store state is CONNECTED but you are having\n trouble using it, make sure that its associated AWS CloudHSM cluster is active and contains the\n minimum number of HSMs required for the operation, if any.

\n

For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the\n AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.

\n

\n Required permissions: kms:DescribeCustomKeyStores (IAM policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Gets information about custom key stores in the account and Region.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

\n

By default, this operation returns information about all custom key stores in the account and\n Region. To get only information about a particular custom key store, use either the\n CustomKeyStoreName or CustomKeyStoreId parameter (but not\n both).

\n

To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the\n ConnectionState element in the response. If an attempt to connect the custom\n key store failed, the ConnectionState value is FAILED and the\n ConnectionErrorCode element in the response indicates the cause of the failure.\n For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.

\n

Custom key stores have a DISCONNECTED connection state if the key store has\n never been connected or you use the DisconnectCustomKeyStore operation to\n disconnect it. If your custom key store state is CONNECTED but you are having\n trouble using it, make sure that its associated AWS CloudHSM cluster is active and contains the\n minimum number of HSMs required for the operation, if any.

\n

For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the\n AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.

\n

\n Required permissions: kms:DescribeCustomKeyStores (IAM policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DescribeCustomKeyStoresRequest": { @@ -1195,13 +1210,13 @@ "CustomKeyStoreId": { "target": "com.amazonaws.kms#CustomKeyStoreIdType", "traits": { - "smithy.api#documentation": "

Gets only information about the specified custom key store. Enter the key store ID.

\n

By default, this operation gets information about all custom key stores in the account and\n region. To limit the output to a particular custom key store, you can use either the\n CustomKeyStoreId or CustomKeyStoreName parameter, but not\n both.

" + "smithy.api#documentation": "

Gets only information about the specified custom key store. Enter the key store ID.

\n

By default, this operation gets information about all custom key stores in the account and\n Region. To limit the output to a particular custom key store, you can use either the\n CustomKeyStoreId or CustomKeyStoreName parameter, but not\n both.

" } }, "CustomKeyStoreName": { "target": "com.amazonaws.kms#CustomKeyStoreNameType", "traits": { - "smithy.api#documentation": "

Gets only information about the specified custom key store. Enter the friendly name of the\n custom key store.

\n

By default, this operation gets information about all custom key stores in the account and\n region. To limit the output to a particular custom key store, you can use either the\n CustomKeyStoreId or CustomKeyStoreName parameter, but not\n both.

" + "smithy.api#documentation": "

Gets only information about the specified custom key store. Enter the friendly name of the\n custom key store.

\n

By default, this operation gets information about all custom key stores in the account and\n Region. To limit the output to a particular custom key store, you can use either the\n CustomKeyStoreId or CustomKeyStoreName parameter, but not\n both.

" } }, "Limit": { @@ -1273,14 +1288,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Describes the specified customer master key (CMK).

\n

If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the\n alias with an AWS\n managed CMK and returns its KeyId and Arn in the\n response.

\n

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", + "smithy.api#documentation": "

Describes the specified customer master key (CMK).

\n

If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the\n alias with an AWS\n managed CMK and returns its KeyId and Arn in the\n response.

\n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" } } } @@ -1328,7 +1343,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the state of a customer master key (CMK) to disabled. This change temporarily\n prevents use of the CMK for cryptographic operations.

\n

For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a\n Customer Master Key in the \n AWS Key Management Service Developer Guide\n .

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:DisableKey (key policy)

\n

\n Related operations: EnableKey\n

" + "smithy.api#documentation": "

Sets the state of a customer master key (CMK) to disabled. This change temporarily\n prevents use of the CMK for cryptographic operations.

\n

For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the \n AWS Key Management Service Developer Guide\n .

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:DisableKey (key policy)

\n

\n Related operations: EnableKey\n

" } }, "com.amazonaws.kms#DisableKeyRequest": { @@ -1337,7 +1352,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the customer master key (CMK).

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Identifies the customer master key (CMK) to disable.

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } } @@ -1372,7 +1387,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disables automatic\n rotation of the key material for the specified symmetric customer master key\n (CMK).

\n

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:DisableKeyRotation (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Disables automatic\n rotation of the key material for the specified symmetric customer master key\n (CMK).

\n

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:DisableKeyRotation (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DisableKeyRotationRequest": { @@ -1381,7 +1396,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies a symmetric customer master key (CMK). You cannot enable or disable automatic\n rotation of asymmetric CMKs, CMKs\n with imported key\n material, or CMKs in a custom key store.

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Identifies a symmetric customer master key (CMK). You cannot enable or disable automatic\n rotation of asymmetric CMKs, CMKs\n with imported key\n material, or CMKs in a custom key store.

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } } @@ -1465,7 +1480,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the key state of a customer master key (CMK) to enabled. This allows you to use the\n CMK for cryptographic operations.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:EnableKey (key policy)

\n

\n Related operations: DisableKey\n

" + "smithy.api#documentation": "

Sets the key state of a customer master key (CMK) to enabled. This allows you to use the\n CMK for cryptographic operations.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:EnableKey (key policy)

\n

\n Related operations: DisableKey\n

" } }, "com.amazonaws.kms#EnableKeyRequest": { @@ -1474,7 +1489,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the customer master key (CMK).

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Identifies the customer master key (CMK) to enable.

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } } @@ -1509,7 +1524,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables automatic rotation\n of the key material for the specified symmetric customer master key (CMK).

\n

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:EnableKeyRotation (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Enables automatic rotation\n of the key material for the specified symmetric customer master key (CMK).

\n

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:EnableKeyRotation (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#EnableKeyRotationRequest": { @@ -1518,7 +1533,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.

\n \n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n \n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } } @@ -1559,7 +1574,7 @@ } ], "traits": { - "smithy.api#documentation": "

Encrypts plaintext into ciphertext by using a customer master key (CMK). The\n Encrypt operation has two primary use cases:

\n \n\n

You don't need to use the Encrypt operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a\n plaintext data key and an encrypted copy of that data key.

\n\n

When you encrypt data, you must specify a symmetric or asymmetric CMK to use in the\n encryption operation. The CMK must have a KeyUsage value of\n ENCRYPT_DECRYPT. To find the KeyUsage of a CMK, use the DescribeKey operation.

\n\n

If you use a symmetric CMK, you can use an encryption context to add additional security\n to your encryption operation. If you specify an EncryptionContext when encrypting\n data, you must specify the same encryption context (a case-sensitive exact match) when\n decrypting the data. Otherwise, the request to decrypt fails with an\n InvalidCiphertextException. For more information, see Encryption\n Context in the AWS Key Management Service Developer Guide.

\n

If you specify an asymmetric CMK, you must also specify the encryption algorithm. The\n algorithm must be compatible with the CMK type.

\n \n

When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails.

\n

You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.

\n \n\n\n

The maximum size of the data that you can encrypt varies with the type of CMK and the\n encryption algorithm that you choose.

\n \n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:Encrypt (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Encrypts plaintext into ciphertext by using a customer master key (CMK). The\n Encrypt operation has two primary use cases:

\n \n\n

You don't need to use the Encrypt operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a\n plaintext data key and an encrypted copy of that data key.

\n\n

When you encrypt data, you must specify a symmetric or asymmetric CMK to use in the\n encryption operation. The CMK must have a KeyUsage value of\n ENCRYPT_DECRYPT. To find the KeyUsage of a CMK, use the DescribeKey operation.

\n\n

If you use a symmetric CMK, you can use an encryption context to add additional security\n to your encryption operation. If you specify an EncryptionContext when encrypting\n data, you must specify the same encryption context (a case-sensitive exact match) when\n decrypting the data. Otherwise, the request to decrypt fails with an\n InvalidCiphertextException. For more information, see Encryption\n Context in the AWS Key Management Service Developer Guide.

\n

If you specify an asymmetric CMK, you must also specify the encryption algorithm. The\n algorithm must be compatible with the CMK type.

\n \n

When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails.

\n

You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.

\n \n\n\n

The maximum size of the data that you can encrypt varies with the type of CMK and the\n encryption algorithm that you choose.

\n \n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:Encrypt (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#EncryptRequest": { @@ -1568,7 +1583,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the customer master key (CMK).

\n

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", + "smithy.api#documentation": "

Identifies the customer master key (CMK) to use in the encryption operation.

\n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, @@ -1588,7 +1603,7 @@ "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" } }, "EncryptionAlgorithm": { @@ -1728,7 +1743,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a unique symmetric data key for client-side encryption. This operation returns a\n plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK)\n that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and\n store the encrypted data key with the encrypted data.

\n\n

\n GenerateDataKey returns a unique data key for each request. The bytes in the\n plaintext key are not related to the caller or the CMK.

\n\n

To generate a data key, specify the symmetric CMK that will be used to encrypt the data\n key. You cannot use an asymmetric CMK to generate data keys. To get the type of your CMK, use\n the DescribeKey operation. You must also specify the length of the data key.\n Use either the KeySpec or NumberOfBytes parameters (but not both).\n For 128-bit and 256-bit data keys, use the KeySpec parameter.

\n\n

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use\n the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure\n random byte string, use GenerateRandom.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n How to use your data key\n

\n

We recommend that you use the following pattern to encrypt data locally in your application.\n You can write your own code or use a client-side encryption library, such as the AWS Encryption SDK, the Amazon DynamoDB Encryption Client, or\n Amazon S3\n client-side encryption to do these tasks for you.

\n

To encrypt data outside of AWS KMS:

\n
    \n
  1. \n

    Use the GenerateDataKey operation to get a data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key (in the Plaintext field of the response) to\n encrypt your data outside of AWS KMS. Then erase the plaintext data key from memory.

    \n
    3. \n
  3. \n

    Store the encrypted data key (in the CiphertextBlob field of the\n response) with the encrypted data.

    \n
    4. \n
\n

To decrypt data outside of AWS KMS:

\n
    \n
  1. \n

    Use the Decrypt operation to decrypt the encrypted data key. The\n operation returns a plaintext copy of the data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key to decrypt data outside of AWS KMS, then erase the plaintext\n data key from memory.

    \n
    3. \n
\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKey (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Generates a unique symmetric data key for client-side encryption. This operation returns a\n plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK)\n that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and\n store the encrypted data key with the encrypted data.

\n\n

\n GenerateDataKey returns a unique data key for each request. The bytes in the\n plaintext key are not related to the caller or the CMK.

\n\n

To generate a data key, specify the symmetric CMK that will be used to encrypt the data\n key. You cannot use an asymmetric CMK to generate data keys. To get the type of your CMK, use\n the DescribeKey operation. You must also specify the length of the data key.\n Use either the KeySpec or NumberOfBytes parameters (but not both).\n For 128-bit and 256-bit data keys, use the KeySpec parameter.

\n\n

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use\n the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure\n random byte string, use GenerateRandom.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n How to use your\n data key\n

\n

We recommend that you use the following pattern to encrypt data locally in your\n application. You can write your own code or use a client-side encryption library, such as the\n AWS Encryption SDK, the Amazon DynamoDB Encryption Client, or\n Amazon S3\n client-side encryption to do these tasks for you.

\n

To encrypt data outside of AWS KMS:

\n
    \n
  1. \n

    Use the GenerateDataKey operation to get a data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key (in the Plaintext field of the response) to\n encrypt your data outside of AWS KMS. Then erase the plaintext data key from memory.

    \n
    3. \n
  3. \n

    Store the encrypted data key (in the CiphertextBlob field of the\n response) with the encrypted data.

    \n
    4. \n
\n

To decrypt data outside of AWS KMS:

\n
    \n
  1. \n

    Use the Decrypt operation to decrypt the encrypted data key. The\n operation returns a plaintext copy of the data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key to decrypt data outside of AWS KMS, then erase the plaintext\n data key from memory.

    \n
    3. \n
\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKey (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyPair": { @@ -1769,7 +1784,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a unique asymmetric data key pair. The GenerateDataKeyPair\n operation returns a plaintext public key, a plaintext private key, and a copy of the private\n key that is encrypted under the symmetric CMK you specify. You can use the data key pair to\n perform asymmetric cryptography outside of AWS KMS.

\n\n

\n GenerateDataKeyPair returns a unique data key pair for each request. The\n bytes in the keys are not related to the caller or the CMK that is used to encrypt the private\n key.

\n\n

You can use the public key that GenerateDataKeyPair returns to encrypt data\n or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data.\n When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n\n

To generate a data key pair, you must specify a symmetric customer master key (CMK) to\n encrypt the private key in a data key pair. You cannot use an asymmetric CMK or a CMK in a\n custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

\n\n

If you are using the data key pair to encrypt data, or for any operation where you don't\n immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation.\n GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an\n encrypted private key, but omits the plaintext private key that you need only to decrypt\n ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use\n the Decrypt operation to decrypt the encrypted private key in the data key\n pair.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKeyPair (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Generates a unique asymmetric data key pair. The GenerateDataKeyPair\n operation returns a plaintext public key, a plaintext private key, and a copy of the private\n key that is encrypted under the symmetric CMK you specify. You can use the data key pair to\n perform asymmetric cryptography outside of AWS KMS.

\n\n

\n GenerateDataKeyPair returns a unique data key pair for each request. The\n bytes in the keys are not related to the caller or the CMK that is used to encrypt the private\n key.

\n\n

You can use the public key that GenerateDataKeyPair returns to encrypt data\n or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data.\n When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n\n

To generate a data key pair, you must specify a symmetric customer master key (CMK) to\n encrypt the private key in a data key pair. You cannot use an asymmetric CMK or a CMK in a\n custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

\n\n

If you are using the data key pair to encrypt data, or for any operation where you don't\n immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation.\n GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an\n encrypted private key, but omits the plaintext private key that you need only to decrypt\n ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use\n the Decrypt operation to decrypt the encrypted private key in the data key\n pair.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKeyPair (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyPairRequest": { @@ -1784,7 +1799,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot\n specify an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your\n CMK, use the DescribeKey operation.

\n

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", + "smithy.api#documentation": "

Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot\n specify an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your\n CMK, use the DescribeKey operation.

\n \n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, @@ -1798,7 +1813,7 @@ "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" } } } @@ -1876,7 +1891,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a unique asymmetric data key pair. The\n GenerateDataKeyPairWithoutPlaintext operation returns a plaintext public key\n and a copy of the private key that is encrypted under the symmetric CMK you specify. Unlike\n GenerateDataKeyPair, this operation does not return a plaintext private\n key.

\n

To generate a data key pair, you must specify a symmetric customer master key (CMK) to\n encrypt the private key in the data key pair. You cannot use an asymmetric CMK or a CMK in a\n custom key store. To get the type and origin of your CMK, use the KeySpec field\n in the DescribeKey response.

\n

You can use the public key that GenerateDataKeyPairWithoutPlaintext returns\n to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key\n with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n

\n GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each\n request. The bytes in the key are not related to the caller or CMK that is used to encrypt the\n private key.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKeyPairWithoutPlaintext (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Generates a unique asymmetric data key pair. The\n GenerateDataKeyPairWithoutPlaintext operation returns a plaintext public key\n and a copy of the private key that is encrypted under the symmetric CMK you specify. Unlike\n GenerateDataKeyPair, this operation does not return a plaintext private\n key.

\n

To generate a data key pair, you must specify a symmetric customer master key (CMK) to\n encrypt the private key in the data key pair. You cannot use an asymmetric CMK or a CMK in a\n custom key store. To get the type and origin of your CMK, use the KeySpec field\n in the DescribeKey response.

\n

You can use the public key that GenerateDataKeyPairWithoutPlaintext returns\n to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key\n with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n

\n GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each\n request. The bytes in the key are not related to the caller or CMK that is used to encrypt the\n private key.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKeyPairWithoutPlaintext (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyPairWithoutPlaintextRequest": { @@ -1891,7 +1906,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the CMK that encrypts the private key in the data key pair. You must specify a\n symmetric CMK. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the\n type and origin of your CMK, use the DescribeKey operation.

\n

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", + "smithy.api#documentation": "

Specifies the CMK that encrypts the private key in the data key pair. You must specify a\n symmetric CMK. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the\n type and origin of your CMK, use the DescribeKey operation.

\n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, @@ -1905,7 +1920,7 @@ "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" } } } @@ -1945,7 +1960,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the symmetric CMK that encrypts the data key.

\n \n

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", + "smithy.api#documentation": "

Identifies the symmetric CMK that encrypts the data key.

\n \n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, @@ -1970,7 +1985,7 @@ "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" } } } @@ -2033,7 +2048,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a unique symmetric data key. This operation returns a data key that is encrypted\n under a customer master key (CMK) that you specify. To request an asymmetric data key pair,\n use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operations.

\n

\n GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that returns only the encrypted copy of the\n data key. This operation is useful for systems that need to encrypt data at some point, but\n not immediately. When you need to encrypt the data, you call the Decrypt\n operation on the encrypted copy of the key.

\n

It's also useful in distributed systems with different levels of trust. For example, you\n might store encrypted data in containers. One component of your system creates new containers\n and stores an encrypted data key with each container. Then, a different component puts the\n data into the containers. That component first decrypts the data key, uses the plaintext data\n key to encrypt data, puts the encrypted data into the container, and then destroys the\n plaintext data key. In this system, the component that creates the containers never sees the\n plaintext data key.

\n

\n GenerateDataKeyWithoutPlaintext returns a unique data key for each request.\n The bytes in the keys are not related to the caller or CMK that is used to encrypt the private\n key.

\n\n

To generate a data key, you must specify the symmetric customer master key (CMK) that is\n used to encrypt the data key. You cannot use an asymmetric CMK to generate a data key. To get the type\n of your CMK, use the DescribeKey operation.

\n\n

If the operation succeeds, you will find the encrypted copy of the data key in the\n CiphertextBlob field.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKeyWithoutPlaintext (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Generates a unique symmetric data key. This operation returns a data key that is encrypted\n under a customer master key (CMK) that you specify. To request an asymmetric data key pair,\n use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operations.

\n

\n GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that returns only the encrypted copy of the\n data key. This operation is useful for systems that need to encrypt data at some point, but\n not immediately. When you need to encrypt the data, you call the Decrypt\n operation on the encrypted copy of the key.

\n

It's also useful in distributed systems with different levels of trust. For example, you\n might store encrypted data in containers. One component of your system creates new containers\n and stores an encrypted data key with each container. Then, a different component puts the\n data into the containers. That component first decrypts the data key, uses the plaintext data\n key to encrypt data, puts the encrypted data into the container, and then destroys the\n plaintext data key. In this system, the component that creates the containers never sees the\n plaintext data key.

\n

\n GenerateDataKeyWithoutPlaintext returns a unique data key for each request.\n The bytes in the keys are not related to the caller or CMK that is used to encrypt the private\n key.

\n\n

To generate a data key, you must specify the symmetric customer master key (CMK) that is\n used to encrypt the data key. You cannot use an asymmetric CMK to generate a data key. To get\n the type of your CMK, use the DescribeKey operation.

\n\n

If the operation succeeds, you will find the encrypted copy of the data key in the\n CiphertextBlob field.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKeyWithoutPlaintext (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyWithoutPlaintextRequest": { @@ -2042,7 +2057,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The identifier of the symmetric customer master key (CMK) that encrypts the data\n key.

\n

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", + "smithy.api#documentation": "

The identifier of the symmetric customer master key (CMK) that encrypts the data\n key.

\n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, @@ -2067,7 +2082,7 @@ "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" } } } @@ -2112,7 +2127,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a random byte string that is cryptographically secure.

\n

By default, the random byte string is generated in AWS KMS. To generate the byte string in\n the AWS CloudHSM cluster that is associated with a custom key store, specify the custom key store\n ID.

\n

For more information about entropy and random number generation, see the AWS Key Management Service\n Cryptographic Details whitepaper.

\n \n

\n Required permissions: kms:GenerateRandom (IAM policy)

" + "smithy.api#documentation": "

Returns a random byte string that is cryptographically secure.

\n

By default, the random byte string is generated in AWS KMS. To generate the byte string in\n the AWS CloudHSM cluster that is associated with a custom key store, specify the custom key store\n ID.

\n

For more information about entropy and random number generation, see AWS Key Management Service Cryptographic Details.

\n \n

\n Required permissions: kms:GenerateRandom (IAM policy)

" } }, "com.amazonaws.kms#GenerateRandomRequest": { @@ -2178,7 +2193,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the customer master key (CMK).

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Gets the key policy for the specified customer master key (CMK).

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, @@ -2231,7 +2246,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a Boolean value that indicates whether automatic rotation of the key material is\n enabled for the specified customer master key (CMK).

\n

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. The key rotation status for these CMKs is always false.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n \n

\n Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key\n ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GetKeyRotationStatus (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Gets a Boolean value that indicates whether automatic rotation of the key material is\n enabled for the specified customer master key (CMK).

\n

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. The key rotation status for these CMKs is always false.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n \n

\n Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key\n ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GetKeyRotationStatus (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GetKeyRotationStatusRequest": { @@ -2240,7 +2255,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the customer master key (CMK).

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a\ndifferent AWS account, you must use the key ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Gets the rotation status for the specified customer master key (CMK).

\n

Specify the key ID or key ARN of the CMK. To specify a CMK in a\ndifferent AWS account, you must use the key ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } } @@ -2286,7 +2301,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the items you need to import key material into a symmetric, customer managed\n customer master key (CMK). For more information about importing key material into AWS KMS, see\n Importing Key\n Material in the AWS Key Management Service Developer Guide.

\n

This operation returns a public key and an import token. Use the public key to encrypt the\n symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.

\n

You must specify the key ID of the symmetric CMK into which you will import key material.\n This CMK's Origin must be EXTERNAL. You must also specify the\n wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key\n material. You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account.

\n

To import key material, you must use the public key and import token from the same\n response. These items are valid for 24 hours. The expiration date and time appear in the\n GetParametersForImport response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another\n GetParametersForImport request.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:GetParametersForImport (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Returns the items you need to import key material into a symmetric, customer managed\n customer master key (CMK). For more information about importing key material into AWS KMS, see\n Importing Key\n Material in the AWS Key Management Service Developer Guide.

\n

This operation returns a public key and an import token. Use the public key to encrypt the\n symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.

\n

You must specify the key ID of the symmetric CMK into which you will import key material.\n This CMK's Origin must be EXTERNAL. You must also specify the\n wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key\n material. You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account.

\n

To import key material, you must use the public key and import token from the same\n response. These items are valid for 24 hours. The expiration date and time appear in the\n GetParametersForImport response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another\n GetParametersForImport request.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:GetParametersForImport (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GetParametersForImportRequest": { @@ -2295,7 +2310,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The identifier of the symmetric CMK into which you will import key material. The\n Origin of the CMK must be EXTERNAL.

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

The identifier of the symmetric CMK into which you will import key material. The\n Origin of the CMK must be EXTERNAL.

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, @@ -2385,7 +2400,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the public key of an asymmetric CMK. Unlike the private key of a asymmetric CMK,\n which never leaves AWS KMS unencrypted, callers with kms:GetPublicKey permission\n can download the public key of an asymmetric CMK. You can share the public key to allow others\n to encrypt messages and verify signatures outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

You do not need to download the public key. Instead, you can use the public key within\n AWS KMS by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric CMK. When you use the\n public key within AWS KMS, you benefit from the authentication, authorization, and logging that\n are part of every AWS KMS operation. You also reduce of risk of encrypting data that cannot be\n decrypted. These features are not effective outside of AWS KMS. For details, see Special Considerations\n for Downloading Public Keys.

\n

To help you use the public key safely outside of AWS KMS, GetPublicKey returns\n important information about the public key in the response, including:

\n \n

Although AWS KMS cannot enforce these restrictions on external operations, it is crucial\n that you use this information to prevent the public key from being used improperly. For\n example, you can prevent a public signing key from being used encrypt data, or prevent a\n public key from being used with an encryption algorithm that is not supported by AWS KMS. You\n can also avoid errors, such as using the wrong signing algorithm in a verification\n operation.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GetPublicKey (key policy)

\n

\n Related operations: CreateKey\n

" + "smithy.api#documentation": "

Returns the public key of an asymmetric CMK. Unlike the private key of a asymmetric CMK,\n which never leaves AWS KMS unencrypted, callers with kms:GetPublicKey permission\n can download the public key of an asymmetric CMK. You can share the public key to allow others\n to encrypt messages and verify signatures outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

You do not need to download the public key. Instead, you can use the public key within\n AWS KMS by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric CMK. When you use the\n public key within AWS KMS, you benefit from the authentication, authorization, and logging that\n are part of every AWS KMS operation. You also reduce of risk of encrypting data that cannot be\n decrypted. These features are not effective outside of AWS KMS. For details, see Special\n Considerations for Downloading Public Keys.

\n

To help you use the public key safely outside of AWS KMS, GetPublicKey returns\n important information about the public key in the response, including:

\n \n

Although AWS KMS cannot enforce these restrictions on external operations, it is crucial\n that you use this information to prevent the public key from being used improperly. For\n example, you can prevent a public signing key from being used encrypt data, or prevent a\n public key from being used with an encryption algorithm that is not supported by AWS KMS. You\n can also avoid errors, such as using the wrong signing algorithm in a verification\n operation.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GetPublicKey (key policy)

\n

\n Related operations: CreateKey\n

" } }, "com.amazonaws.kms#GetPublicKeyRequest": { @@ -2394,14 +2409,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the asymmetric CMK that includes the public key.

\n \n

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", + "smithy.api#documentation": "

Identifies the asymmetric CMK that includes the public key.

\n \n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" } } } @@ -2453,13 +2468,13 @@ "EncryptionContextSubset": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

A list of key-value pairs that must be included in the encryption context of the\n cryptographic operation request. The grant allows the cryptographic operation only when the\n encryption context in the request includes the key-value pairs specified in this constraint,\n although it can include additional key-value pairs.

" + "smithy.api#documentation": "

A list of key-value pairs that must be included in the encryption context of the\n cryptographic operation request. The grant allows the cryptographic operation only when the encryption\n context in the request includes the key-value pairs specified in this constraint, although it\n can include additional key-value pairs.

" } }, "EncryptionContextEquals": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the\n request is the same as the encryption context specified in this constraint.

" + "smithy.api#documentation": "

A list of key-value pairs that must match the encryption context in the cryptographic operation\n request. The grant allows the operation only when the encryption context in the request is the\n same as the encryption context specified in this constraint.

" } } }, @@ -2685,7 +2700,7 @@ } ], "traits": { - "smithy.api#documentation": "

Imports key material into an existing symmetric AWS KMS customer master key (CMK) that was\n created without key material. After you successfully import key material into a CMK, you can\n reimport the same key material into that CMK, but you cannot import different key\n material.

\n

You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account. For more information about creating CMKs with no key material and\n then importing key material, see Importing Key Material in the\n AWS Key Management Service Developer Guide.

\n

Before using this operation, call GetParametersForImport. Its response\n includes a public key and an import token. Use the public key to encrypt the key material.\n Then, submit the import token from the same GetParametersForImport\n response.

\n

When calling this operation, you must specify the following values:

\n \n

When this operation is successful, the key state of the CMK changes from\n PendingImport to Enabled, and you can use the CMK.

\n

If this operation fails, use the exception to help determine the problem. If the error is\n related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the CMK and\n repeat the import procedure. For help, see How To Import Key\n Material in the AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:ImportKeyMaterial (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Imports key material into an existing symmetric AWS KMS customer master key (CMK) that was\n created without key material. After you successfully import key material into a CMK, you can\n reimport the same key material into that CMK, but you cannot import different key\n material.

\n

You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account. For more information about creating CMKs with no key material and\n then importing key material, see Importing Key Material in the\n AWS Key Management Service Developer Guide.

\n

Before using this operation, call GetParametersForImport. Its response\n includes a public key and an import token. Use the public key to encrypt the key material.\n Then, submit the import token from the same GetParametersForImport\n response.

\n

When calling this operation, you must specify the following values:

\n \n

When this operation is successful, the key state of the CMK changes from\n PendingImport to Enabled, and you can use the CMK.

\n

If this operation fails, use the exception to help determine the problem. If the error is\n related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the CMK and\n repeat the import procedure. For help, see How To Import Key\n Material in the AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:ImportKeyMaterial (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#ImportKeyMaterialRequest": { @@ -2694,7 +2709,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The identifier of the symmetric CMK that receives the imported key material. The CMK's\n Origin must be EXTERNAL. This must be the same CMK specified in\n the KeyID parameter of the corresponding GetParametersForImport\n request.

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

The identifier of the symmetric CMK that receives the imported key material. The CMK's\n Origin must be EXTERNAL. This must be the same CMK specified in\n the KeyID parameter of the corresponding GetParametersForImport\n request.

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, @@ -2894,7 +2909,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because the signature verification failed. Signature\n verification fails when it cannot confirm that signature was produced by signing the specified\n message with the specified CMK and signing algorithm.

", + "smithy.api#documentation": "

The request was rejected because the signature verification failed. Signature verification\n fails when it cannot confirm that signature was produced by signing the specified message with\n the specified CMK and signing algorithm.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3011,13 +3026,13 @@ "KeyState": { "target": "com.amazonaws.kms#KeyState", "traits": { - "smithy.api#documentation": "

The current status of the CMK.

\n

For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The current status of the CMK.

\n

For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK\n in the AWS Key Management Service Developer Guide.

" } }, "DeletionDate": { "target": "com.amazonaws.kms#DateType", "traits": { - "smithy.api#documentation": "

The date and time after which AWS KMS deletes the CMK. This value is present only when\n KeyState is PendingDeletion.

" + "smithy.api#documentation": "

The date and time after which AWS KMS deletes this CMK. This value is present only when the\n CMK is scheduled for deletion, that is, when its KeyState is\n PendingDeletion.

\n

When the primary key in a multi-Region key is scheduled for deletion but still has replica\n keys, its key state is PendingReplicaDeletion and the length of its waiting\n period is displayed in the PendingDeletionWindowInDays field.

" } }, "ValidTo": { @@ -3065,13 +3080,31 @@ "EncryptionAlgorithms": { "target": "com.amazonaws.kms#EncryptionAlgorithmSpecList", "traits": { - "smithy.api#documentation": "

The encryption algorithms that the CMK supports. You cannot use the CMK with other\n encryption algorithms within AWS KMS.

\n

This field appears only when the KeyUsage of the CMK is\n ENCRYPT_DECRYPT.

" + "smithy.api#documentation": "

The encryption algorithms that the CMK supports. You cannot use the CMK with other\n encryption algorithms within AWS KMS.

\n

This value is present only when the KeyUsage of the CMK is\n ENCRYPT_DECRYPT.

" } }, "SigningAlgorithms": { "target": "com.amazonaws.kms#SigningAlgorithmSpecList", "traits": { - "smithy.api#documentation": "

The signing algorithms that the CMK supports. You cannot use the CMK with other\n signing algorithms within AWS KMS.

\n

This field appears only when the KeyUsage of the CMK is\n SIGN_VERIFY.

" + "smithy.api#documentation": "

The signing algorithms that the CMK supports. You cannot use the CMK with other signing\n algorithms within AWS KMS.

\n

This field appears only when the KeyUsage of the CMK is\n SIGN_VERIFY.

" + } + }, + "MultiRegion": { + "target": "com.amazonaws.kms#NullableBooleanType", + "traits": { + "smithy.api#documentation": "

Indicates whether the CMK is a multi-Region (True) or regional\n (False) key. This value is True for multi-Region primary and\n replica CMKs and False for regional CMKs.

\n

For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide.

" + } + }, + "MultiRegionConfiguration": { + "target": "com.amazonaws.kms#MultiRegionConfiguration", + "traits": { + "smithy.api#documentation": "

Lists the primary and replica CMKs in same multi-Region CMK. This field is present only\n when the value of the MultiRegion field is True.

\n

For more information about any listed CMK, use the DescribeKey\n operation.

\n " + } + }, + "PendingDeletionWindowInDays": { + "target": "com.amazonaws.kms#PendingWindowInDaysType", + "traits": { + "smithy.api#documentation": "

The waiting period before the primary key in a multi-Region key is deleted. This waiting\n period begins when the last of its replica keys is deleted. This value is present only when\n the KeyState of the CMK is PendingReplicaDeletion. That indicates\n that the CMK is the primary key in a multi-Region key, it is scheduled for deletion, and it\n still has existing replica keys.

\n

When a regional CMK or a replica key in a multi-Region key is scheduled for deletion, its\n deletion date is displayed in the DeletionDate field. However, when the primary\n key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until\n all of its replica keys are deleted. This value displays that waiting period. When the last\n replica key in the multi-Region key is deleted, the KeyState of the scheduled\n primary key changes from PendingReplicaDeletion to PendingDeletion\n and the deletion date appears in the DeletionDate field.

" } } }, @@ -3083,6 +3116,10 @@ "type": "string", "traits": { "smithy.api#enum": [ + { + "value": "Creating", + "name": "Creating" + }, { "value": "Enabled", "name": "Enabled" @@ -3099,9 +3136,17 @@ "value": "PendingImport", "name": "PendingImport" }, + { + "value": "PendingReplicaDeletion", + "name": "PendingReplicaDeletion" + }, { "value": "Unavailable", "name": "Unavailable" + }, + { + "value": "Updating", + "name": "Updating" } ] } @@ -3193,7 +3238,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of aliases in the caller's AWS account and region. For more information about\n aliases, see CreateAlias.

\n

By default, the ListAliases operation returns all aliases in the account and\n region. To get only the aliases associated with a particular customer master key (CMK), use\n the KeyId parameter.

\n

The ListAliases response can include aliases that you created and associated\n with your customer managed CMKs, and aliases that AWS created and associated with AWS managed\n CMKs in your account. You can recognize AWS aliases because their names have the format\n aws/, such as aws/dynamodb.

\n

The response might also include aliases that have no TargetKeyId field. These\n are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases\n that AWS creates in your account, including predefined aliases, do not count against your\n AWS KMS aliases\n quota.

\n

\n Cross-account use: No. ListAliases does not\n return aliases in other AWS accounts.

\n \n \n

\n Required permissions: kms:ListAliases (IAM policy)

\n

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

\n ", + "smithy.api#documentation": "

Gets a list of aliases in the caller's AWS account and region. For more information about\n aliases, see CreateAlias.

\n

By default, the ListAliases operation returns all aliases in the account and\n region. To get only the aliases associated with a particular customer master key (CMK), use\n the KeyId parameter.

\n

The ListAliases response can include aliases that you created and associated\n with your customer managed CMKs, and aliases that AWS created and associated with AWS managed\n CMKs in your account. You can recognize AWS aliases because their names have the format\n aws/, such as aws/dynamodb.

\n

The response might also include aliases that have no TargetKeyId field. These\n are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases\n that AWS creates in your account, including predefined aliases, do not count against your\n AWS KMS aliases\n quota.

\n

\n Cross-account use: No. ListAliases does not\n return aliases in other AWS accounts.

\n \n \n

\n Required permissions: kms:ListAliases (IAM policy)

\n

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", @@ -3208,7 +3253,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Lists only aliases that are associated with the specified CMK. Enter a CMK in your AWS\n account.

\n

This parameter is optional. If you omit it, ListAliases returns all aliases\n in the account and Region.

\n \n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + "smithy.api#documentation": "

Lists only aliases that are associated with the specified CMK. Enter a CMK in your AWS\n account.

\n

This parameter is optional. If you omit it, ListAliases returns all aliases\n in the account and Region.

\n \n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" } }, "Limit": { @@ -3307,7 +3352,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Returns only grants for the specified customer master key (CMK). This parameter is\n required.

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a\ndifferent AWS account, you must use the key ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Returns only grants for the specified customer master key (CMK). This parameter is\n required.

\n

Specify the key ID or key ARN of the CMK. To specify a CMK in a\ndifferent AWS account, you must use the key ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, @@ -3389,7 +3434,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the customer master key (CMK).

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Gets the names of key policies for the specified customer master key (CMK).

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, @@ -3522,7 +3567,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns all tags on the specified customer master key (CMK).

\n

For general information about tags, including the format and syntax, see Tagging AWS resources in\n the Amazon Web Services General Reference. For information about using\n tags in AWS KMS, see Tagging\n keys.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:ListResourceTags (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Returns all tags on the specified customer master key (CMK).

\n

For general information about tags, including the format and syntax, see Tagging AWS resources in\n the Amazon Web Services General Reference. For information about using\n tags in AWS KMS, see Tagging\n keys.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:ListResourceTags (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#ListResourceTagsRequest": { @@ -3531,7 +3576,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the customer master key (CMK).

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Gets tags on the specified customer master key (CMK).

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, @@ -3555,7 +3600,7 @@ "Tags": { "target": "com.amazonaws.kms#TagList", "traits": { - "smithy.api#documentation": "

A list of tags. Each tag consists of a tag key and a tag value.

" + "smithy.api#documentation": "

A list of tags. Each tag consists of a tag key and a tag value.

\n \n

Tagging or untagging a CMK can allow or deny permission to the\n CMK. For details, see Using ABAC in AWS KMS in the AWS Key Management Service Developer Guide.

\n " } }, "NextMarker": { @@ -3598,7 +3643,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns all grants in which the specified principal is the RetiringPrincipal\n in the grant.

\n

You can specify any principal in your AWS account. The grants that are returned include\n grants for CMKs in your AWS account and other AWS accounts.

\n

You might use this operation to determine which grants you may retire. To retire a grant,\n use the RetireGrant operation.

\n

\n Cross-account use: You must specify a principal in your\n AWS account. However, this operation can return grants in any AWS account. You do not need\n kms:ListRetirableGrants permission (or any other additional permission) in any\n AWS account other than your own.

\n \n

\n Required permissions: kms:ListRetirableGrants (IAM policy) in your AWS\n account.

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Returns information about all grants in the AWS account and Region that have the specified\n retiring principal. For more information about grants, see Grants in the\n \n AWS Key Management Service Developer Guide\n .

\n

You can specify any principal in your AWS account. The grants that are returned include\n grants for CMKs in your AWS account and other AWS accounts.

\n

You might use this operation to determine which grants you may retire. To retire a grant,\n use the RetireGrant operation.

\n

\n Cross-account use: You must specify a principal in your\n AWS account. However, this operation can return grants in any AWS account. You do not need\n kms:ListRetirableGrants permission (or any other additional permission) in any\n AWS account other than your own.

\n \n

\n Required permissions: kms:ListRetirableGrants (IAM policy) in your AWS\n account.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#ListRetirableGrantsRequest": { @@ -3645,7 +3690,7 @@ "min": 1, "max": 1024 }, - "smithy.api#pattern": "[\\u0020-\\u00FF]*" + "smithy.api#pattern": "^[\\u0020-\\u00FF]*$" } }, "com.amazonaws.kms#MessageType": { @@ -3663,6 +3708,73 @@ ] } }, + "com.amazonaws.kms#MultiRegionConfiguration": { + "type": "structure", + "members": { + "MultiRegionKeyType": { + "target": "com.amazonaws.kms#MultiRegionKeyType", + "traits": { + "smithy.api#documentation": "

Indicates whether the CMK is a PRIMARY or REPLICA key.

" + } + }, + "PrimaryKey": { + "target": "com.amazonaws.kms#MultiRegionKey", + "traits": { + "smithy.api#documentation": "

Displays the key ARN and Region of the primary key. This field includes the current CMK if\n it is the primary key.

" + } + }, + "ReplicaKeys": { + "target": "com.amazonaws.kms#MultiRegionKeyList", + "traits": { + "smithy.api#documentation": "

displays the key ARNs and Regions of all replica keys. This field includes the current CMK\n if it is a replica key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration of this multi-Region CMK. This field appears only when the CMK\n is a primary or replica of a multi-Region CMK.

\n

For more information about any listed CMK, use the DescribeKey\n operation.

" + } + }, + "com.amazonaws.kms#MultiRegionKey": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.kms#ArnType", + "traits": { + "smithy.api#documentation": "

Displays the key ARN of a primary or replica key of a multi-Region key.

" + } + }, + "Region": { + "target": "com.amazonaws.kms#RegionType", + "traits": { + "smithy.api#documentation": "

Displays the AWS Region of a primary or replica key in a multi-Region key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the primary or replica key in a multi-Region key.

" + } + }, + "com.amazonaws.kms#MultiRegionKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.kms#MultiRegionKey" + } + }, + "com.amazonaws.kms#MultiRegionKeyType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PRIMARY", + "name": "PRIMARY" + }, + { + "value": "REPLICA", + "name": "REPLICA" + } + ] + } + }, "com.amazonaws.kms#NotFoundException": { "type": "structure", "members": { @@ -3676,6 +3788,12 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.kms#NullableBooleanType": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.kms#NumberOfBytesType": { "type": "integer", "traits": { @@ -3738,7 +3856,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[\\w]+" + "smithy.api#pattern": "^[\\w]+$" } }, "com.amazonaws.kms#PolicyType": { @@ -3748,7 +3866,7 @@ "min": 1, "max": 131072 }, - "smithy.api#pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" } }, "com.amazonaws.kms#PrincipalIdType": { @@ -3811,7 +3929,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the customer master key (CMK).

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Sets the key policy on the specified customer master key (CMK).

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, @@ -3825,7 +3943,7 @@ "Policy": { "target": "com.amazonaws.kms#PolicyType", "traits": { - "smithy.api#documentation": "

The key policy to attach to the CMK.

\n

The key policy must meet the following criteria:

\n \n

The key policy cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the AWS Key Management Service Developer Guide.

", + "smithy.api#documentation": "

The key policy to attach to the CMK.

\n

The key policy must meet the following criteria:

\n \n

The key policy cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the\n AWS Key Management Service Developer Guide.

", "smithy.api#required": {} } }, @@ -3878,7 +3996,7 @@ } ], "traits": { - "smithy.api#documentation": "

Decrypts ciphertext and then reencrypts it entirely within AWS KMS. You can use this\n operation to change the customer master key (CMK) under which data is encrypted, such as when\n you manually rotate a\n CMK or change the CMK that protects a ciphertext. You can also use it to reencrypt ciphertext\n under the same CMK, such as to change the encryption context of a ciphertext.

\n

The ReEncrypt operation can decrypt ciphertext that was encrypted by using an\n AWS KMS CMK in an AWS KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the\n public key of an asymmetric CMK outside of AWS KMS. However, it cannot decrypt ciphertext\n produced by other libraries, such as the AWS Encryption SDK or Amazon S3 client-side encryption.\n These libraries return a ciphertext format that is incompatible with AWS KMS.

\n

When you use the ReEncrypt operation, you need to provide information for the\n decrypt operation and the subsequent encrypt operation.

\n \n \n \n \n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. The source CMK and destination\n CMK can be in different AWS accounts. Either or both CMKs can be in a different account than\n the caller.

\n\n

\n Required permissions:

\n \n

To permit reencryption from or to a CMK, include the \"kms:ReEncrypt*\"\n permission in your key policy. This permission is\n automatically included in the key policy when you use the console to create a CMK. But you\n must include it manually when you create a CMK programmatically or when you use the PutKeyPolicy operation to set a key policy.

\n \n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Decrypts ciphertext and then reencrypts it entirely within AWS KMS. You can use this\n operation to change the customer master key (CMK) under which data is encrypted, such as when\n you manually rotate a CMK or change the CMK that protects a ciphertext. You can also\n use it to reencrypt ciphertext under the same CMK, such as to change the encryption\n context of a ciphertext.

\n

The ReEncrypt operation can decrypt ciphertext that was encrypted by using an\n AWS KMS CMK in an AWS KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the\n public key of an asymmetric CMK outside\n of AWS KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the\n AWS Encryption SDK or Amazon S3 client-side\n encryption. These libraries return a ciphertext format that is incompatible with\n AWS KMS.

\n

When you use the ReEncrypt operation, you need to provide information for the\n decrypt operation and the subsequent encrypt operation.

\n \n \n \n \n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. The source CMK and destination\n CMK can be in different AWS accounts. Either or both CMKs can be in a different account than\n the caller.

\n\n

\n Required permissions:

\n \n

To permit reencryption from or to a CMK, include the \"kms:ReEncrypt*\"\n permission in your key policy. This permission is\n automatically included in the key policy when you use the console to create a CMK. But you\n must include it manually when you create a CMK programmatically or when you use the PutKeyPolicy operation to set a key policy.

\n \n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#ReEncryptRequest": { @@ -3900,13 +4018,13 @@ "SourceKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the customer master key (CMK) that\n AWS KMS will use to decrypt the ciphertext before it is re-encrypted. Enter a key ID of the CMK\n that was used to encrypt the ciphertext.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric CMK.\n If you used a symmetric CMK, AWS KMS can get the CMK from metadata that it adds to the\n symmetric ciphertext blob. However, it is always recommended as a best practice. This practice\n ensures that you use the CMK that you intend.

\n \n

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" + "smithy.api#documentation": "

Specifies the customer master key (CMK) that\n AWS KMS will use to decrypt the ciphertext before it is re-encrypted. Enter a key ID of the CMK\n that was used to encrypt the ciphertext.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric CMK.\n If you used a symmetric CMK, AWS KMS can get the CMK from metadata that it adds to the\n symmetric ciphertext blob. However, it is always recommended as a best practice. This practice\n ensures that you use the CMK that you intend.

\n \n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" } }, "DestinationKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the CMK that is used to reencrypt the data. Specify a symmetric or\n asymmetric CMK with a KeyUsage value of ENCRYPT_DECRYPT. To find the\n KeyUsage value of a CMK, use the DescribeKey\n operation.

\n

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", + "smithy.api#documentation": "

A unique identifier for the CMK that is used to reencrypt the data. Specify a symmetric or\n asymmetric CMK with a KeyUsage value of ENCRYPT_DECRYPT. To find the\n KeyUsage value of a CMK, use the DescribeKey\n operation.

\n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, @@ -3931,7 +4049,7 @@ "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" } } } @@ -3971,6 +4089,126 @@ } } }, + "com.amazonaws.kms#RegionType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^([a-z]+-){2,3}\\d+$" + } + }, + "com.amazonaws.kms#ReplicateKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.kms#ReplicateKeyRequest" + }, + "output": { + "target": "com.amazonaws.kms#ReplicateKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kms#AlreadyExistsException" + }, + { + "target": "com.amazonaws.kms#DisabledException" + }, + { + "target": "com.amazonaws.kms#InvalidArnException" + }, + { + "target": "com.amazonaws.kms#KMSInternalException" + }, + { + "target": "com.amazonaws.kms#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.kms#LimitExceededException" + }, + { + "target": "com.amazonaws.kms#MalformedPolicyDocumentException" + }, + { + "target": "com.amazonaws.kms#NotFoundException" + }, + { + "target": "com.amazonaws.kms#TagException" + }, + { + "target": "com.amazonaws.kms#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Replicates a multi-Region key into the specified Region. This operation creates a\n multi-Region replica key based on a multi-Region primary key in a different Region of the same\n AWS partition. You can create multiple replicas of a primary key, but each must be in a\n different Region. To create a multi-Region primary key, use the CreateKey\n operation.

\n

This operation supports multi-Region keys, an AWS KMS feature that lets you create multiple\n interoperable CMKs in different AWS Regions. Because these CMKs have the same key ID, key\n material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt\n it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide.

\n

A replica key is a fully-functional CMK that can be used\n independently of its primary and peer replica keys. A primary key and its replica keys share\n properties that make them interoperable. They have the same key ID and key material. They also\n have the same key\n spec, key\n usage, key\n material origin, and automatic key rotation status. AWS KMS automatically synchronizes these shared\n properties among related multi-Region keys. All other properties of a replica key can differ,\n including its key\n policy, tags, aliases, and key\n state. AWS KMS pricing and quotas for CMKs apply to each primary key and replica\n key.

\n

When this operation completes, the new replica key has a transient key state of\n Creating. This key state changes to Enabled (or\n PendingImport) after a few seconds when the process of creating the new replica\n key is complete. While the key state is Creating, you can manage key, but you\n cannot yet use it in cryptographic operations. If you are creating and using the replica key\n programmatically, retry on KMSInvalidStateException or call\n DescribeKey to check its KeyState value before using it. For\n details about the Creating key state, see Key state: Effect on your CMK in the\n AWS Key Management Service Developer Guide.

\n

The AWS CloudTrail log of a ReplicateKey operation records a\n ReplicateKey operation in the primary key's Region and a CreateKey operation in the replica key's Region.

\n

If you replicate a multi-Region primary key with imported key material, the replica key is\n created with no key material. You must import the same key material that you imported into the\n primary key. For details, see Importing key material into multi-Region keys in the AWS Key Management Service Developer Guide.

\n

To convert a replica key to a primary key, use the UpdatePrimaryRegion\n operation.

\n \n

\n ReplicateKey uses different default values for the KeyPolicy and\n Tags parameters than those used in the AWS KMS console. For details, see the\n parameter descriptions.

\n \n

\n Cross-account use: No. You cannot use this operation to\n create a CMK in a different AWS account.

\n

\n Required permissions:

\n \n

\n Related operations\n

\n " + } + }, + "com.amazonaws.kms#ReplicateKeyRequest": { + "type": "structure", + "members": { + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "

Identifies the multi-Region primary key that is being replicated. To determine whether a\n CMK is a multi-Region primary key, use the DescribeKey operation to check\n the value of the MultiRegionKeyType property.

\n \n

Specify the key ID or key ARN of a multi-Region primary key.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#required": {} + } + }, + "ReplicaRegion": { + "target": "com.amazonaws.kms#RegionType", + "traits": { + "smithy.api#documentation": "

The Region ID of the AWS Region for this replica key.

\n

Enter the Region ID, such as us-east-1 or ap-southeast-2. For a\n list of AWS Regions in which AWS KMS is supported, see AWS KMS service endpoints in the\n Amazon Web Services General Reference.

\n

The replica must be in a different AWS Region than its primary key and other replicas of\n that primary key, but in the same AWS partition. AWS KMS must be available in the replica\n Region. If the Region is not enabled by default, the AWS account must be enabled in the\n Region.

\n

For information about AWS partitions, see Amazon Resource Names (ARNs) in the\n Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a\n Region and Disabling a Region in the\n Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + }, + "Policy": { + "target": "com.amazonaws.kms#PolicyType", + "traits": { + "smithy.api#documentation": "

The key policy to attach to the CMK. This parameter is optional. If you do not provide a key policy, AWS KMS attaches the default key policy to the CMK.

\n

The key policy is not a shared property of multi-Region keys. You can specify the same key\n policy or a different key policy for each key in a set of related multi-Region keys. AWS KMS\n does not synchronize this property.

\n

If you provide a key policy, it must meet the following criteria:

\n " + } + }, + "BypassPolicyLockoutSafetyCheck": { + "target": "com.amazonaws.kms#BooleanType", + "traits": { + "smithy.api#documentation": "

A flag to indicate whether to bypass the key policy lockout safety check.

\n \n

Setting this value to true increases the risk that the CMK becomes unmanageable. Do not\n set this value to true indiscriminately.

\n

For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

\n \n

Use this parameter only when you intend to prevent the principal that is making the\n request from making a subsequent PutKeyPolicy request on the CMK.

\n

The default value is false.

" + } + }, + "Description": { + "target": "com.amazonaws.kms#DescriptionType", + "traits": { + "smithy.api#documentation": "

A description of the CMK. Use a description that helps you decide whether the CMK is\n appropriate for a task. The default value is an empty string (no description).

\n

The description is not a shared property of multi-Region keys. You can specify the same\n description or a different description for each key in a set of related multi-Region keys. AWS\n KMS does not synchronize this property.

" + } + }, + "Tags": { + "target": "com.amazonaws.kms#TagList", + "traits": { + "smithy.api#documentation": "

Assigns one or more tags to the replica key. Use this parameter to tag the CMK when it is created.\n To tag an existing CMK, use the TagResource operation.

\n \n

Tagging or untagging a CMK can allow or deny permission to the\n CMK. For details, see Using ABAC in AWS KMS in the AWS Key Management Service Developer Guide.

\n \n

To use this parameter, you must have kms:TagResource permission in an IAM policy.

\n

Tags are not a shared property of multi-Region keys. You can specify the same tags or\n different tags for each key in a set of related multi-Region keys. AWS KMS does not\n synchronize this property.

\n

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are\n required, but the tag value can be an empty (null) string. You cannot have more than one tag\n on a CMK with the same tag key. If you specify an existing tag key with a different tag value,\n AWS KMS replaces the current tag value with the specified one.

\n

When you assign tags to an AWS resource, AWS generates a cost allocation\n report with usage and costs aggregated by tags. Tags can also be used to control access to a CMK. For details,\n see Tagging Keys.

" + } + } + } + }, + "com.amazonaws.kms#ReplicateKeyResponse": { + "type": "structure", + "members": { + "ReplicaKeyMetadata": { + "target": "com.amazonaws.kms#KeyMetadata", + "traits": { + "smithy.api#documentation": "

Displays details about the new replica CMK, including its Amazon Resource Name (key\n ARN) and key state. It also includes the ARN and AWS Region of its primary key and other\n replica keys.

" + } + }, + "ReplicaPolicy": { + "target": "com.amazonaws.kms#PolicyType", + "traits": { + "smithy.api#documentation": "

The key policy of the new replica key. The value is a key policy document in JSON\n format.

" + } + }, + "ReplicaTags": { + "target": "com.amazonaws.kms#TagList", + "traits": { + "smithy.api#documentation": "

The tags on the new replica key. The value is a list of tag key and tag value\n pairs.

" + } + } + } + }, "com.amazonaws.kms#RetireGrant": { "type": "operation", "input": { @@ -4000,7 +4238,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retires a grant. To clean up, you can retire a grant when you're done using it. You should\n revoke a grant when you intend to actively deny operations that depend on it. The following\n are permitted to call this API:

\n \n

You must identify the grant to retire by its grant token or by a combination of the grant\n ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a\n unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier\n of a grant. The CreateGrant operation returns both.

\n \n

\n Cross-account use: Yes. You can retire a grant on a CMK\n in a different AWS account.

\n

\n Required permissions:: Permission to retire a grant is\n specified in the grant. You cannot control access to this operation in a policy. For more\n information, see Using\n grants in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To\n identify the grant to retire, use a grant token, or both the grant ID and a\n key identifier (key ID or key ARN) of the customer master key (CMK). The CreateGrant operation returns both values.

\n

This operation can be called by the retiring principal for a grant,\n by the grantee principal if the grant allows the RetireGrant\n operation, and by the AWS account (root user) in which the grant is created. It can also be\n called by principals to whom permission for retiring a grant is delegated. For details, see\n Retiring and\n revoking grants in the AWS Key Management Service Developer Guide.

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n AWS Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

\n Cross-account use: Yes. You can retire a grant on a CMK\n in a different AWS account.

\n

\n Required permissions::Permission to retire a grant is\n determined primarily by the grant. For details, see Retiring and revoking grants in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#RetireGrantRequest": { @@ -4009,19 +4247,19 @@ "GrantToken": { "target": "com.amazonaws.kms#GrantTokenType", "traits": { - "smithy.api#documentation": "

Token that identifies the grant to be retired.

" + "smithy.api#documentation": "

Identifies the grant to be retired. You can use a grant token to identify a new grant even\n before it has achieved eventual consistency.

\n

Only the CreateGrant operation returns a grant token. For details, see\n Grant token\n and Eventual consistency in the AWS Key Management Service Developer Guide.

" } }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CMK associated with the grant.

\n

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

" + "smithy.api#documentation": "

The key ARN CMK associated with the grant. To find the key ARN, use the ListKeys operation.

\n

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

" } }, "GrantId": { "target": "com.amazonaws.kms#GrantIdType", "traits": { - "smithy.api#documentation": "

Unique identifier of the grant to retire. The grant ID is returned in the response to a\n CreateGrant operation.

\n " + "smithy.api#documentation": "

Identifies the grant to retire. To get the grant ID, use CreateGrant,\n ListGrants, or ListRetirableGrants.

\n " } } } @@ -4052,7 +4290,7 @@ } ], "traits": { - "smithy.api#documentation": "

Revokes the specified grant for the specified customer master key (CMK). You can revoke a\n grant to actively deny operations that depend on it.

\n

\n Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key\n ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:RevokeGrant (key policy)

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Deletes the specified grant. You revoke a grant to terminate the permissions that the\n grant allows. For more\n information, see Retiring and revoking grants in\n the \n AWS Key Management Service Developer Guide\n .

\n

When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout AWS KMS. This state is known as eventual consistency. For details, see Eventual consistency in\n the \n AWS Key Management Service Developer Guide\n .

\n

\n Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key\n ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:RevokeGrant (key policy).

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#RevokeGrantRequest": { @@ -4061,14 +4299,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the customer master key associated with the grant.

\n \n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a\ndifferent AWS account, you must use the key ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

A unique identifier for the customer master key (CMK) associated with the grant. To get\n the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

\n \n

Specify the key ID or key ARN of the CMK. To specify a CMK in a\ndifferent AWS account, you must use the key ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, "GrantId": { "target": "com.amazonaws.kms#GrantIdType", "traits": { - "smithy.api#documentation": "

Identifier of the grant to be revoked.

", + "smithy.api#documentation": "

Identifies the grant to revoke. To get the grant ID, use CreateGrant,\n ListGrants, or ListRetirableGrants.

", "smithy.api#required": {} } } @@ -4100,7 +4338,7 @@ } ], "traits": { - "smithy.api#documentation": "

Schedules the deletion of a customer master key (CMK). You may provide a waiting period,\n specified in days, before deletion occurs. If you do not provide a waiting period, the default\n period of 30 days is used. When this operation is successful, the key state of the CMK changes\n to PendingDeletion. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period\n ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that\n refer to it.

\n \n

Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is\n deleted, all data that was encrypted under the CMK is unrecoverable. To prevent the use of a\n CMK without deleting it, use DisableKey.

\n \n

If you schedule deletion of a CMK from a custom key store, when the waiting period\n expires, ScheduleKeyDeletion deletes the CMK from AWS KMS. Then AWS KMS makes a best\n effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need\n to manually delete the orphaned key\n material from the cluster and its backups.

\n

For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n \n

\n Required permissions: kms:ScheduleKeyDeletion (key policy)

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Schedules the deletion of a customer master key (CMK). By default, AWS KMS applies a waiting\n period of 30 days, but you can specify a waiting period of 7-30 days. When this operation is\n successful, the key state of the CMK changes to PendingDeletion and the key can't\n be used in any cryptographic operations. It remains in this state for the duration of the\n waiting period. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK,\n its key material, and all AWS KMS data associated with it, including all aliases that refer to\n it.

\n \n

Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is\n deleted, all data that was encrypted under the CMK is unrecoverable. (The only exception is\n a multi-Region replica key.) To prevent the use of a CMK without deleting it, use DisableKey.

\n \n

If you schedule deletion of a CMK from a custom key store, when the waiting period\n expires, ScheduleKeyDeletion deletes the CMK from AWS KMS. Then AWS KMS makes a best\n effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need\n to manually delete the orphaned key\n material from the cluster and its backups.

\n

You can schedule the deletion of a multi-Region primary key and its replica keys at any\n time. However, AWS KMS will not delete a multi-Region primary key with existing replica keys. If\n you schedule the deletion of a primary key with replicas, its key state changes to\n PendingReplicaDeletion and it cannot be replicated or used in cryptographic\n operations. This status can continue indefinitely. When the last of its replicas keys is\n deleted (not just scheduled), the key state of the primary key changes to\n PendingDeletion and its waiting period (PendingWindowInDays)\n begins. For details, see Deleting multi-Region keys in the AWS Key Management Service Developer Guide.

\n

For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n \n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n \n

\n Required permissions: kms:ScheduleKeyDeletion (key policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#ScheduleKeyDeletionRequest": { @@ -4109,14 +4347,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The unique identifier of the customer master key (CMK) to delete.

\n \n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

The unique identifier of the customer master key (CMK) to delete.

\n \n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, "PendingWindowInDays": { "target": "com.amazonaws.kms#PendingWindowInDaysType", "traits": { - "smithy.api#documentation": "

The waiting period, specified in number of days. After the waiting period ends, AWS KMS\n deletes the customer master key (CMK).

\n

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If\n you do not include a value, it defaults to 30.

" + "smithy.api#documentation": "

The waiting period, specified in number of days. After the waiting period ends, AWS KMS\n deletes the customer master key (CMK).

\n

If the CMK is a multi-Region primary key with replicas, the waiting period begins when the\n last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

\n

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If\n you do not include a value, it defaults to 30.

" } } } @@ -4133,7 +4371,19 @@ "DeletionDate": { "target": "com.amazonaws.kms#DateType", "traits": { - "smithy.api#documentation": "

The date and time after which AWS KMS deletes the customer master key (CMK).

" + "smithy.api#documentation": "

The date and time after which AWS KMS deletes the customer master key (CMK).

\n

If the CMK is a multi-Region primary key with replica keys, this field does not appear.\n The deletion date for the primary key isn't known until its last replica key is\n deleted.

" + } + }, + "KeyState": { + "target": "com.amazonaws.kms#KeyState", + "traits": { + "smithy.api#documentation": "

The current status of the CMK.

\n

For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK\n in the AWS Key Management Service Developer Guide.

" + } + }, + "PendingWindowInDays": { + "target": "com.amazonaws.kms#PendingWindowInDaysType", + "traits": { + "smithy.api#documentation": "

The waiting period before the CMK is deleted.

\n

If the CMK is a multi-Region primary key with replicas, the waiting period begins when the\n last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

" } } } @@ -4173,7 +4423,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a digital\n signature for a message or message digest by using the private key in an asymmetric\n CMK. To verify the signature, use the Verify operation, or use the public\n key in the same asymmetric CMK outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

Digital signatures are generated and verified by using asymmetric key pair, such as an RSA\n or ECC pair that is represented by an asymmetric customer master key (CMK). The key owner (or\n an authorized user) uses their private key to sign a message. Anyone with the public key can\n verify that the message was signed with that particular private key and that the message\n hasn't changed since it was signed.

\n

To use the Sign operation, provide the following information:

\n \n \n

When signing a message, be sure to record the CMK and the signing algorithm. This\n information is required to verify the signature.

\n \n

To verify the signature that this operation generates, use the Verify\n operation. Or use the GetPublicKey operation to download the public key and\n then use the public key to verify the signature outside of AWS KMS.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:Sign (key policy)

\n

\n Related operations: Verify\n

" + "smithy.api#documentation": "

Creates a digital\n signature for a message or message digest by using the private key in an asymmetric\n CMK. To verify the signature, use the Verify operation, or use the public\n key in the same asymmetric CMK outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

Digital signatures are generated and verified by using asymmetric key pair, such as an RSA\n or ECC pair that is represented by an asymmetric customer master key (CMK). The key owner (or\n an authorized user) uses their private key to sign a message. Anyone with the public key can\n verify that the message was signed with that particular private key and that the message\n hasn't changed since it was signed.

\n

To use the Sign operation, provide the following information:

\n \n \n

When signing a message, be sure to record the CMK and the signing algorithm. This\n information is required to verify the signature.

\n \n

To verify the signature that this operation generates, use the Verify\n operation. Or use the GetPublicKey operation to download the public key and\n then use the public key to verify the signature outside of AWS KMS.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:Sign (key policy)

\n

\n Related operations: Verify\n

" } }, "com.amazonaws.kms#SignRequest": { @@ -4182,7 +4432,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the\n message. The KeyUsage type of the CMK must be SIGN_VERIFY. To find\n the KeyUsage of a CMK, use the DescribeKey operation.

\n \n

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", + "smithy.api#documentation": "

Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the\n message. The KeyUsage type of the CMK must be SIGN_VERIFY. To find\n the KeyUsage of a CMK, use the DescribeKey operation.

\n \n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, @@ -4202,7 +4452,7 @@ "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" } }, "SigningAlgorithm": { @@ -4220,7 +4470,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the\n message.

" + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.

" } }, "Signature": { @@ -4368,7 +4618,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or edits tags on a customer managed CMK.

\n

Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.\n The tag value can be an empty (null) string.

\n

To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing\n tag key and a new tag value.

\n

You can use this operation to tag a customer managed CMK, but you cannot\n tag an AWS\n managed CMK, an AWS owned CMK, or an alias.

\n

For general information about tags, including the format and syntax, see Tagging AWS resources in\n the Amazon Web Services General Reference. For information about using\n tags in AWS KMS, see Tagging\n keys.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:TagResource (key policy)

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Adds or edits tags on a customer managed CMK.

\n \n

Tagging or untagging a CMK can allow or deny permission to the\n CMK. For details, see Using ABAC in AWS KMS in the AWS Key Management Service Developer Guide.

\n \n

Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.\n The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag\n value. To edit a tag, specify an existing tag key and a new tag value.

\n

You can use this operation to tag a customer managed CMK, but you cannot\n tag an AWS\n managed CMK, an AWS owned CMK, a custom key store, or\n an alias.

\n

You can also add tags to a CMK while creating it (CreateKey) or replicating it (ReplicateKey).

\n

For information about using tags in AWS KMS, see Tagging keys. For general information about\n tags, including the format and syntax, see Tagging AWS resources in the Amazon\n Web Services General Reference.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:TagResource (key policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#TagResourceRequest": { @@ -4377,7 +4627,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies a customer managed CMK in the account and Region.

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Identifies a customer managed CMK in the account and Region.

\n \n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, @@ -4511,6 +4761,9 @@ { "target": "com.amazonaws.kms#ReEncrypt" }, + { + "target": "com.amazonaws.kms#ReplicateKey" + }, { "target": "com.amazonaws.kms#RetireGrant" }, @@ -4538,6 +4791,9 @@ { "target": "com.amazonaws.kms#UpdateKeyDescription" }, + { + "target": "com.amazonaws.kms#UpdatePrimaryRegion" + }, { "target": "com.amazonaws.kms#Verify" } @@ -4606,7 +4862,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes tags from a customer managed CMK. To delete a tag,\n specify the tag key and the CMK.

\n

When it succeeds, the UntagResource operation doesn't return any output.\n Also, if the specified tag key isn't found on the CMK, it doesn't throw an exception or return\n a response. To confirm that the operation worked, use the ListResourceTags operation.

\n \n

For general information about tags, including the format and syntax, see Tagging AWS resources in\n the Amazon Web Services General Reference. For information about using\n tags in AWS KMS, see Tagging\n keys.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:UntagResource (key policy)

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Deletes tags from a customer managed CMK. To delete a tag,\n specify the tag key and the CMK.

\n \n

Tagging or untagging a CMK can allow or deny permission to the\n CMK. For details, see Using ABAC in AWS KMS in the AWS Key Management Service Developer Guide.

\n \n

When it succeeds, the UntagResource operation doesn't return any output.\n Also, if the specified tag key isn't found on the CMK, it doesn't throw an exception or return\n a response. To confirm that the operation worked, use the ListResourceTags operation.

\n \n

For information about using tags in AWS KMS, see Tagging keys. For general information about\n tags, including the format and syntax, see Tagging AWS resources in the Amazon\n Web Services General Reference.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:UntagResource (key policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#UntagResourceRequest": { @@ -4615,7 +4871,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the CMK from which you are removing tags.

\n \n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Identifies the CMK from which you are removing tags.

\n \n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, @@ -4651,7 +4907,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates an existing AWS KMS alias with a different customer master key (CMK). Each alias\n is associated with only one CMK at a time, although a CMK can have multiple aliases. The alias\n and the CMK must be in the same AWS account and region.

\n

The current and new CMK must be the same type (both symmetric or both asymmetric), and\n they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY).\n This restriction prevents errors in code that uses aliases. If you must assign an alias to a\n different type of CMK, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.

\n

You cannot use UpdateAlias to change an alias name. To change an alias name,\n use DeleteAlias to delete the old alias and CreateAlias to\n create a new alias.

\n

Because an alias is not a property of a CMK, you can create, update, and delete the\n aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from\n the DescribeKey operation. To get the aliases of all CMKs in the account,\n use the ListAliases operation.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " + "smithy.api#documentation": "

Associates an existing AWS KMS alias with a different customer master key (CMK). Each alias\n is associated with only one CMK at a time, although a CMK can have multiple aliases. The alias\n and the CMK must be in the same AWS account and Region.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the CMK. For details, see Using ABAC in AWS KMS in the AWS Key Management Service Developer Guide.

\n \n

The current and new CMK must be the same type (both symmetric or both asymmetric), and\n they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY).\n This restriction prevents errors in code that uses aliases. If you must assign an alias to a\n different type of CMK, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.

\n

You cannot use UpdateAlias to change an alias name. To change an alias name,\n use DeleteAlias to delete the old alias and CreateAlias to\n create a new alias.

\n

Because an alias is not a property of a CMK, you can create, update, and delete the\n aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from\n the DescribeKey operation. To get the aliases of all CMKs in the account,\n use the ListAliases operation.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#UpdateAliasRequest": { @@ -4667,7 +4923,7 @@ "TargetKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the customer managed CMK to associate with the alias. You don't have permission\n to associate an alias with an AWS managed CMK.

\n

The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK\n must be the same type as the current target CMK (both symmetric or both asymmetric) and they\n must have the same key usage.

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

\n

To verify that the alias\n is mapped to the correct CMK, use ListAliases.

", + "smithy.api#documentation": "

Identifies the customer managed CMK to associate with the alias. You don't have permission to\n associate an alias with an AWS managed CMK.

\n

The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK\n must be the same type as the current target CMK (both symmetric or both asymmetric) and they\n must have the same key usage.

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

\n

To verify that the alias\n is mapped to the correct CMK, use ListAliases.

", "smithy.api#required": {} } } @@ -4768,7 +5024,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the description of a customer master key (CMK). To see the description of a CMK,\n use DescribeKey.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:UpdateKeyDescription (key policy)

\n

\n Related operations\n

\n " + "smithy.api#documentation": "

Updates the description of a customer master key (CMK). To see the description of a CMK,\n use DescribeKey.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:UpdateKeyDescription (key policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#UpdateKeyDescriptionRequest": { @@ -4777,7 +5033,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the customer master key (CMK).

\n

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Updates the description of the specified customer master key (CMK).

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, @@ -4790,6 +5046,54 @@ } } }, + "com.amazonaws.kms#UpdatePrimaryRegion": { + "type": "operation", + "input": { + "target": "com.amazonaws.kms#UpdatePrimaryRegionRequest" + }, + "errors": [ + { + "target": "com.amazonaws.kms#DisabledException" + }, + { + "target": "com.amazonaws.kms#InvalidArnException" + }, + { + "target": "com.amazonaws.kms#KMSInternalException" + }, + { + "target": "com.amazonaws.kms#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.kms#NotFoundException" + }, + { + "target": "com.amazonaws.kms#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the primary key of a multi-Region key.

\n

This operation changes the replica key in the specified Region to a primary key and\n changes the former primary key to a replica key. For example, suppose you have a primary key\n in us-east-1 and a replica key in eu-west-2. If you run\n UpdatePrimaryRegion with a PrimaryRegion value of\n eu-west-2, the primary key is now the key in eu-west-2, and the\n key in us-east-1 becomes a replica key. For details, see

\n

This operation supports multi-Region keys, an AWS KMS feature that lets you create multiple\n interoperable CMKs in different AWS Regions. Because these CMKs have the same key ID, key\n material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt\n it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide.

\n

The primary key of a multi-Region key is the source for properties\n that are always shared by primary and replica keys, including the key material, key ID, key spec, key usage, key material\n origin, and automatic\n key rotation. It's the only key that can be replicated. You cannot delete the primary\n key until all replicas are deleted.

\n

The key ID and primary Region that you specify uniquely identify the replica key that will\n become the primary key. The primary Region must already have a replica key. This operation\n does not create a CMK in the specified Region. To find the replica keys, use the DescribeKey operation on the primary key or any replica key. To create a replica\n key, use the ReplicateKey operation.

\n

You can run this operation while using the affected multi-Region keys in cryptographic\n operations. This operation should not delay, interrupt, or cause failures in cryptographic\n operations.

\n

Even after this operation completes, the process of updating the primary Region might\n still be in progress for a few more seconds. Operations such as DescribeKey might\n display both the old and new primary keys as replicas. The old and new primary keys have a\n transient key state of Updating. The original key state is restored when the\n update is complete. While the key state is Updating, you can use the keys in\n cryptographic operations, but you cannot replicate the new primary key or perform certain\n management operations, such as enabling or disabling these keys. For details about the\n Updating key state, see Key state:\n Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

This operation does not return any output. To verify that primary key is changed, use the\n DescribeKey operation.

\n

\n Cross-account use: No. You cannot use this operation in a\n different AWS account.

\n

\n Required permissions:

\n \n

\n Related operations\n

\n " + } + }, + "com.amazonaws.kms#UpdatePrimaryRegionRequest": { + "type": "structure", + "members": { + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "

Identifies the current primary key. When the operation completes, this CMK will be a\n replica key.

\n \n

Specify the key ID or key ARN of a multi-Region primary key.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

", + "smithy.api#required": {} + } + }, + "PrimaryRegion": { + "target": "com.amazonaws.kms#RegionType", + "traits": { + "smithy.api#documentation": "

The AWS Region of the new primary key. Enter the Region ID, such as us-east-1\n or ap-southeast-2. There must be an existing replica key in this Region.

\n

When the operation completes, the multi-Region key in this Region will be the primary\n key.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.kms#Verify": { "type": "operation", "input": { @@ -4828,7 +5132,7 @@ } ], "traits": { - "smithy.api#documentation": "

Verifies a digital signature that was generated by the Sign operation.

\n

\n

Verification confirms that an authorized user signed the message with the specified CMK\n and signing algorithm, and the message hasn't changed since it was signed. If the signature is\n verified, the value of the SignatureValid field in the response is\n True. If the signature verification fails, the Verify operation\n fails with an KMSInvalidSignatureException exception.

\n

A digital signature is generated by using the private key in an asymmetric CMK. The\n signature is verified by using the public key in the same asymmetric CMK.\n For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

To verify a digital signature, you can use the Verify operation. Specify the\n same asymmetric CMK, message, and signing algorithm that were used to produce the\n signature.

\n

You can also verify the digital signature by using the public key of the CMK outside of\n AWS KMS. Use the GetPublicKey operation to download the public key in the\n asymmetric CMK and then use the public key to verify the signature outside of AWS KMS. The\n advantage of using the Verify operation is that it is performed within AWS KMS. As\n a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged\n in AWS CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use\n the CMK to verify signatures.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see How Key State Affects Use\nof a Customer Master Key in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:Verify (key policy)

\n

\n Related operations: Sign\n

" + "smithy.api#documentation": "

Verifies a digital signature that was generated by the Sign operation.

\n

\n

Verification confirms that an authorized user signed the message with the specified CMK\n and signing algorithm, and the message hasn't changed since it was signed. If the signature is\n verified, the value of the SignatureValid field in the response is\n True. If the signature verification fails, the Verify operation\n fails with an KMSInvalidSignatureException exception.

\n

A digital signature is generated by using the private key in an asymmetric CMK. The\n signature is verified by using the public key in the same asymmetric CMK.\n For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

To verify a digital signature, you can use the Verify operation. Specify the\n same asymmetric CMK, message, and signing algorithm that were used to produce the\n signature.

\n

You can also verify the digital signature by using the public key of the CMK outside of\n AWS KMS. Use the GetPublicKey operation to download the public key in the\n asymmetric CMK and then use the public key to verify the signature outside of AWS KMS. The\n advantage of using the Verify operation is that it is performed within AWS KMS. As\n a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged\n in AWS CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use\n the CMK to verify signatures.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:Verify (key policy)

\n

\n Related operations: Sign\n

" } }, "com.amazonaws.kms#VerifyRequest": { @@ -4837,7 +5141,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the asymmetric CMK that will be used to verify the signature. This must be the\n same CMK that was used to generate the signature. If you specify a different CMK, the\n signature verification fails.

\n \n

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", + "smithy.api#documentation": "

Identifies the asymmetric CMK that will be used to verify the signature. This must be the\n same CMK that was used to generate the signature. If you specify a different CMK, the\n signature verification fails.

\n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, @@ -4871,7 +5175,7 @@ "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

For more information, see Grant Tokens in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" } } } diff --git a/aws/sdk/aws-models/license-manager.json b/aws/sdk/aws-models/license-manager.json index 0da1dd8fb..f3c9100ce 100644 --- a/aws/sdk/aws-models/license-manager.json +++ b/aws/sdk/aws-models/license-manager.json @@ -266,6 +266,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ServiceAccessDenied", + "httpResponseCode": 401 + }, "smithy.api#documentation": "

Access to resource denied.

", "smithy.api#error": "client", "smithy.api#httpError": 401 @@ -342,6 +346,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationFailure", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

The AWS user account does not have permission to perform the action. Check the IAM\n policy associated with this account.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -422,6 +430,9 @@ { "target": "com.amazonaws.licensemanager#ConflictException" }, + { + "target": "com.amazonaws.licensemanager#InvalidParameterValueException" + }, { "target": "com.amazonaws.licensemanager#RateLimitExceededException" }, @@ -479,6 +490,9 @@ { "target": "com.amazonaws.licensemanager#EntitlementNotAllowedException" }, + { + "target": "com.amazonaws.licensemanager#InvalidParameterValueException" + }, { "target": "com.amazonaws.licensemanager#NoEntitlementsAllowedException" }, @@ -618,6 +632,9 @@ { "target": "com.amazonaws.licensemanager#AuthorizationException" }, + { + "target": "com.amazonaws.licensemanager#InvalidParameterValueException" + }, { "target": "com.amazonaws.licensemanager#NoEntitlementsAllowedException" }, @@ -768,9 +785,9 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 64 + "max": 2048 }, - "smithy.api#pattern": "[a-zA-Z0-9]*" + "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.licensemanager#ConflictException": { @@ -781,6 +798,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ConflictException", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

There was a conflict processing the request. Try your request again.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -877,7 +898,7 @@ "type": "structure", "members": { "ClientToken": { - "target": "com.amazonaws.licensemanager#String", + "target": "com.amazonaws.licensemanager#ClientToken", "traits": { "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "smithy.api#required": {} @@ -982,7 +1003,7 @@ "type": "structure", "members": { "ClientToken": { - "target": "com.amazonaws.licensemanager#String", + "target": "com.amazonaws.licensemanager#ClientToken", "traits": { "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "smithy.api#required": {} @@ -1013,6 +1034,9 @@ "smithy.api#documentation": "

Grant status.

" } }, + "StatusReason": { + "target": "com.amazonaws.licensemanager#StatusReasonMessage" + }, "SourceVersion": { "target": "com.amazonaws.licensemanager#String", "traits": { @@ -1357,7 +1381,7 @@ } }, "ClientToken": { - "target": "com.amazonaws.licensemanager#String", + "target": "com.amazonaws.licensemanager#ClientToken", "traits": { "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "smithy.api#required": {} @@ -1499,7 +1523,7 @@ } }, "ClientToken": { - "target": "com.amazonaws.licensemanager#String", + "target": "com.amazonaws.licensemanager#ClientToken", "traits": { "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "smithy.api#required": {} @@ -1603,7 +1627,7 @@ } }, "ClientToken": { - "target": "com.amazonaws.licensemanager#IdempotencyToken", + "target": "com.amazonaws.licensemanager#ClientToken", "traits": { "smithy.api#documentation": "

Idempotency token, valid for 10 minutes.

", "smithy.api#required": {} @@ -1703,6 +1727,9 @@ "smithy.api#required": {} } }, + "StatusReason": { + "target": "com.amazonaws.licensemanager#StatusReasonMessage" + }, "Version": { "target": "com.amazonaws.licensemanager#String", "traits": { @@ -2421,6 +2448,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "FailedDependency", + "httpResponseCode": 424 + }, "smithy.api#documentation": "

A dependency required to run the API is missing.

", "smithy.api#error": "client", "smithy.api#httpError": 424 @@ -2454,6 +2485,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "FilterLimitExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request uses too many filters or too many filter values.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3054,7 +3089,7 @@ } }, "StatusReason": { - "target": "com.amazonaws.licensemanager#String", + "target": "com.amazonaws.licensemanager#StatusReasonMessage", "traits": { "smithy.api#documentation": "

Grant status reason.

" } @@ -3119,6 +3154,10 @@ { "value": "DISABLED", "name": "DISABLED" + }, + { + "value": "WORKFLOW_COMPLETED", + "name": "WORKFLOW_COMPLETED" } ] } @@ -3237,16 +3276,6 @@ "smithy.api#pattern": "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-](?:2[ 0-3]|[0-1][0-9]):[0-5][0-9])+$" } }, - "com.amazonaws.licensemanager#IdempotencyToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 60 - }, - "smithy.api#pattern": "\\S+" - } - }, "com.amazonaws.licensemanager#Integer": { "type": "integer", "traits": { @@ -3261,6 +3290,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameterValueProvided", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

One or more parameter values are not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3274,6 +3307,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidResourceState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

License Manager cannot allocate a license to a resource because of its state.

\n

For example, you cannot allocate a license to an instance in the process of shutting\n down.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3884,6 +3921,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "LicenseUsageFailure", + "httpResponseCode": 412 + }, "smithy.api#documentation": "

You do not have enough licenses available to support a new resource launch.

", "smithy.api#error": "client", "smithy.api#httpError": 412 @@ -5141,6 +5182,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "RateLimitExceeded", + "httpResponseCode": 429 + }, "smithy.api#documentation": "

Too many requests have been submitted. Try again after a brief wait.

", "smithy.api#error": "client", "smithy.api#httpError": 429 @@ -5155,6 +5200,9 @@ "smithy.api#documentation": "

Received status.

" } }, + "ReceivedStatusReason": { + "target": "com.amazonaws.licensemanager#StatusReasonMessage" + }, "AllowedOperations": { "target": "com.amazonaws.licensemanager#AllowedOperationList", "traits": { @@ -5197,6 +5245,10 @@ { "value": "DISABLED", "name": "DISABLED" + }, + { + "value": "WORKFLOW_COMPLETED", + "name": "WORKFLOW_COMPLETED" } ] } @@ -5543,6 +5595,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceLimitExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Your resource limits have been exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5556,6 +5612,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidResource.NotFound", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The resource cannot be found.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5616,6 +5676,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InternalError", + "httpResponseCode": 500 + }, "smithy.api#documentation": "

The server experienced an internal error. Try again.

", "smithy.api#error": "server", "smithy.api#httpError": 500 @@ -5629,6 +5693,16 @@ } } }, + "com.amazonaws.licensemanager#StatusReasonMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 400 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, "com.amazonaws.licensemanager#String": { "type": "string" }, @@ -5785,7 +5859,7 @@ "min": 0, "max": 4096 }, - "smithy.api#pattern": "\\S+" + "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.licensemanager#TokenType": { diff --git a/aws/sdk/aws-models/location.json b/aws/sdk/aws-models/location.json index 1d7718404..3dd786826 100644 --- a/aws/sdk/aws-models/location.json +++ b/aws/sdk/aws-models/location.json @@ -5937,4 +5937,4 @@ } } } -} +} \ No newline at end of file diff --git a/aws/sdk/aws-models/lookoutmetrics.json b/aws/sdk/aws-models/lookoutmetrics.json index ddb7a3907..34a4825b8 100644 --- a/aws/sdk/aws-models/lookoutmetrics.json +++ b/aws/sdk/aws-models/lookoutmetrics.json @@ -428,6 +428,10 @@ "value": "INACTIVE", "name": "INACTIVE" }, + { + "value": "LEARNING", + "name": "LEARNING" + }, { "value": "BACK_TEST_ACTIVATING", "name": "BACK_TEST_ACTIVATING" @@ -1098,7 +1102,7 @@ "target": "com.amazonaws.lookoutmetrics#Offset", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

After an interval ends, the amount of time that the detector waits before importing data.

" + "smithy.api#documentation": "

After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3 and Redshift datasources.

" } }, "TimestampColumn": { @@ -1678,7 +1682,7 @@ "target": "com.amazonaws.lookoutmetrics#Offset", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

The offset for the dataset.

" + "smithy.api#documentation": "

The offset in seconds. Only supported for S3 and Redshift datasources.

" } }, "MetricList": { @@ -2692,7 +2696,7 @@ "NextToken": { "target": "com.amazonaws.lookoutmetrics#NextToken", "traits": { - "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a NextToken. To\n retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

" + "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\n request. Tokens expire after 24 hours.

" } } } @@ -2709,7 +2713,7 @@ "NextToken": { "target": "com.amazonaws.lookoutmetrics#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, the list call returns this token. To retrieve the next set of results, use the\n token in the next list request.

" + "smithy.api#documentation": "

If the response is truncated, the list call returns this token. To retrieve the next set\n of results, use the token in the next list request.

" } } } @@ -4054,7 +4058,7 @@ "target": "com.amazonaws.lookoutmetrics#Offset", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

After an interval ends, the amount of time that the detector waits before importing data.

" + "smithy.api#documentation": "

After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3 and Redshift datasources.

" } }, "TimestampColumn": { diff --git a/aws/sdk/aws-models/mediaconnect.json b/aws/sdk/aws-models/mediaconnect.json index 516c3ca21..c7e7e7e64 100644 --- a/aws/sdk/aws-models/mediaconnect.json +++ b/aws/sdk/aws-models/mediaconnect.json @@ -1471,6 +1471,13 @@ "com.amazonaws.mediaconnect#FailoverConfig": { "type": "structure", "members": { + "FailoverMode": { + "target": "com.amazonaws.mediaconnect#FailoverMode", + "traits": { + "smithy.api#documentation": "The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.", + "smithy.api#jsonName": "failoverMode" + } + }, "RecoveryWindow": { "target": "com.amazonaws.mediaconnect#__integer", "traits": { @@ -1478,6 +1485,13 @@ "smithy.api#jsonName": "recoveryWindow" } }, + "SourcePriority": { + "target": "com.amazonaws.mediaconnect#SourcePriority", + "traits": { + "smithy.api#documentation": "The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.", + "smithy.api#jsonName": "sourcePriority" + } + }, "State": { "target": "com.amazonaws.mediaconnect#State", "traits": { @@ -1489,6 +1503,21 @@ "smithy.api#documentation": "The settings for source failover" } }, + "com.amazonaws.mediaconnect#FailoverMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MERGE", + "name": "MERGE" + }, + { + "value": "FAILOVER", + "name": "FAILOVER" + } + ] + } + }, "com.amazonaws.mediaconnect#Flow": { "type": "structure", "members": { @@ -4002,6 +4031,21 @@ "smithy.api#documentation": "The settings for the source of the flow." } }, + "com.amazonaws.mediaconnect#SourcePriority": { + "type": "structure", + "members": { + "PrimarySource": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The name of the source you choose as the primary source for this flow.", + "smithy.api#jsonName": "primarySource" + } + } + }, + "traits": { + "smithy.api#documentation": "The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams." + } + }, "com.amazonaws.mediaconnect#SourceType": { "type": "string", "traits": { @@ -4509,6 +4553,13 @@ "com.amazonaws.mediaconnect#UpdateFailoverConfig": { "type": "structure", "members": { + "FailoverMode": { + "target": "com.amazonaws.mediaconnect#FailoverMode", + "traits": { + "smithy.api#documentation": "The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.", + "smithy.api#jsonName": "failoverMode" + } + }, "RecoveryWindow": { "target": "com.amazonaws.mediaconnect#__integer", "traits": { @@ -4516,6 +4567,13 @@ "smithy.api#jsonName": "recoveryWindow" } }, + "SourcePriority": { + "target": "com.amazonaws.mediaconnect#SourcePriority", + "traits": { + "smithy.api#documentation": "The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.", + "smithy.api#jsonName": "sourcePriority" + } + }, "State": { "target": "com.amazonaws.mediaconnect#State", "traits": { diff --git a/aws/sdk/aws-models/mediaconvert.json b/aws/sdk/aws-models/mediaconvert.json index fca985168..64d2a01ed 100644 --- a/aws/sdk/aws-models/mediaconvert.json +++ b/aws/sdk/aws-models/mediaconvert.json @@ -1223,12 +1223,19 @@ } }, "ExternalAudioFileInput": { - "target": "com.amazonaws.mediaconvert#__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE", + "target": "com.amazonaws.mediaconvert#__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSSHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSS", "traits": { "smithy.api#documentation": "Specifies audio data from an external file source.", "smithy.api#jsonName": "externalAudioFileInput" } }, + "HlsRenditionGroupSettings": { + "target": "com.amazonaws.mediaconvert#HlsRenditionGroupSettings", + "traits": { + "smithy.api#documentation": "Settings specific to audio sources in an HLS alternate rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique audio track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the properties provided, the job fails. If no properties in hlsRenditionGroupSettings are specified, the default audio track within the video segment is chosen. If there is no audio within video segment, the alternative audio with DEFAULT=YES is chosen instead.", + "smithy.api#jsonName": "hlsRenditionGroupSettings" + } + }, "LanguageCode": { "target": "com.amazonaws.mediaconvert#LanguageCode", "traits": { @@ -1314,6 +1321,10 @@ { "value": "LANGUAGE_CODE", "name": "LANGUAGE_CODE" + }, + { + "value": "HLS_RENDITION_GROUP", + "name": "HLS_RENDITION_GROUP" } ] } @@ -2513,6 +2524,13 @@ "smithy.api#documentation": "Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.", "smithy.api#jsonName": "trackSourceSettings" } + }, + "WebvttHlsSourceSettings": { + "target": "com.amazonaws.mediaconvert#WebvttHlsSourceSettings", + "traits": { + "smithy.api#documentation": "Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings.", + "smithy.api#jsonName": "webvttHlsSourceSettings" + } } }, "traits": { @@ -2777,6 +2795,13 @@ "smithy.api#jsonName": "fragmentLength" } }, + "ImageBasedTrickPlay": { + "target": "com.amazonaws.mediaconvert#CmafImageBasedTrickPlay", + "traits": { + "smithy.api#documentation": "Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails and full-resolution images of single frames. When you enable Write HLS manifest (WriteHlsManifest), MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. When you enable Write DASH manifest (WriteDashManifest), MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md", + "smithy.api#jsonName": "imageBasedTrickPlay" + } + }, "ManifestCompression": { "target": "com.amazonaws.mediaconvert#CmafManifestCompression", "traits": { @@ -2866,6 +2891,26 @@ "smithy.api#documentation": "Settings related to your CMAF output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work directly in your JSON job specification, include this object and any required children when you set Type, under OutputGroupSettings, to CMAF_GROUP_SETTINGS." } }, + "com.amazonaws.mediaconvert#CmafImageBasedTrickPlay": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails and full-resolution images of single frames. When you enable Write HLS manifest (WriteHlsManifest), MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. When you enable Write DASH manifest (WriteDashManifest), MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md", + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "THUMBNAIL", + "name": "THUMBNAIL" + }, + { + "value": "THUMBNAIL_AND_FULLFRAME", + "name": "THUMBNAIL_AND_FULLFRAME" + } + ] + } + }, "com.amazonaws.mediaconvert#CmafInitializationVectorInManifest": { "type": "string", "traits": { @@ -3244,6 +3289,13 @@ "smithy.api#jsonName": "hue" } }, + "SampleRangeConversion": { + "target": "com.amazonaws.mediaconvert#SampleRangeConversion", + "traits": { + "smithy.api#documentation": "Specify the video color sample range for this output. To create a full range output, you must start with a full range YUV input and keep the default value, None (NONE). To create a limited range output from a full range input, choose Limited range (LIMITED_RANGE_SQUEEZE). With RGB inputs, your output is always limited range, regardless of your choice here. When you create a limited range output from a full range input, MediaConvert limits the active pixel values in a way that depends on the output's bit depth: 8-bit outputs contain only values from 16 through 235 and 10-bit outputs contain only values from 64 through 940. With this conversion, MediaConvert also changes the output metadata to note the limited range.", + "smithy.api#jsonName": "sampleRangeConversion" + } + }, "Saturation": { "target": "com.amazonaws.mediaconvert#__integerMin1Max100", "traits": { @@ -4076,6 +4128,13 @@ "smithy.api#jsonName": "hbbtvCompliance" } }, + "ImageBasedTrickPlay": { + "target": "com.amazonaws.mediaconvert#DashIsoImageBasedTrickPlay", + "traits": { + "smithy.api#documentation": "Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails and full-resolution images of single frames. MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md", + "smithy.api#jsonName": "imageBasedTrickPlay" + } + }, "MinBufferTime": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { @@ -4146,6 +4205,26 @@ ] } }, + "com.amazonaws.mediaconvert#DashIsoImageBasedTrickPlay": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails and full-resolution images of single frames. MediaConvert adds an entry in the .mpd manifest for each set of images that you generate. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md", + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "THUMBNAIL", + "name": "THUMBNAIL" + }, + { + "value": "THUMBNAIL_AND_FULLFRAME", + "name": "THUMBNAIL_AND_FULLFRAME" + } + ] + } + }, "com.amazonaws.mediaconvert#DashIsoMpdProfile": { "type": "string", "traits": { @@ -5223,8 +5302,20 @@ "com.amazonaws.mediaconvert#Eac3AtmosCodingMode": { "type": "string", "traits": { - "smithy.api#documentation": "The coding mode for Dolby Digital Plus JOC (Atmos) is always 9.1.6 (CODING_MODE_9_1_6).", + "smithy.api#documentation": "The coding mode for Dolby Digital Plus JOC (Atmos).", "smithy.api#enum": [ + { + "value": "CODING_MODE_AUTO", + "name": "CODING_MODE_AUTO" + }, + { + "value": "CODING_MODE_5_1_4", + "name": "CODING_MODE_5_1_4" + }, + { + "value": "CODING_MODE_7_1_4", + "name": "CODING_MODE_7_1_4" + }, { "value": "CODING_MODE_9_1_6", "name": "CODING_MODE_9_1_6" @@ -5248,10 +5339,26 @@ ] } }, + "com.amazonaws.mediaconvert#Eac3AtmosDownmixControl": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify whether MediaConvert should use any downmix metadata from your input file. Keep the default value, Custom (SPECIFIED) to provide downmix values in your job settings. Choose Follow source (INITIALIZE_FROM_SOURCE) to use the metadata from your input. Related settings--Use these settings to specify your downmix values: Left only/Right only surround (LoRoSurroundMixLevel), Left total/Right total surround (LtRtSurroundMixLevel), Left total/Right total center (LtRtCenterMixLevel), Left only/Right only center (LoRoCenterMixLevel), and Stereo downmix (StereoDownmix). When you keep Custom (SPECIFIED) for Downmix control (DownmixControl) and you don't specify values for the related settings, MediaConvert uses default values for those settings.", + "smithy.api#enum": [ + { + "value": "SPECIFIED", + "name": "SPECIFIED" + }, + { + "value": "INITIALIZE_FROM_SOURCE", + "name": "INITIALIZE_FROM_SOURCE" + } + ] + } + }, "com.amazonaws.mediaconvert#Eac3AtmosDynamicRangeCompressionLine": { "type": "string", "traits": { - "smithy.api#documentation": "Specify the absolute peak level for a signal with dynamic range compression.", + "smithy.api#documentation": "Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby stream for the line operating mode. Default value: Film light (ATMOS_STORAGE_DDP_COMPR_FILM_LIGHT) Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom (SPECIFIED) for the setting Dynamic range control (DynamicRangeControl). Otherwise, MediaConvert ignores Dynamic range compression line (DynamicRangeCompressionLine). For information about the Dolby DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf.", "smithy.api#enum": [ { "value": "NONE", @@ -5283,7 +5390,7 @@ "com.amazonaws.mediaconvert#Eac3AtmosDynamicRangeCompressionRf": { "type": "string", "traits": { - "smithy.api#documentation": "Specify how the service limits the audio dynamic range when compressing the audio.", + "smithy.api#documentation": "Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby stream for the RF operating mode. Default value: Film light (ATMOS_STORAGE_DDP_COMPR_FILM_LIGHT) Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom (SPECIFIED) for the setting Dynamic range control (DynamicRangeControl). Otherwise, MediaConvert ignores Dynamic range compression RF (DynamicRangeCompressionRf). For information about the Dolby DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf.", "smithy.api#enum": [ { "value": "NONE", @@ -5312,6 +5419,22 @@ ] } }, + "com.amazonaws.mediaconvert#Eac3AtmosDynamicRangeControl": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify whether MediaConvert should use any dynamic range control metadata from your input file. Keep the default value, Custom (SPECIFIED), to provide dynamic range control values in your job settings. Choose Follow source (INITIALIZE_FROM_SOURCE) to use the metadata from your input. Related settings--Use these settings to specify your dynamic range control values: Dynamic range compression line (DynamicRangeCompressionLine) and Dynamic range compression RF (DynamicRangeCompressionRf). When you keep the value Custom (SPECIFIED) for Dynamic range control (DynamicRangeControl) and you don't specify values for the related settings, MediaConvert uses default values for those settings.", + "smithy.api#enum": [ + { + "value": "SPECIFIED", + "name": "SPECIFIED" + }, + { + "value": "INITIALIZE_FROM_SOURCE", + "name": "INITIALIZE_FROM_SOURCE" + } + ] + } + }, "com.amazonaws.mediaconvert#Eac3AtmosMeteringMode": { "type": "string", "traits": { @@ -5344,9 +5467,9 @@ "type": "structure", "members": { "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin384000Max768000", + "target": "com.amazonaws.mediaconvert#__integerMin384000Max1024000", "traits": { - "smithy.api#documentation": "Specify the average bitrate in bits per second.\nValid values: 384k, 448k, 640k, 768k", + "smithy.api#documentation": "Specify the average bitrate for this output in bits per second. Valid values: 384k, 448k, 576k, 640k, 768k, 1024k Default value: 448k Note that MediaConvert supports 384k only with channel-based immersive (CBI) 7.1.4 and 5.1.4 inputs. For CBI 9.1.6 and other input types, MediaConvert automatically increases your output bitrate to 448k.", "smithy.api#jsonName": "bitrate" } }, @@ -5360,7 +5483,7 @@ "CodingMode": { "target": "com.amazonaws.mediaconvert#Eac3AtmosCodingMode", "traits": { - "smithy.api#documentation": "The coding mode for Dolby Digital Plus JOC (Atmos) is always 9.1.6 (CODING_MODE_9_1_6).", + "smithy.api#documentation": "The coding mode for Dolby Digital Plus JOC (Atmos).", "smithy.api#jsonName": "codingMode" } }, @@ -5371,45 +5494,59 @@ "smithy.api#jsonName": "dialogueIntelligence" } }, + "DownmixControl": { + "target": "com.amazonaws.mediaconvert#Eac3AtmosDownmixControl", + "traits": { + "smithy.api#documentation": "Specify whether MediaConvert should use any downmix metadata from your input file. Keep the default value, Custom (SPECIFIED) to provide downmix values in your job settings. Choose Follow source (INITIALIZE_FROM_SOURCE) to use the metadata from your input. Related settings--Use these settings to specify your downmix values: Left only/Right only surround (LoRoSurroundMixLevel), Left total/Right total surround (LtRtSurroundMixLevel), Left total/Right total center (LtRtCenterMixLevel), Left only/Right only center (LoRoCenterMixLevel), and Stereo downmix (StereoDownmix). When you keep Custom (SPECIFIED) for Downmix control (DownmixControl) and you don't specify values for the related settings, MediaConvert uses default values for those settings.", + "smithy.api#jsonName": "downmixControl" + } + }, "DynamicRangeCompressionLine": { "target": "com.amazonaws.mediaconvert#Eac3AtmosDynamicRangeCompressionLine", "traits": { - "smithy.api#documentation": "Specify the absolute peak level for a signal with dynamic range compression.", + "smithy.api#documentation": "Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby stream for the line operating mode. Default value: Film light (ATMOS_STORAGE_DDP_COMPR_FILM_LIGHT) Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom (SPECIFIED) for the setting Dynamic range control (DynamicRangeControl). Otherwise, MediaConvert ignores Dynamic range compression line (DynamicRangeCompressionLine). For information about the Dolby DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf.", "smithy.api#jsonName": "dynamicRangeCompressionLine" } }, "DynamicRangeCompressionRf": { "target": "com.amazonaws.mediaconvert#Eac3AtmosDynamicRangeCompressionRf", "traits": { - "smithy.api#documentation": "Specify how the service limits the audio dynamic range when compressing the audio.", + "smithy.api#documentation": "Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby stream for the RF operating mode. Default value: Film light (ATMOS_STORAGE_DDP_COMPR_FILM_LIGHT) Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom (SPECIFIED) for the setting Dynamic range control (DynamicRangeControl). Otherwise, MediaConvert ignores Dynamic range compression RF (DynamicRangeCompressionRf). For information about the Dolby DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf.", "smithy.api#jsonName": "dynamicRangeCompressionRf" } }, + "DynamicRangeControl": { + "target": "com.amazonaws.mediaconvert#Eac3AtmosDynamicRangeControl", + "traits": { + "smithy.api#documentation": "Specify whether MediaConvert should use any dynamic range control metadata from your input file. Keep the default value, Custom (SPECIFIED), to provide dynamic range control values in your job settings. Choose Follow source (INITIALIZE_FROM_SOURCE) to use the metadata from your input. Related settings--Use these settings to specify your dynamic range control values: Dynamic range compression line (DynamicRangeCompressionLine) and Dynamic range compression RF (DynamicRangeCompressionRf). When you keep the value Custom (SPECIFIED) for Dynamic range control (DynamicRangeControl) and you don't specify values for the related settings, MediaConvert uses default values for those settings.", + "smithy.api#jsonName": "dynamicRangeControl" + } + }, "LoRoCenterMixLevel": { "target": "com.amazonaws.mediaconvert#__doubleMinNegative6Max3", "traits": { - "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left only/Right only center mix\n(Lo/Ro center). MediaConvert uses this value for downmixing. How the service uses this\nvalue depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix).\nValid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0.", + "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left only/Right only center mix (Lo/Ro center). MediaConvert uses this value for downmixing. Default value: -3 dB (ATMOS_STORAGE_DDP_MIXLEV_MINUS_3_DB). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0. Related setting: How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Related setting: To have MediaConvert use this value, keep the default value, Custom (SPECIFIED) for the setting Downmix control (DownmixControl). Otherwise, MediaConvert ignores Left only/Right only center (LoRoCenterMixLevel).", "smithy.api#jsonName": "loRoCenterMixLevel" } }, "LoRoSurroundMixLevel": { "target": "com.amazonaws.mediaconvert#__doubleMinNegative60MaxNegative1", "traits": { - "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left only/Right only (Lo/Ro surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel.", + "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left only/Right only (Lo/Ro surround). MediaConvert uses this value for downmixing. Default value: -3 dB (ATMOS_STORAGE_DDP_MIXLEV_MINUS_3_DB). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. Related setting: How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Related setting: To have MediaConvert use this value, keep the default value, Custom (SPECIFIED) for the setting Downmix control (DownmixControl). Otherwise, MediaConvert ignores Left only/Right only surround (LoRoSurroundMixLevel).", "smithy.api#jsonName": "loRoSurroundMixLevel" } }, "LtRtCenterMixLevel": { "target": "com.amazonaws.mediaconvert#__doubleMinNegative6Max3", "traits": { - "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left total/Right total center mix (Lt/Rt center). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0.", + "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left total/Right total center mix (Lt/Rt center). MediaConvert uses this value for downmixing. Default value: -3 dB (ATMOS_STORAGE_DDP_MIXLEV_MINUS_3_DB) Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0. Related setting: How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Related setting: To have MediaConvert use this value, keep the default value, Custom (SPECIFIED) for the setting Downmix control (DownmixControl). Otherwise, MediaConvert ignores Left total/Right total center (LtRtCenterMixLevel).", "smithy.api#jsonName": "ltRtCenterMixLevel" } }, "LtRtSurroundMixLevel": { "target": "com.amazonaws.mediaconvert#__doubleMinNegative60MaxNegative1", "traits": { - "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left total/Right total surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel.", + "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left total/Right total surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. Default value: -3 dB (ATMOS_STORAGE_DDP_MIXLEV_MINUS_3_DB) Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. Related setting: How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Related setting: To have MediaConvert use this value, keep the default value, Custom (SPECIFIED) for the setting Downmix control (DownmixControl). Otherwise, the service ignores Left total/Right total surround (LtRtSurroundMixLevel).", "smithy.api#jsonName": "ltRtSurroundMixLevel" } }, @@ -5428,16 +5565,16 @@ } }, "SpeechThreshold": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max100", + "target": "com.amazonaws.mediaconvert#__integerMin0Max100", "traits": { - "smithy.api#documentation": "Specify the percentage of audio content that must be speech before the encoder uses the measured speech loudness as the overall program loudness.", + "smithy.api#documentation": "Specify the percentage of audio content, from 0% to 100%, that must be speech in order for the encoder to use the measured speech loudness as the overall program loudness. Default value: 15%", "smithy.api#jsonName": "speechThreshold" } }, "StereoDownmix": { "target": "com.amazonaws.mediaconvert#Eac3AtmosStereoDownmix", "traits": { - "smithy.api#documentation": "Choose how the service does stereo downmixing.", + "smithy.api#documentation": "Choose how the service does stereo downmixing. Default value: Not indicated (ATMOS_STORAGE_DDP_DMIXMOD_NOT_INDICATED) Related setting: To have MediaConvert use this value, keep the default value, Custom (SPECIFIED) for the setting Downmix control (DownmixControl). Otherwise, MediaConvert ignores Stereo downmix (StereoDownmix).", "smithy.api#jsonName": "stereoDownmix" } }, @@ -5456,7 +5593,7 @@ "com.amazonaws.mediaconvert#Eac3AtmosStereoDownmix": { "type": "string", "traits": { - "smithy.api#documentation": "Choose how the service does stereo downmixing.", + "smithy.api#documentation": "Choose how the service does stereo downmixing. Default value: Not indicated (ATMOS_STORAGE_DDP_DMIXMOD_NOT_INDICATED) Related setting: To have MediaConvert use this value, keep the default value, Custom (SPECIFIED) for the setting Downmix control (DownmixControl). Otherwise, MediaConvert ignores Stereo downmix (StereoDownmix).", "smithy.api#enum": [ { "value": "NOT_INDICATED", @@ -6191,9 +6328,9 @@ } }, "SourceFile": { - "target": "com.amazonaws.mediaconvert#__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIVttVTTHttpsSccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIVttVTT", + "target": "com.amazonaws.mediaconvert#__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIVttVTTWebvttWEBVTTHttpsSccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIVttVTTWebvttWEBVTT", "traits": { - "smithy.api#documentation": "External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl', 'srt', 'xml', 'smi', and 'vtt'.", + "smithy.api#documentation": "External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl', 'srt', 'xml', 'smi', 'webvtt', and 'vtt'.", "smithy.api#jsonName": "sourceFile" } }, @@ -8291,6 +8428,28 @@ "smithy.api#documentation": "Use these settings to specify static color calibration metadata, as defined by SMPTE ST 2086. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator." } }, + "com.amazonaws.mediaconvert#Hdr10Plus": { + "type": "structure", + "members": { + "MasteringMonitorNits": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max4000", + "traits": { + "smithy.api#documentation": "Specify the HDR10+ mastering display normalized peak luminance, in nits. This is the normalized actual peak luminance of the mastering display, as defined by ST 2094-40.", + "smithy.api#jsonName": "masteringMonitorNits" + } + }, + "TargetMonitorNits": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max4000", + "traits": { + "smithy.api#documentation": "Specify the HDR10+ target display nominal peak luminance, in nits. This is the nominal maximum luminance of the target display as defined by ST 2094-40.", + "smithy.api#jsonName": "targetMonitorNits" + } + } + }, + "traits": { + "smithy.api#documentation": "Setting for HDR10+ metadata insertion" + } + }, "com.amazonaws.mediaconvert#HlsAdMarkers": { "type": "string", "traits": { @@ -8664,6 +8823,13 @@ "smithy.api#jsonName": "encryption" } }, + "ImageBasedTrickPlay": { + "target": "com.amazonaws.mediaconvert#HlsImageBasedTrickPlay", + "traits": { + "smithy.api#documentation": "Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md", + "smithy.api#jsonName": "imageBasedTrickPlay" + } + }, "ManifestCompression": { "target": "com.amazonaws.mediaconvert#HlsManifestCompression", "traits": { @@ -8783,6 +8949,26 @@ ] } }, + "com.amazonaws.mediaconvert#HlsImageBasedTrickPlay": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify whether MediaConvert generates images for trick play. Keep the default value, None (NONE), to not generate any images. Choose Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails and full-resolution images of single frames. MediaConvert creates a child manifest for each set of images that you generate and adds corresponding entries to the parent manifest. A common application for these images is Roku trick mode. The thumbnails and full-frame images that MediaConvert creates with this feature are compatible with this Roku specification: https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md", + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "THUMBNAIL", + "name": "THUMBNAIL" + }, + { + "value": "THUMBNAIL_AND_FULLFRAME", + "name": "THUMBNAIL_AND_FULLFRAME" + } + ] + } + }, "com.amazonaws.mediaconvert#HlsInitializationVectorInManifest": { "type": "string", "traits": { @@ -8895,6 +9081,35 @@ ] } }, + "com.amazonaws.mediaconvert#HlsRenditionGroupSettings": { + "type": "structure", + "members": { + "RenditionGroupId": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Optional. Specify alternative group ID", + "smithy.api#jsonName": "renditionGroupId" + } + }, + "RenditionLanguageCode": { + "target": "com.amazonaws.mediaconvert#LanguageCode", + "traits": { + "smithy.api#documentation": "Optional. Specify ISO 639-2 or ISO 639-3 code in the language property", + "smithy.api#jsonName": "renditionLanguageCode" + } + }, + "RenditionName": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Optional. Specify media name", + "smithy.api#jsonName": "renditionName" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings specific to audio sources in an HLS alternate rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique audio track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the properties provided, the job fails. If no properties in hlsRenditionGroupSettings are specified, the default audio track within the video segment is chosen. If there is no audio within video segment, the alternative audio with DEFAULT=YES is chosen instead." + } + }, "com.amazonaws.mediaconvert#HlsSegmentControl": { "type": "string", "traits": { @@ -9154,7 +9369,7 @@ } }, "FileInput": { - "target": "com.amazonaws.mediaconvert#__stringPatternS3MM2PPMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLOOGGGGaAHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLOOGGGGaA", + "target": "com.amazonaws.mediaconvert#__stringPatternS3MM2PPMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLOOGGGGaAAATTMMOOSSHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLOOGGGGaAAATTMMOOSS", "traits": { "smithy.api#documentation": "Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service concatenates these inputs, in the order that you specify them in the job, to create the outputs. If your input format is IMF, specify your input by providing the path to your CPL. For example, \"s3://bucket/vf/cpl.xml\". If the CPL is in an incomplete IMP, make sure to use *Supplemental IMPs* (SupplementalImps) to specify any supplemental IMPs that contain assets referenced by the CPL.", "smithy.api#jsonName": "fileInput" @@ -13671,6 +13886,10 @@ { "value": "OP1A", "name": "OP1A" + }, + { + "value": "XAVC", + "name": "XAVC" } ] } @@ -13691,12 +13910,57 @@ "smithy.api#documentation": "Specify the MXF profile, also called shim, for this output. When you choose Auto, MediaConvert chooses a profile based on the video codec and resolution. For a list of codecs supported with each MXF profile, see https://docs.aws.amazon.com/mediaconvert/latest/ug/codecs-supported-with-each-mxf-profile.html. For more information about the automatic selection behavior, see https://docs.aws.amazon.com/mediaconvert/latest/ug/default-automatic-selection-of-mxf-profiles.html.", "smithy.api#jsonName": "profile" } + }, + "XavcProfileSettings": { + "target": "com.amazonaws.mediaconvert#MxfXavcProfileSettings", + "traits": { + "smithy.api#documentation": "Specify the XAVC profile settings for MXF outputs when you set your MXF profile to XAVC.", + "smithy.api#jsonName": "xavcProfileSettings" + } } }, "traits": { "smithy.api#documentation": "These settings relate to your MXF output container." } }, + "com.amazonaws.mediaconvert#MxfXavcDurationMode": { + "type": "string", + "traits": { + "smithy.api#documentation": "To create an output that complies with the XAVC file format guidelines for interoperability, keep the default value, Drop frames for compliance (DROP_FRAMES_FOR_COMPLIANCE). To include all frames from your input in this output, keep the default setting, Allow any duration (ALLOW_ANY_DURATION). The number of frames that MediaConvert excludes when you set this to Drop frames for compliance depends on the output frame rate and duration.", + "smithy.api#enum": [ + { + "value": "ALLOW_ANY_DURATION", + "name": "ALLOW_ANY_DURATION" + }, + { + "value": "DROP_FRAMES_FOR_COMPLIANCE", + "name": "DROP_FRAMES_FOR_COMPLIANCE" + } + ] + } + }, + "com.amazonaws.mediaconvert#MxfXavcProfileSettings": { + "type": "structure", + "members": { + "DurationMode": { + "target": "com.amazonaws.mediaconvert#MxfXavcDurationMode", + "traits": { + "smithy.api#documentation": "To create an output that complies with the XAVC file format guidelines for interoperability, keep the default value, Drop frames for compliance (DROP_FRAMES_FOR_COMPLIANCE). To include all frames from your input in this output, keep the default setting, Allow any duration (ALLOW_ANY_DURATION). The number of frames that MediaConvert excludes when you set this to Drop frames for compliance depends on the output frame rate and duration.", + "smithy.api#jsonName": "durationMode" + } + }, + "MaxAncDataSize": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "traits": { + "smithy.api#documentation": "Specify a value for this setting only for outputs that you set up with one of these two XAVC profiles: XAVC HD Intra CBG (XAVC_HD_INTRA_CBG) or XAVC 4K Intra CBG (XAVC_4K_INTRA_CBG). Specify the amount of space in each frame that the service reserves for ancillary data, such as teletext captions. The default value for this setting is 1492 bytes per frame. This should be sufficient to prevent overflow unless you have multiple pages of teletext captions data. If you have a large amount of teletext data, specify a larger number.", + "smithy.api#jsonName": "maxAncDataSize" + } + } + }, + "traits": { + "smithy.api#documentation": "Specify the XAVC profile settings for MXF outputs when you set your MXF profile to XAVC." + } + }, "com.amazonaws.mediaconvert#NexGuardFileMarkerSettings": { "type": "structure", "members": { @@ -14565,6 +14829,22 @@ ] } }, + "com.amazonaws.mediaconvert#ProresChromaSampling": { + "type": "string", + "traits": { + "smithy.api#documentation": "This setting applies only to ProRes 4444 and ProRes 4444 XQ outputs that you create from inputs that use 4:4:4 chroma sampling. Set Preserve 4:4:4 sampling (PRESERVE_444_SAMPLING) to allow outputs to also use 4:4:4 chroma sampling. You must specify a value for this setting when your output codec profile supports 4:4:4 chroma sampling. Related Settings: When you set Chroma sampling to Preserve 4:4:4 sampling (PRESERVE_444_SAMPLING), you must choose an output codec profile that supports 4:4:4 chroma sampling. These values for Profile (CodecProfile) support 4:4:4 chroma sampling: Apple ProRes 4444 (APPLE_PRORES_4444) or Apple ProRes 4444 XQ (APPLE_PRORES_4444_XQ). When you set Chroma sampling to Preserve 4:4:4 sampling, you must disable all video preprocessors except for Nexguard file marker (PartnerWatermarking). When you set Chroma sampling to Preserve 4:4:4 sampling and use framerate conversion, you must set Frame rate conversion algorithm (FramerateConversionAlgorithm) to Drop duplicate (DUPLICATE_DROP).", + "smithy.api#enum": [ + { + "value": "PRESERVE_444_SAMPLING", + "name": "PRESERVE_444_SAMPLING" + }, + { + "value": "SUBSAMPLE_TO_422", + "name": "SUBSAMPLE_TO_422" + } + ] + } + }, "com.amazonaws.mediaconvert#ProresCodecProfile": { "type": "string", "traits": { @@ -14585,6 +14865,14 @@ { "value": "APPLE_PRORES_422_PROXY", "name": "APPLE_PRORES_422_PROXY" + }, + { + "value": "APPLE_PRORES_4444", + "name": "APPLE_PRORES_4444" + }, + { + "value": "APPLE_PRORES_4444_XQ", + "name": "APPLE_PRORES_4444_XQ" } ] } @@ -14688,6 +14976,13 @@ "com.amazonaws.mediaconvert#ProresSettings": { "type": "structure", "members": { + "ChromaSampling": { + "target": "com.amazonaws.mediaconvert#ProresChromaSampling", + "traits": { + "smithy.api#documentation": "This setting applies only to ProRes 4444 and ProRes 4444 XQ outputs that you create from inputs that use 4:4:4 chroma sampling. Set Preserve 4:4:4 sampling (PRESERVE_444_SAMPLING) to allow outputs to also use 4:4:4 chroma sampling. You must specify a value for this setting when your output codec profile supports 4:4:4 chroma sampling. Related Settings: When you set Chroma sampling to Preserve 4:4:4 sampling (PRESERVE_444_SAMPLING), you must choose an output codec profile that supports 4:4:4 chroma sampling. These values for Profile (CodecProfile) support 4:4:4 chroma sampling: Apple ProRes 4444 (APPLE_PRORES_4444) or Apple ProRes 4444 XQ (APPLE_PRORES_4444_XQ). When you set Chroma sampling to Preserve 4:4:4 sampling, you must disable all video preprocessors except for Nexguard file marker (PartnerWatermarking). When you set Chroma sampling to Preserve 4:4:4 sampling and use framerate conversion, you must set Frame rate conversion algorithm (FramerateConversionAlgorithm) to Drop duplicate (DUPLICATE_DROP).", + "smithy.api#jsonName": "chromaSampling" + } + }, "CodecProfile": { "target": "com.amazonaws.mediaconvert#ProresCodecProfile", "traits": { @@ -15276,6 +15571,22 @@ ] } }, + "com.amazonaws.mediaconvert#SampleRangeConversion": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify the video color sample range for this output. To create a full range output, you must start with a full range YUV input and keep the default value, None (NONE). To create a limited range output from a full range input, choose Limited range (LIMITED_RANGE_SQUEEZE). With RGB inputs, your output is always limited range, regardless of your choice here. When you create a limited range output from a full range input, MediaConvert limits the active pixel values in a way that depends on the output's bit depth: 8-bit outputs contain only values from 16 through 235 and 10-bit outputs contain only values from 64 through 940. With this conversion, MediaConvert also changes the output metadata to note the limited range.", + "smithy.api#enum": [ + { + "value": "LIMITED_RANGE_SQUEEZE", + "name": "LIMITED_RANGE_SQUEEZE" + }, + { + "value": "NONE", + "name": "NONE" + } + ] + } + }, "com.amazonaws.mediaconvert#ScalingBehavior": { "type": "string", "traits": { @@ -16507,6 +16818,10 @@ { "value": "VP9", "name": "VP9" + }, + { + "value": "XAVC", + "name": "XAVC" } ] } @@ -16590,10 +16905,17 @@ "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value VP9.", "smithy.api#jsonName": "vp9Settings" } + }, + "XavcSettings": { + "target": "com.amazonaws.mediaconvert#XavcSettings", + "traits": { + "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value XAVC.", + "smithy.api#jsonName": "xavcSettings" + } } }, "traits": { - "smithy.api#documentation": "Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings" + "smithy.api#documentation": "Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings" } }, "com.amazonaws.mediaconvert#VideoDescription": { @@ -16616,7 +16938,7 @@ "CodecSettings": { "target": "com.amazonaws.mediaconvert#VideoCodecSettings", "traits": { - "smithy.api#documentation": "Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings", + "smithy.api#documentation": "Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings", "smithy.api#jsonName": "codecSettings" } }, @@ -16755,6 +17077,13 @@ "smithy.api#jsonName": "dolbyVision" } }, + "Hdr10Plus": { + "target": "com.amazonaws.mediaconvert#Hdr10Plus", + "traits": { + "smithy.api#documentation": "Enable HDR10+ analyis and metadata injection. Compatible with HEVC only.", + "smithy.api#jsonName": "hdr10Plus" + } + }, "ImageInserter": { "target": "com.amazonaws.mediaconvert#ImageInserter", "traits": { @@ -17350,6 +17679,35 @@ "smithy.api#documentation": "WEBVTT Destination Settings" } }, + "com.amazonaws.mediaconvert#WebvttHlsSourceSettings": { + "type": "structure", + "members": { + "RenditionGroupId": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Optional. Specify alternative group ID", + "smithy.api#jsonName": "renditionGroupId" + } + }, + "RenditionLanguageCode": { + "target": "com.amazonaws.mediaconvert#LanguageCode", + "traits": { + "smithy.api#documentation": "Optional. Specify ISO 639-2 or ISO 639-3 code in the language property", + "smithy.api#jsonName": "renditionLanguageCode" + } + }, + "RenditionName": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Optional. Specify media name", + "smithy.api#jsonName": "renditionName" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings." + } + }, "com.amazonaws.mediaconvert#WebvttStylePassthrough": { "type": "string", "traits": { @@ -17366,26 +17724,726 @@ ] } }, - "com.amazonaws.mediaconvert#__doubleMin0": { - "type": "double" - }, - "com.amazonaws.mediaconvert#__doubleMin0Max1": { - "type": "double" - }, - "com.amazonaws.mediaconvert#__doubleMin0Max2147483647": { - "type": "double" - }, - "com.amazonaws.mediaconvert#__doubleMinNegative59Max0": { - "type": "double" - }, - "com.amazonaws.mediaconvert#__doubleMinNegative60Max3": { - "type": "double" + "com.amazonaws.mediaconvert#Xavc4kIntraCbgProfileClass": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify the XAVC Intra 4k (CBG) Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points that are valid for that class.", + "smithy.api#enum": [ + { + "value": "CLASS_100", + "name": "CLASS_100" + }, + { + "value": "CLASS_300", + "name": "CLASS_300" + }, + { + "value": "CLASS_480", + "name": "CLASS_480" + } + ] + } }, - "com.amazonaws.mediaconvert#__doubleMinNegative60Max6": { - "type": "double" + "com.amazonaws.mediaconvert#Xavc4kIntraCbgProfileSettings": { + "type": "structure", + "members": { + "XavcClass": { + "target": "com.amazonaws.mediaconvert#Xavc4kIntraCbgProfileClass", + "traits": { + "smithy.api#documentation": "Specify the XAVC Intra 4k (CBG) Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points that are valid for that class.", + "smithy.api#jsonName": "xavcClass" + } + } + }, + "traits": { + "smithy.api#documentation": "Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value XAVC_4K_INTRA_CBG." + } }, - "com.amazonaws.mediaconvert#__doubleMinNegative60MaxNegative1": { - "type": "double" + "com.amazonaws.mediaconvert#Xavc4kIntraVbrProfileClass": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify the XAVC Intra 4k (VBR) Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points that are valid for that class.", + "smithy.api#enum": [ + { + "value": "CLASS_100", + "name": "CLASS_100" + }, + { + "value": "CLASS_300", + "name": "CLASS_300" + }, + { + "value": "CLASS_480", + "name": "CLASS_480" + } + ] + } + }, + "com.amazonaws.mediaconvert#Xavc4kIntraVbrProfileSettings": { + "type": "structure", + "members": { + "XavcClass": { + "target": "com.amazonaws.mediaconvert#Xavc4kIntraVbrProfileClass", + "traits": { + "smithy.api#documentation": "Specify the XAVC Intra 4k (VBR) Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points that are valid for that class.", + "smithy.api#jsonName": "xavcClass" + } + } + }, + "traits": { + "smithy.api#documentation": "Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value XAVC_4K_INTRA_VBR." + } + }, + "com.amazonaws.mediaconvert#Xavc4kProfileBitrateClass": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify the XAVC 4k (Long GOP) Bitrate Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points that are valid for that class.", + "smithy.api#enum": [ + { + "value": "BITRATE_CLASS_100", + "name": "BITRATE_CLASS_100" + }, + { + "value": "BITRATE_CLASS_140", + "name": "BITRATE_CLASS_140" + }, + { + "value": "BITRATE_CLASS_200", + "name": "BITRATE_CLASS_200" + } + ] + } + }, + "com.amazonaws.mediaconvert#Xavc4kProfileCodecProfile": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify the codec profile for this output. Choose High, 8-bit, 4:2:0 (HIGH) or High, 10-bit, 4:2:2 (HIGH_422). These profiles are specified in ITU-T H.264.", + "smithy.api#enum": [ + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "HIGH_422", + "name": "HIGH_422" + } + ] + } + }, + "com.amazonaws.mediaconvert#Xavc4kProfileQualityTuningLevel": { + "type": "string", + "traits": { + "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.", + "smithy.api#enum": [ + { + "value": "SINGLE_PASS", + "name": "SINGLE_PASS" + }, + { + "value": "SINGLE_PASS_HQ", + "name": "SINGLE_PASS_HQ" + }, + { + "value": "MULTI_PASS_HQ", + "name": "MULTI_PASS_HQ" + } + ] + } + }, + "com.amazonaws.mediaconvert#Xavc4kProfileSettings": { + "type": "structure", + "members": { + "BitrateClass": { + "target": "com.amazonaws.mediaconvert#Xavc4kProfileBitrateClass", + "traits": { + "smithy.api#documentation": "Specify the XAVC 4k (Long GOP) Bitrate Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points that are valid for that class.", + "smithy.api#jsonName": "bitrateClass" + } + }, + "CodecProfile": { + "target": "com.amazonaws.mediaconvert#Xavc4kProfileCodecProfile", + "traits": { + "smithy.api#documentation": "Specify the codec profile for this output. Choose High, 8-bit, 4:2:0 (HIGH) or High, 10-bit, 4:2:2 (HIGH_422). These profiles are specified in ITU-T H.264.", + "smithy.api#jsonName": "codecProfile" + } + }, + "FlickerAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#XavcFlickerAdaptiveQuantization", + "traits": { + "smithy.api#documentation": "The best way to set up adaptive quantization is to keep the default value, Auto (AUTO), for the setting Adaptive quantization (XavcAdaptiveQuantization). When you do so, MediaConvert automatically applies the best types of quantization for your video content. Include this setting in your JSON job specification only when you choose to change the default value for Adaptive quantization. Enable this setting to have the encoder reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. This setting is disabled by default. Related setting: In addition to enabling this setting, you must also set Adaptive quantization (adaptiveQuantization) to a value other than Off (OFF) or Auto (AUTO). Use Adaptive quantization to adjust the degree of smoothing that Flicker adaptive quantization provides.", + "smithy.api#jsonName": "flickerAdaptiveQuantization" + } + }, + "GopBReference": { + "target": "com.amazonaws.mediaconvert#XavcGopBReference", + "traits": { + "smithy.api#documentation": "Specify whether the encoder uses B-frames as reference frames for other pictures in the same GOP. Choose Allow (ENABLED) to allow the encoder to use B-frames as reference frames. Choose Don't allow (DISABLED) to prevent the encoder from using B-frames as reference frames.", + "smithy.api#jsonName": "gopBReference" + } + }, + "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#jsonName": "gopClosedCadence" + } + }, + "HrdBufferSize": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max1152000000", + "traits": { + "smithy.api#documentation": "Specify the size of the buffer that MediaConvert uses in the HRD buffer model for this output. Specify this value in bits; for example, enter five megabits as 5000000. When you don't set this value, or you set it to zero, MediaConvert calculates the default by doubling the bitrate of this output point.", + "smithy.api#jsonName": "hrdBufferSize" + } + }, + "QualityTuningLevel": { + "target": "com.amazonaws.mediaconvert#Xavc4kProfileQualityTuningLevel", + "traits": { + "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.", + "smithy.api#jsonName": "qualityTuningLevel" + } + }, + "Slices": { + "target": "com.amazonaws.mediaconvert#__integerMin8Max12", + "traits": { + "smithy.api#documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.", + "smithy.api#jsonName": "slices" + } + } + }, + "traits": { + "smithy.api#documentation": "Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value XAVC_4K." + } + }, + "com.amazonaws.mediaconvert#XavcAdaptiveQuantization": { + "type": "string", + "traits": { + "smithy.api#documentation": "Keep the default value, Auto (AUTO), for this setting to have MediaConvert automatically apply the best types of quantization for your video content. When you want to apply your quantization settings manually, you must set Adaptive quantization (adaptiveQuantization) to a value other than Auto (AUTO). Use this setting to specify the strength of any adaptive quantization filters that you enable. If you don't want MediaConvert to do any adaptive quantization in this transcode, set Adaptive quantization to Off (OFF). Related settings: The value that you choose here applies to the following settings: Flicker adaptive quantization (flickerAdaptiveQuantization), Spatial adaptive quantization (spatialAdaptiveQuantization), and Temporal adaptive quantization (temporalAdaptiveQuantization).", + "smithy.api#enum": [ + { + "value": "OFF", + "name": "OFF" + }, + { + "value": "AUTO", + "name": "AUTO" + }, + { + "value": "LOW", + "name": "LOW" + }, + { + "value": "MEDIUM", + "name": "MEDIUM" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "HIGHER", + "name": "HIGHER" + }, + { + "value": "MAX", + "name": "MAX" + } + ] + } + }, + "com.amazonaws.mediaconvert#XavcEntropyEncoding": { + "type": "string", + "traits": { + "smithy.api#documentation": "Optional. Choose a specific entropy encoding mode only when you want to override XAVC recommendations. If you choose the value auto, MediaConvert uses the mode that the XAVC file format specifies given this output's operating point.", + "smithy.api#enum": [ + { + "value": "AUTO", + "name": "AUTO" + }, + { + "value": "CABAC", + "name": "CABAC" + }, + { + "value": "CAVLC", + "name": "CAVLC" + } + ] + } + }, + "com.amazonaws.mediaconvert#XavcFlickerAdaptiveQuantization": { + "type": "string", + "traits": { + "smithy.api#documentation": "The best way to set up adaptive quantization is to keep the default value, Auto (AUTO), for the setting Adaptive quantization (XavcAdaptiveQuantization). When you do so, MediaConvert automatically applies the best types of quantization for your video content. Include this setting in your JSON job specification only when you choose to change the default value for Adaptive quantization. Enable this setting to have the encoder reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. This setting is disabled by default. Related setting: In addition to enabling this setting, you must also set Adaptive quantization (adaptiveQuantization) to a value other than Off (OFF) or Auto (AUTO). Use Adaptive quantization to adjust the degree of smoothing that Flicker adaptive quantization provides.", + "smithy.api#enum": [ + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "ENABLED", + "name": "ENABLED" + } + ] + } + }, + "com.amazonaws.mediaconvert#XavcFramerateControl": { + "type": "string", + "traits": { + "smithy.api#documentation": "If you are using the console, use the Frame rate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list. The framerates shown in the dropdown list are decimal approximations of fractions. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate that you specify in the settings FramerateNumerator and FramerateDenominator.", + "smithy.api#enum": [ + { + "value": "INITIALIZE_FROM_SOURCE", + "name": "INITIALIZE_FROM_SOURCE" + }, + { + "value": "SPECIFIED", + "name": "SPECIFIED" + } + ] + } + }, + "com.amazonaws.mediaconvert#XavcFramerateConversionAlgorithm": { + "type": "string", + "traits": { + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", + "smithy.api#enum": [ + { + "value": "DUPLICATE_DROP", + "name": "DUPLICATE_DROP" + }, + { + "value": "INTERPOLATE", + "name": "INTERPOLATE" + }, + { + "value": "FRAMEFORMER", + "name": "FRAMEFORMER" + } + ] + } + }, + "com.amazonaws.mediaconvert#XavcGopBReference": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify whether the encoder uses B-frames as reference frames for other pictures in the same GOP. Choose Allow (ENABLED) to allow the encoder to use B-frames as reference frames. Choose Don't allow (DISABLED) to prevent the encoder from using B-frames as reference frames.", + "smithy.api#enum": [ + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "ENABLED", + "name": "ENABLED" + } + ] + } + }, + "com.amazonaws.mediaconvert#XavcHdIntraCbgProfileClass": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify the XAVC Intra HD (CBG) Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points that are valid for that class.", + "smithy.api#enum": [ + { + "value": "CLASS_50", + "name": "CLASS_50" + }, + { + "value": "CLASS_100", + "name": "CLASS_100" + }, + { + "value": "CLASS_200", + "name": "CLASS_200" + } + ] + } + }, + "com.amazonaws.mediaconvert#XavcHdIntraCbgProfileSettings": { + "type": "structure", + "members": { + "XavcClass": { + "target": "com.amazonaws.mediaconvert#XavcHdIntraCbgProfileClass", + "traits": { + "smithy.api#documentation": "Specify the XAVC Intra HD (CBG) Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points that are valid for that class.", + "smithy.api#jsonName": "xavcClass" + } + } + }, + "traits": { + "smithy.api#documentation": "Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value XAVC_HD_INTRA_CBG." + } + }, + "com.amazonaws.mediaconvert#XavcHdProfileBitrateClass": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify the XAVC HD (Long GOP) Bitrate Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points that are valid for that class.", + "smithy.api#enum": [ + { + "value": "BITRATE_CLASS_25", + "name": "BITRATE_CLASS_25" + }, + { + "value": "BITRATE_CLASS_35", + "name": "BITRATE_CLASS_35" + }, + { + "value": "BITRATE_CLASS_50", + "name": "BITRATE_CLASS_50" + } + ] + } + }, + "com.amazonaws.mediaconvert#XavcHdProfileQualityTuningLevel": { + "type": "string", + "traits": { + "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.", + "smithy.api#enum": [ + { + "value": "SINGLE_PASS", + "name": "SINGLE_PASS" + }, + { + "value": "SINGLE_PASS_HQ", + "name": "SINGLE_PASS_HQ" + }, + { + "value": "MULTI_PASS_HQ", + "name": "MULTI_PASS_HQ" + } + ] + } + }, + "com.amazonaws.mediaconvert#XavcHdProfileSettings": { + "type": "structure", + "members": { + "BitrateClass": { + "target": "com.amazonaws.mediaconvert#XavcHdProfileBitrateClass", + "traits": { + "smithy.api#documentation": "Specify the XAVC HD (Long GOP) Bitrate Class to set the bitrate of your output. Outputs of the same class have similar image quality over the operating points that are valid for that class.", + "smithy.api#jsonName": "bitrateClass" + } + }, + "FlickerAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#XavcFlickerAdaptiveQuantization", + "traits": { + "smithy.api#documentation": "The best way to set up adaptive quantization is to keep the default value, Auto (AUTO), for the setting Adaptive quantization (XavcAdaptiveQuantization). When you do so, MediaConvert automatically applies the best types of quantization for your video content. Include this setting in your JSON job specification only when you choose to change the default value for Adaptive quantization. Enable this setting to have the encoder reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. This setting is disabled by default. Related setting: In addition to enabling this setting, you must also set Adaptive quantization (adaptiveQuantization) to a value other than Off (OFF) or Auto (AUTO). Use Adaptive quantization to adjust the degree of smoothing that Flicker adaptive quantization provides.", + "smithy.api#jsonName": "flickerAdaptiveQuantization" + } + }, + "GopBReference": { + "target": "com.amazonaws.mediaconvert#XavcGopBReference", + "traits": { + "smithy.api#documentation": "Specify whether the encoder uses B-frames as reference frames for other pictures in the same GOP. Choose Allow (ENABLED) to allow the encoder to use B-frames as reference frames. Choose Don't allow (DISABLED) to prevent the encoder from using B-frames as reference frames.", + "smithy.api#jsonName": "gopBReference" + } + }, + "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#jsonName": "gopClosedCadence" + } + }, + "HrdBufferSize": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max1152000000", + "traits": { + "smithy.api#documentation": "Specify the size of the buffer that MediaConvert uses in the HRD buffer model for this output. Specify this value in bits; for example, enter five megabits as 5000000. When you don't set this value, or you set it to zero, MediaConvert calculates the default by doubling the bitrate of this output point.", + "smithy.api#jsonName": "hrdBufferSize" + } + }, + "InterlaceMode": { + "target": "com.amazonaws.mediaconvert#XavcInterlaceMode", + "traits": { + "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", + "smithy.api#jsonName": "interlaceMode" + } + }, + "QualityTuningLevel": { + "target": "com.amazonaws.mediaconvert#XavcHdProfileQualityTuningLevel", + "traits": { + "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.", + "smithy.api#jsonName": "qualityTuningLevel" + } + }, + "Slices": { + "target": "com.amazonaws.mediaconvert#__integerMin4Max12", + "traits": { + "smithy.api#documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.", + "smithy.api#jsonName": "slices" + } + }, + "Telecine": { + "target": "com.amazonaws.mediaconvert#XavcHdProfileTelecine", + "traits": { + "smithy.api#documentation": "Ignore this setting unless you set Frame rate (framerateNumerator divided by framerateDenominator) to 29.970. If your input framerate is 23.976, choose Hard (HARD). Otherwise, keep the default value None (NONE). For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-telecine-and-inverse-telecine.html.", + "smithy.api#jsonName": "telecine" + } + } + }, + "traits": { + "smithy.api#documentation": "Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value XAVC_HD." + } + }, + "com.amazonaws.mediaconvert#XavcHdProfileTelecine": { + "type": "string", + "traits": { + "smithy.api#documentation": "Ignore this setting unless you set Frame rate (framerateNumerator divided by framerateDenominator) to 29.970. If your input framerate is 23.976, choose Hard (HARD). Otherwise, keep the default value None (NONE). For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-telecine-and-inverse-telecine.html.", + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "HARD", + "name": "HARD" + } + ] + } + }, + "com.amazonaws.mediaconvert#XavcInterlaceMode": { + "type": "string", + "traits": { + "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", + "smithy.api#enum": [ + { + "value": "PROGRESSIVE", + "name": "PROGRESSIVE" + }, + { + "value": "TOP_FIELD", + "name": "TOP_FIELD" + }, + { + "value": "BOTTOM_FIELD", + "name": "BOTTOM_FIELD" + }, + { + "value": "FOLLOW_TOP_FIELD", + "name": "FOLLOW_TOP_FIELD" + }, + { + "value": "FOLLOW_BOTTOM_FIELD", + "name": "FOLLOW_BOTTOM_FIELD" + } + ] + } + }, + "com.amazonaws.mediaconvert#XavcProfile": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify the XAVC profile for this output. For more information, see the Sony documentation at https://www.xavc-info.org/. Note that MediaConvert doesn't support the interlaced video XAVC operating points for XAVC_HD_INTRA_CBG. To create an interlaced XAVC output, choose the profile XAVC_HD.", + "smithy.api#enum": [ + { + "value": "XAVC_HD_INTRA_CBG", + "name": "XAVC_HD_INTRA_CBG" + }, + { + "value": "XAVC_4K_INTRA_CBG", + "name": "XAVC_4K_INTRA_CBG" + }, + { + "value": "XAVC_4K_INTRA_VBR", + "name": "XAVC_4K_INTRA_VBR" + }, + { + "value": "XAVC_HD", + "name": "XAVC_HD" + }, + { + "value": "XAVC_4K", + "name": "XAVC_4K" + } + ] + } + }, + "com.amazonaws.mediaconvert#XavcSettings": { + "type": "structure", + "members": { + "AdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#XavcAdaptiveQuantization", + "traits": { + "smithy.api#documentation": "Keep the default value, Auto (AUTO), for this setting to have MediaConvert automatically apply the best types of quantization for your video content. When you want to apply your quantization settings manually, you must set Adaptive quantization (adaptiveQuantization) to a value other than Auto (AUTO). Use this setting to specify the strength of any adaptive quantization filters that you enable. If you don't want MediaConvert to do any adaptive quantization in this transcode, set Adaptive quantization to Off (OFF). Related settings: The value that you choose here applies to the following settings: Flicker adaptive quantization (flickerAdaptiveQuantization), Spatial adaptive quantization (spatialAdaptiveQuantization), and Temporal adaptive quantization (temporalAdaptiveQuantization).", + "smithy.api#jsonName": "adaptiveQuantization" + } + }, + "EntropyEncoding": { + "target": "com.amazonaws.mediaconvert#XavcEntropyEncoding", + "traits": { + "smithy.api#documentation": "Optional. Choose a specific entropy encoding mode only when you want to override XAVC recommendations. If you choose the value auto, MediaConvert uses the mode that the XAVC file format specifies given this output's operating point.", + "smithy.api#jsonName": "entropyEncoding" + } + }, + "FramerateControl": { + "target": "com.amazonaws.mediaconvert#XavcFramerateControl", + "traits": { + "smithy.api#documentation": "If you are using the console, use the Frame rate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list. The framerates shown in the dropdown list are decimal approximations of fractions. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate that you specify in the settings FramerateNumerator and FramerateDenominator.", + "smithy.api#jsonName": "framerateControl" + } + }, + "FramerateConversionAlgorithm": { + "target": "com.amazonaws.mediaconvert#XavcFramerateConversionAlgorithm", + "traits": { + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", + "smithy.api#jsonName": "framerateConversionAlgorithm" + } + }, + "FramerateDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max1001", + "traits": { + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Frame rate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateDenominator" + } + }, + "FramerateNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin24Max60000", + "traits": { + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateNumerator" + } + }, + "Profile": { + "target": "com.amazonaws.mediaconvert#XavcProfile", + "traits": { + "smithy.api#documentation": "Specify the XAVC profile for this output. For more information, see the Sony documentation at https://www.xavc-info.org/. Note that MediaConvert doesn't support the interlaced video XAVC operating points for XAVC_HD_INTRA_CBG. To create an interlaced XAVC output, choose the profile XAVC_HD.", + "smithy.api#jsonName": "profile" + } + }, + "SlowPal": { + "target": "com.amazonaws.mediaconvert#XavcSlowPal", + "traits": { + "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output by relabeling the video frames and resampling your audio. Note that enabling this setting will slightly reduce the duration of your video. Related settings: You must also set Frame rate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", + "smithy.api#jsonName": "slowPal" + } + }, + "Softness": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max128", + "traits": { + "smithy.api#documentation": "Ignore this setting unless your downstream workflow requires that you specify it explicitly. Otherwise, we recommend that you adjust the softness of your output by using a lower value for the setting Sharpness (sharpness) or by enabling a noise reducer filter (noiseReducerFilter). The Softness (softness) setting specifies the quantization matrices that the encoder uses. Keep the default value, 0, for flat quantization. Choose the value 1 or 16 to use the default JVT softening quantization matricies from the H.264 specification. Choose a value from 17 to 128 to use planar interpolation. Increasing values from 17 to 128 result in increasing reduction of high-frequency data. The value 128 results in the softest video.", + "smithy.api#jsonName": "softness" + } + }, + "SpatialAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#XavcSpatialAdaptiveQuantization", + "traits": { + "smithy.api#documentation": "The best way to set up adaptive quantization is to keep the default value, Auto (AUTO), for the setting Adaptive quantization (adaptiveQuantization). When you do so, MediaConvert automatically applies the best types of quantization for your video content. Include this setting in your JSON job specification only when you choose to change the default value for Adaptive quantization. For this setting, keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.", + "smithy.api#jsonName": "spatialAdaptiveQuantization" + } + }, + "TemporalAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#XavcTemporalAdaptiveQuantization", + "traits": { + "smithy.api#documentation": "The best way to set up adaptive quantization is to keep the default value, Auto (AUTO), for the setting Adaptive quantization (adaptiveQuantization). When you do so, MediaConvert automatically applies the best types of quantization for your video content. Include this setting in your JSON job specification only when you choose to change the default value for Adaptive quantization. For this setting, keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to disable this feature. Related setting: When you enable temporal adaptive quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization).", + "smithy.api#jsonName": "temporalAdaptiveQuantization" + } + }, + "Xavc4kIntraCbgProfileSettings": { + "target": "com.amazonaws.mediaconvert#Xavc4kIntraCbgProfileSettings", + "traits": { + "smithy.api#documentation": "Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value XAVC_4K_INTRA_CBG.", + "smithy.api#jsonName": "xavc4kIntraCbgProfileSettings" + } + }, + "Xavc4kIntraVbrProfileSettings": { + "target": "com.amazonaws.mediaconvert#Xavc4kIntraVbrProfileSettings", + "traits": { + "smithy.api#documentation": "Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value XAVC_4K_INTRA_VBR.", + "smithy.api#jsonName": "xavc4kIntraVbrProfileSettings" + } + }, + "Xavc4kProfileSettings": { + "target": "com.amazonaws.mediaconvert#Xavc4kProfileSettings", + "traits": { + "smithy.api#documentation": "Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value XAVC_4K.", + "smithy.api#jsonName": "xavc4kProfileSettings" + } + }, + "XavcHdIntraCbgProfileSettings": { + "target": "com.amazonaws.mediaconvert#XavcHdIntraCbgProfileSettings", + "traits": { + "smithy.api#documentation": "Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value XAVC_HD_INTRA_CBG.", + "smithy.api#jsonName": "xavcHdIntraCbgProfileSettings" + } + }, + "XavcHdProfileSettings": { + "target": "com.amazonaws.mediaconvert#XavcHdProfileSettings", + "traits": { + "smithy.api#documentation": "Required when you set (Profile) under (VideoDescription)>(CodecSettings)>(XavcSettings) to the value XAVC_HD.", + "smithy.api#jsonName": "xavcHdProfileSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value XAVC." + } + }, + "com.amazonaws.mediaconvert#XavcSlowPal": { + "type": "string", + "traits": { + "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output by relabeling the video frames and resampling your audio. Note that enabling this setting will slightly reduce the duration of your video. Related settings: You must also set Frame rate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", + "smithy.api#enum": [ + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "ENABLED", + "name": "ENABLED" + } + ] + } + }, + "com.amazonaws.mediaconvert#XavcSpatialAdaptiveQuantization": { + "type": "string", + "traits": { + "smithy.api#documentation": "The best way to set up adaptive quantization is to keep the default value, Auto (AUTO), for the setting Adaptive quantization (adaptiveQuantization). When you do so, MediaConvert automatically applies the best types of quantization for your video content. Include this setting in your JSON job specification only when you choose to change the default value for Adaptive quantization. For this setting, keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.", + "smithy.api#enum": [ + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "ENABLED", + "name": "ENABLED" + } + ] + } + }, + "com.amazonaws.mediaconvert#XavcTemporalAdaptiveQuantization": { + "type": "string", + "traits": { + "smithy.api#documentation": "The best way to set up adaptive quantization is to keep the default value, Auto (AUTO), for the setting Adaptive quantization (adaptiveQuantization). When you do so, MediaConvert automatically applies the best types of quantization for your video content. Include this setting in your JSON job specification only when you choose to change the default value for Adaptive quantization. For this setting, keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to disable this feature. Related setting: When you enable temporal adaptive quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization).", + "smithy.api#enum": [ + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "ENABLED", + "name": "ENABLED" + } + ] + } + }, + "com.amazonaws.mediaconvert#__doubleMin0": { + "type": "double" + }, + "com.amazonaws.mediaconvert#__doubleMin0Max1": { + "type": "double" + }, + "com.amazonaws.mediaconvert#__doubleMin0Max2147483647": { + "type": "double" + }, + "com.amazonaws.mediaconvert#__doubleMinNegative59Max0": { + "type": "double" + }, + "com.amazonaws.mediaconvert#__doubleMinNegative60Max3": { + "type": "double" + }, + "com.amazonaws.mediaconvert#__doubleMinNegative60Max6": { + "type": "double" + }, + "com.amazonaws.mediaconvert#__doubleMinNegative60MaxNegative1": { + "type": "double" }, "com.amazonaws.mediaconvert#__doubleMinNegative6Max3": { "type": "double" @@ -17555,6 +18613,15 @@ } } }, + "com.amazonaws.mediaconvert#__integerMin0Max4000": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 4000 + } + } + }, "com.amazonaws.mediaconvert#__integerMin0Max4194303": { "type": "integer", "traits": { @@ -17987,12 +19054,12 @@ } } }, - "com.amazonaws.mediaconvert#__integerMin384000Max768000": { + "com.amazonaws.mediaconvert#__integerMin384000Max1024000": { "type": "integer", "traits": { "smithy.api#range": { "min": 384000, - "max": 768000 + "max": 1024000 } } }, @@ -18014,6 +19081,15 @@ } } }, + "com.amazonaws.mediaconvert#__integerMin4Max12": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 4, + "max": 12 + } + } + }, "com.amazonaws.mediaconvert#__integerMin6000Max1024000": { "type": "integer", "traits": { @@ -18050,6 +19126,15 @@ } } }, + "com.amazonaws.mediaconvert#__integerMin8Max12": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 8, + "max": 12 + } + } + }, "com.amazonaws.mediaconvert#__integerMin96Max600": { "type": "integer", "traits": { @@ -18457,13 +19542,13 @@ "smithy.api#pattern": "^((s3://(.*)(\\.mov|[0-9]+\\.png))|(https?://(.*)(\\.mov|[0-9]+\\.png)(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$" } }, - "com.amazonaws.mediaconvert#__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIVttVTTHttpsSccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIVttVTT": { + "com.amazonaws.mediaconvert#__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIVttVTTWebvttWEBVTTHttpsSccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIVttVTTWebvttWEBVTT": { "type": "string", "traits": { "smithy.api#length": { "min": 14 }, - "smithy.api#pattern": "^((s3://(.*?)\\.(scc|SCC|ttml|TTML|dfxp|DFXP|stl|STL|srt|SRT|xml|XML|smi|SMI|vtt|VTT))|(https?://(.*?)\\.(scc|SCC|ttml|TTML|dfxp|DFXP|stl|STL|srt|SRT|xml|XML|smi|SMI|vtt|VTT)(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$" + "smithy.api#pattern": "^((s3://(.*?)\\.(scc|SCC|ttml|TTML|dfxp|DFXP|stl|STL|srt|SRT|xml|XML|smi|SMI|vtt|VTT|webvtt|WEBVTT))|(https?://(.*?)\\.(scc|SCC|ttml|TTML|dfxp|DFXP|stl|STL|srt|SRT|xml|XML|smi|SMI|vtt|VTT|webvtt|WEBVTT)(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$" } }, "com.amazonaws.mediaconvert#__stringMin16Max24PatternAZaZ0922AZaZ0916": { @@ -18625,7 +19710,7 @@ "com.amazonaws.mediaconvert#__stringPattern0xAFaF0908190908": { "type": "string", "traits": { - "smithy.api#pattern": "(^0x[A-Fa-f0-9]{0,8}$|^[1-9][0-9]{0,8}$)" + "smithy.api#pattern": "^(^0x[A-Fa-f0-9]{0,8}$|^[1-9][0-9]{0,8}$)$" } }, "com.amazonaws.mediaconvert#__stringPatternAZaZ0902": { @@ -18649,7 +19734,7 @@ "com.amazonaws.mediaconvert#__stringPatternArnAwsUsGovAcm": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws(-us-gov)?:acm:" + "smithy.api#pattern": "^arn:aws(-us-gov)?:acm:$" } }, "com.amazonaws.mediaconvert#__stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912": { @@ -18667,7 +19752,7 @@ "com.amazonaws.mediaconvert#__stringPatternHttps": { "type": "string", "traits": { - "smithy.api#pattern": "^https:\\/\\/" + "smithy.api#pattern": "^https:\\/\\/$" } }, "com.amazonaws.mediaconvert#__stringPatternHttpsKantarmediaCom": { @@ -18685,7 +19770,7 @@ "com.amazonaws.mediaconvert#__stringPatternS3": { "type": "string", "traits": { - "smithy.api#pattern": "^s3:\\/\\/" + "smithy.api#pattern": "^s3:\\/\\/$" } }, "com.amazonaws.mediaconvert#__stringPatternS3ASSETMAPXml": { @@ -18694,16 +19779,16 @@ "smithy.api#pattern": "^s3:\\/\\/.*\\/(ASSETMAP.xml)?$" } }, - "com.amazonaws.mediaconvert#__stringPatternS3MM2PPMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLOOGGGGaAHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLOOGGGGaA": { + "com.amazonaws.mediaconvert#__stringPatternS3MM2PPMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLOOGGGGaAAATTMMOOSSHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLOOGGGGaAAATTMMOOSS": { "type": "string", "traits": { - "smithy.api#pattern": "^((s3://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[pP]|[mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL]|[oO][gG][gGaA]))))|(https?://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL]|[oO][gG][gGaA])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$" + "smithy.api#pattern": "^((s3://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[pP]|[mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL]|[oO][gG][gGaA]|[aA][tT][mM][oO][sS]))))|(https?://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL]|[oO][gG][gGaA]|[aA][tT][mM][oO][sS])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$" } }, - "com.amazonaws.mediaconvert#__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE": { + "com.amazonaws.mediaconvert#__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSSHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSS": { "type": "string", "traits": { - "smithy.api#pattern": "^((s3://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[pP]|[wW][eE][bB][mM]|[mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE]))))|(https?://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$" + "smithy.api#pattern": "^((s3://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[pP]|[wW][eE][bB][mM]|[mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE]|[aA][tT][mM][oO][sS]))))|(https?://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE]|[aA][tT][mM][oO][sS])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$" } }, "com.amazonaws.mediaconvert#__stringPatternSNManifestConfirmConditionNotificationNS": { diff --git a/aws/sdk/aws-models/medialive.json b/aws/sdk/aws-models/medialive.json index b84bf6c9c..874ee0567 100644 --- a/aws/sdk/aws-models/medialive.json +++ b/aws/sdk/aws-models/medialive.json @@ -6615,9 +6615,48 @@ ] } }, + "com.amazonaws.medialive#DvbSubOcrLanguage": { + "type": "string", + "traits": { + "smithy.api#documentation": "Dvb Sub Ocr Language", + "smithy.api#enum": [ + { + "value": "DEU", + "name": "DEU" + }, + { + "value": "ENG", + "name": "ENG" + }, + { + "value": "FRA", + "name": "FRA" + }, + { + "value": "NLD", + "name": "NLD" + }, + { + "value": "POR", + "name": "POR" + }, + { + "value": "SPA", + "name": "SPA" + } + ] + } + }, "com.amazonaws.medialive#DvbSubSourceSettings": { "type": "structure", "members": { + "OcrLanguage": { + "target": "com.amazonaws.medialive#DvbSubOcrLanguage", + "traits": { + "smithy.api#documentation": "If you will configure a WebVTT caption description that references this caption selector, use this field to\nprovide the language to consider when translating the image-based source to text.", + "smithy.api#jsonName": "ocrLanguage" + } + }, "Pid": { "target": "com.amazonaws.medialive#__integerMin1", "traits": { @@ -9879,6 +9918,13 @@ "smithy.api#documentation": "The number of seconds between retries when an attempt to read a manifest or segment fails.", "smithy.api#jsonName": "retryInterval" } + }, + "Scte35Source": { + "target": "com.amazonaws.medialive#HlsScte35SourceType", + "traits": { + "smithy.api#documentation": "Identifies the source for the SCTE-35 messages that MediaLive will ingest. Messages can be ingested from the content segments (in the stream) or from tags in the playlist (the HLS manifest). MediaLive ignores SCTE-35 information in the source that is not selected.", + "smithy.api#jsonName": "scte35Source" + } } }, "traits": { @@ -10124,6 +10170,22 @@ "smithy.api#documentation": "Hls S3 Settings" } }, + "com.amazonaws.medialive#HlsScte35SourceType": { + "type": "string", + "traits": { + "smithy.api#documentation": "Hls Scte35 Source Type", + "smithy.api#enum": [ + { + "value": "MANIFEST", + "name": "MANIFEST" + }, + { + "value": "SEGMENTS", + "name": "SEGMENTS" + } + ] + } + }, "com.amazonaws.medialive#HlsSegmentationMode": { "type": "string", "traits": { @@ -16340,7 +16402,7 @@ "com.amazonaws.medialive#ReservationSpecialFeature": { "type": "string", "traits": { - "smithy.api#documentation": "Special features, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'", + "smithy.api#documentation": "Special features, 'ADVANCED_AUDIO' 'AUDIO_NORMALIZATION' 'MGHD' or 'MGUHD'", "smithy.api#enum": [ { "value": "ADVANCED_AUDIO", @@ -16349,6 +16411,14 @@ { "value": "AUDIO_NORMALIZATION", "name": "AUDIO_NORMALIZATION" + }, + { + "value": "MGHD", + "name": "MGHD" + }, + { + "value": "MGUHD", + "name": "MGUHD" } ] } @@ -16791,9 +16861,48 @@ "smithy.api#documentation": "Scte27 Destination Settings" } }, + "com.amazonaws.medialive#Scte27OcrLanguage": { + "type": "string", + "traits": { + "smithy.api#documentation": "Scte27 Ocr Language", + "smithy.api#enum": [ + { + "value": "DEU", + "name": "DEU" + }, + { + "value": "ENG", + "name": "ENG" + }, + { + "value": "FRA", + "name": "FRA" + }, + { + "value": "NLD", + "name": "NLD" + }, + { + "value": "POR", + "name": "POR" + }, + { + "value": "SPA", + "name": "SPA" + } + ] + } + }, "com.amazonaws.medialive#Scte27SourceSettings": { "type": "structure", "members": { + "OcrLanguage": { + "target": "com.amazonaws.medialive#Scte27OcrLanguage", + "traits": { + "smithy.api#documentation": "If you will configure a WebVTT caption description that references this caption selector, use this field to\nprovide the language to consider when translating the image-based source to text.", + "smithy.api#jsonName": "ocrLanguage" + } + }, "Pid": { "target": "com.amazonaws.medialive#__integerMin1", "traits": { diff --git a/aws/sdk/aws-models/mediapackage-vod.json b/aws/sdk/aws-models/mediapackage-vod.json index 7e708fadd..971c26780 100644 --- a/aws/sdk/aws-models/mediapackage-vod.json +++ b/aws/sdk/aws-models/mediapackage-vod.json @@ -138,6 +138,13 @@ "com.amazonaws.mediapackagevod#CmafEncryption": { "type": "structure", "members": { + "ConstantInitializationVector": { + "target": "com.amazonaws.mediapackagevod#__string", + "traits": { + "smithy.api#documentation": "An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).", + "smithy.api#jsonName": "constantInitializationVector" + } + }, "SpekeKeyProvider": { "target": "com.amazonaws.mediapackagevod#SpekeKeyProvider", "traits": { diff --git a/aws/sdk/aws-models/mediatailor.json b/aws/sdk/aws-models/mediatailor.json index b7824520c..b6b7cd693 100644 --- a/aws/sdk/aws-models/mediatailor.json +++ b/aws/sdk/aws-models/mediatailor.json @@ -37,6 +37,12 @@ "traits": { "smithy.api#documentation": "

The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.

S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.

Before you can use S3_SIGV4, you must meet these requirements:

• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.

• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.

• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.

" } + }, + "SecretsManagerAccessTokenConfiguration": { + "target": "com.amazonaws.mediatailor#SecretsManagerAccessTokenConfiguration", + "traits": { + "smithy.api#documentation": "

AWS Secrets Manager access token configuration parameters.

" + } } }, "traits": { @@ -50,6 +56,10 @@ { "value": "S3_SIGV4", "name": "S3_SIGV4" + }, + { + "value": "SECRETS_MANAGER_ACCESS_TOKEN", + "name": "SECRETS_MANAGER_ACCESS_TOKEN" } ] } @@ -2688,6 +2698,38 @@ "target": "com.amazonaws.mediatailor#ResponseOutputItem" } }, + "com.amazonaws.mediatailor#ScheduleAdBreak": { + "type": "structure", + "members": { + "ApproximateDurationSeconds": { + "target": "com.amazonaws.mediatailor#__long", + "traits": { + "smithy.api#documentation": "

The approximate duration of the ad break, in seconds.

" + } + }, + "ApproximateStartTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "

The approximate time that the ad will start playing.

" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the source location containing the VOD source used for the ad break.

" + } + }, + "VodSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the VOD source used for the ad break.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The schedule's ad break properties.

" + } + }, "com.amazonaws.mediatailor#ScheduleConfiguration": { "type": "structure", "members": { @@ -2739,6 +2781,12 @@ "smithy.api#required": {} } }, + "ScheduleAdBreaks": { + "target": "com.amazonaws.mediatailor#__listOfScheduleAdBreak", + "traits": { + "smithy.api#documentation": "

The schedule's ad break properties.

" + } + }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", "traits": { @@ -2758,6 +2806,32 @@ "smithy.api#documentation": "

The properties for a schedule.

" } }, + "com.amazonaws.mediatailor#SecretsManagerAccessTokenConfiguration": { + "type": "structure", + "members": { + "HeaderName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the HTTP header used to supply the access token in requests to the source location.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.

" + } + }, + "SecretStringKey": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

AWS Secrets Manager access token configuration parameters. For information about Secrets Manager access token authentication, see Working with AWS Secrets Manager access token authentication.

" + } + }, "com.amazonaws.mediatailor#SlateSource": { "type": "structure", "members": { @@ -3435,6 +3509,12 @@ "target": "com.amazonaws.mediatailor#PlaybackConfiguration" } }, + "com.amazonaws.mediatailor#__listOfScheduleAdBreak": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#ScheduleAdBreak" + } + }, "com.amazonaws.mediatailor#__listOfScheduleEntry": { "type": "list", "member": { diff --git a/aws/sdk/aws-models/mgn.json b/aws/sdk/aws-models/mgn.json index 10eb1f4f4..b0512d483 100644 --- a/aws/sdk/aws-models/mgn.json +++ b/aws/sdk/aws-models/mgn.json @@ -3944,4 +3944,4 @@ } } } -} +} \ No newline at end of file diff --git a/aws/sdk/aws-models/models.lex.v2.json b/aws/sdk/aws-models/models.lex.v2.json index f0261010f..6ecfc6939 100644 --- a/aws/sdk/aws-models/models.lex.v2.json +++ b/aws/sdk/aws-models/models.lex.v2.json @@ -2388,7 +2388,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a new resource policy statement to a bot or bot alias. If a\n resource policy exists, the statement is added to the current resource\n policy. If a policy doesn't exist, a new policy is created.

\n

You can create a resource policy statement that allows cross-account\n access.

", + "smithy.api#documentation": "

Adds a new resource policy statement to a bot or bot alias. If a\n resource policy exists, the statement is added to the current resource\n policy. If a policy doesn't exist, a new policy is created.

\n

You can't create a resource policy statement that allows\n cross-account access.

", "smithy.api#http": { "method": "POST", "uri": "/policy/{resourceArn}/statements", @@ -2571,6 +2571,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "multipleValuesSetting": { + "target": "com.amazonaws.lexmodelsv2#MultipleValuesSetting", + "traits": { + "smithy.api#documentation": "

Indicates whether the slot returns multiple values in one response.\n Multi-value slots are only available in the en-US locale. If you set\n this value to true in any other locale, Amazon Lex throws a\n ValidationException.

\n

If the multipleValuesSetting is not set, the default\n value is false.

" + } } } }, @@ -2642,6 +2648,12 @@ "traits": { "smithy.api#documentation": "

The timestamp of the date and time that the slot was created.

" } + }, + "multipleValuesSetting": { + "target": "com.amazonaws.lexmodelsv2#MultipleValuesSetting", + "traits": { + "smithy.api#documentation": "

Indicates whether the slot returns multiple values in one\n response.

" + } } } }, @@ -4861,6 +4873,12 @@ "traits": { "smithy.api#documentation": "

A timestamp of the date and time that the slot was last\n updated.

" } + }, + "multipleValuesSetting": { + "target": "com.amazonaws.lexmodelsv2#MultipleValuesSetting", + "traits": { + "smithy.api#documentation": "

Indicates whether the slot accepts multiple values in a\n single utterance.

\n

If the multipleValuesSetting is not set, the default\n value is false.

" + } } } }, @@ -6644,7 +6662,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the exports for a bot or bot locale. Exports are kept in the list for 7\n days.

", + "smithy.api#documentation": "

Lists the exports for a bot or bot locale. Exports are kept in the\n list for 7 days.

", "smithy.api#http": { "method": "POST", "uri": "/exports", @@ -6747,7 +6765,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the imports for a bot or bot locale. Imports are kept in the list for 7\n days.

", + "smithy.api#documentation": "

Lists the imports for a bot or bot locale. Imports are kept in the\n list for 7 days.

", "smithy.api#http": { "method": "POST", "uri": "/imports", @@ -7388,6 +7406,20 @@ } } }, + "com.amazonaws.lexmodelsv2#MultipleValuesSetting": { + "type": "structure", + "members": { + "allowMultipleValues": { + "target": "com.amazonaws.lexmodelsv2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a slot can return multiple values. When\n true, the slot may return more than one value in a\n response. When false, the slot returns only a single\n value.

\n

Multi-value slots are only available in the en-US locale. If you\n set this value to true in any other locale, Amazon Lex throws a\n ValidationException.

\n

If the allowMutlipleValues is not set, the default\n value is false.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether a slot can return multiple values.

" + } + }, "com.amazonaws.lexmodelsv2#Name": { "type": "string", "traits": { @@ -9290,7 +9322,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the password used to encrypt an export zip archive.

", + "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#http": { "method": "PUT", "uri": "/exports/{exportId}", @@ -9811,6 +9843,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "multipleValuesSetting": { + "target": "com.amazonaws.lexmodelsv2#MultipleValuesSetting", + "traits": { + "smithy.api#documentation": "

Determines whether the slot accepts multiple values in one response.\n Multiple value slots are only available in the en-US locale. If you set\n this value to true in any other locale, Amazon Lex throws a\n ValidationException.

\n

If the multipleValuesSetting is not set, the default\n value is false.

" + } } } }, @@ -9888,6 +9926,12 @@ "traits": { "smithy.api#documentation": "

The timestamp of the date and time that the slot was last\n updated.

" } + }, + "multipleValuesSetting": { + "target": "com.amazonaws.lexmodelsv2#MultipleValuesSetting", + "traits": { + "smithy.api#documentation": "

Indicates whether the slot accepts multiple values in one\n response.

" + } } } }, diff --git a/aws/sdk/aws-models/monitoring.json b/aws/sdk/aws-models/monitoring.json index 69c9d52a3..d564524a1 100644 --- a/aws/sdk/aws-models/monitoring.json +++ b/aws/sdk/aws-models/monitoring.json @@ -254,7 +254,7 @@ "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#pattern": "^(SampleCount|Average|Sum|Minimum|Maximum|p(\\d{1,2}|100)(\\.\\d{0,2})?|[ou]\\d+(\\.\\d*)?)(_E|_L|_H)?$" } }, "com.amazonaws.cloudwatch#AnomalyDetectorMetricTimezone": { @@ -436,6 +436,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ConcurrentModificationException", + "httpResponseCode": 429 + }, "smithy.api#documentation": "

More than one process tried to modify a resource at the same time.

", "smithy.api#error": "client", "smithy.api#httpError": 429 @@ -505,6 +509,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameterInput", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Some part of the dashboard data is invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -530,6 +538,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified dashboard does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -1546,7 +1558,7 @@ "com.amazonaws.cloudwatch#ExtendedStatistic": { "type": "string", "traits": { - "smithy.api#pattern": "p(\\d{1,2}(\\.\\d{0,2})?|100)" + "smithy.api#pattern": "^p(\\d{1,2}(\\.\\d{0,2})?|100)$" } }, "com.amazonaws.cloudwatch#ExtendedStatistics": { @@ -2400,7 +2412,7 @@ "min": 1, "max": 8192 }, - "smithy.api#pattern": "[\\x00-\\x7F]+" + "smithy.api#pattern": "^[\\x00-\\x7F]+$" } }, "com.amazonaws.cloudwatch#InsightRuleMaxResults": { @@ -2489,7 +2501,7 @@ "min": 1, "max": 32 }, - "smithy.api#pattern": "[\\x20-\\x7E]+" + "smithy.api#pattern": "^[\\x20-\\x7E]+$" } }, "com.amazonaws.cloudwatch#InsightRuleName": { @@ -2499,7 +2511,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[\\x20-\\x7E]+" + "smithy.api#pattern": "^[\\x20-\\x7E]+$" } }, "com.amazonaws.cloudwatch#InsightRuleNames": { @@ -2515,7 +2527,7 @@ "min": 1, "max": 32 }, - "smithy.api#pattern": "[\\x20-\\x7E]+" + "smithy.api#pattern": "^[\\x20-\\x7E]+$" } }, "com.amazonaws.cloudwatch#InsightRuleSchema": { @@ -2528,7 +2540,7 @@ "min": 1, "max": 32 }, - "smithy.api#pattern": "[\\x20-\\x7E]+" + "smithy.api#pattern": "^[\\x20-\\x7E]+$" } }, "com.amazonaws.cloudwatch#InsightRuleUnboundDouble": { @@ -2566,6 +2578,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InternalServiceError", + "httpResponseCode": 500 + }, "smithy.api#documentation": "

Request processing has failed due to some unknown error, exception, or failure.

", "smithy.api#error": "server", "smithy.api#httpError": 500 @@ -2582,6 +2598,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidFormat", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Data was not syntactically valid JSON.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2598,6 +2618,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidNextToken", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The next token specified is invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2614,6 +2638,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameterCombination", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Parameters were used together that cannot be used together.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2630,6 +2658,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameterValue", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The value of an input parameter is bad or out-of-range.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2660,6 +2692,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "LimitExceededException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The operation exceeded one or more limits.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2676,6 +2712,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "LimitExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The quota for alarms for this customer has already been reached.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3565,6 +3605,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "MissingParameter", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

An input parameter that is required is missing.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3577,7 +3621,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "[^:].*" + "smithy.api#pattern": "^[^:]" } }, "com.amazonaws.cloudwatch#NextToken": { @@ -4227,6 +4271,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The named resource does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -4246,6 +4294,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFoundException", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The named resource does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 diff --git a/aws/sdk/aws-models/mwaa.json b/aws/sdk/aws-models/mwaa.json index ad18f1105..f3e312edd 100644 --- a/aws/sdk/aws-models/mwaa.json +++ b/aws/sdk/aws-models/mwaa.json @@ -1938,4 +1938,4 @@ } } } -} +} \ No newline at end of file diff --git a/aws/sdk/aws-models/neptune.json b/aws/sdk/aws-models/neptune.json index e8c0f97bd..f9f1ca0b1 100644 --- a/aws/sdk/aws-models/neptune.json +++ b/aws/sdk/aws-models/neptune.json @@ -462,6 +462,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

\n

Neptune may not also be authorized via IAM to perform necessary actions on your behalf.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -519,6 +523,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "CertificateNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n CertificateIdentifier does not refer to an existing certificate.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -2086,6 +2094,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterAlreadyExistsFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

User already has a DB cluster with the given identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2170,6 +2182,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterEndpointAlreadyExistsFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified custom endpoint cannot be created because it already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2212,6 +2228,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterEndpointNotFoundFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified custom endpoint doesn't exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2228,6 +2248,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterEndpointQuotaExceededFault", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

The cluster already has the maximum number of custom endpoints.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -2311,6 +2335,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBClusterIdentifier does not refer to an existing DB cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -2425,6 +2453,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterParameterGroupNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBClusterParameterGroupName does not refer to an\n existing DB Cluster parameter group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -2458,6 +2490,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterQuotaExceededFault", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -2500,6 +2536,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterRoleAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2516,6 +2556,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterRoleNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified IAM role Amazon Resource Name (ARN) is not associated with the specified DB cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -2532,6 +2576,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterRoleQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2685,6 +2733,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterSnapshotAlreadyExistsFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

User already has a DB cluster snapshot with the given identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2776,6 +2828,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterSnapshotNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBClusterSnapshotIdentifier does not refer to an existing\n DB cluster snapshot.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -3225,6 +3281,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

User already has a DB instance with the given identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3267,6 +3327,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBInstanceIdentifier does not refer to an existing DB instance.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -3356,6 +3420,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBParameterGroupAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

A DB parameter group with the same name exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3409,6 +3477,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBParameterGroupNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBParameterGroupName does not refer to an\n existing DB parameter group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -3425,6 +3497,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBParameterGroupQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Request would result in user exceeding the allowed number of DB parameter groups.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3525,6 +3601,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSecurityGroupNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBSecurityGroupName does not refer\n to an existing DB security group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -3541,6 +3621,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSnapshotAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

\n DBSnapshotIdentifier is already used by an existing snapshot.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3557,6 +3641,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSnapshotNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBSnapshotIdentifier does not refer to an existing DB snapshot.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -3617,6 +3705,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

\n DBSubnetGroupName is already used by an existing DB subnet group.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3633,6 +3725,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupDoesNotCoverEnoughAZs", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Subnets in the DB subnet group should cover at least two Availability\n Zones unless there is only one Availability Zone.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3666,6 +3762,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBSubnetGroupName does not refer to an\n existing DB subnet group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -3682,6 +3782,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Request would result in user exceeding the allowed number of DB subnet groups.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3707,6 +3811,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetQuotaExceededFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3723,6 +3831,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBUpgradeDependencyFailure", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The DB upgrade failed because a resource the DB depends on could not be modified.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5296,6 +5408,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DomainNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n Domain does not refer to an existing Active Directory Domain.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -5572,6 +5688,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "EventSubscriptionQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You have exceeded the number of events you can subscribe to.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5722,6 +5842,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InstanceQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Request would result in user exceeding the allowed number of DB instances.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5738,6 +5862,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientDBClusterCapacityFault", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

The DB cluster does not have enough capacity for the current operation.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -5754,6 +5882,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientDBInstanceCapacity", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Specified DB instance class is not available in the specified Availability Zone.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5770,6 +5902,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientStorageClusterCapacity", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

There is insufficient storage available for the current action. You may\n be able to resolve this error by updating your subnet group to use different\n Availability Zones that have more storage available.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5795,6 +5931,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterEndpointStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The requested operation cannot be performed on the endpoint while the endpoint is in this state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5811,6 +5951,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterSnapshotStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The supplied value is not a valid DB cluster snapshot state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5827,6 +5971,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The DB cluster is not in a valid state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5843,6 +5991,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBInstanceState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified DB instance is not in the available state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5859,6 +6011,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBParameterGroupState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The DB parameter group is in use or is in an invalid state. If you are attempting to\n delete the parameter group, you cannot delete it when the parameter group is in this state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5875,6 +6031,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSecurityGroupState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The state of the DB security group does not allow deletion.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5891,6 +6051,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSnapshotState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The state of the DB snapshot does not allow deletion.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5907,6 +6071,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSubnetGroupStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The DB subnet group cannot be deleted because it is in use.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5923,6 +6091,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSubnetStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The DB subnet is not in the available state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5939,6 +6111,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidEventSubscriptionState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The event subscription is in an invalid state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5955,6 +6131,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidRestoreFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Cannot restore from vpc backup to non-vpc DB instance.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5971,6 +6151,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSubnet", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The requested subnet is invalid, or multiple subnets were requested that are\n not all in a common VPC.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5987,6 +6171,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidVPCNetworkStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

DB subnet group does not cover all Availability Zones after it is created\n because users' change.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -6003,6 +6191,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSKeyNotAccessibleFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Error accessing KMS key.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -6962,6 +7154,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "OptionGroupNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The designated option group could not be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -7440,6 +7636,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ProvisionedIopsNotAvailableInAZFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Provisioned IOPS not available in the specified Availability Zone.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7783,6 +7983,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified resource ID was not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -8169,6 +8373,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSInvalidTopic", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The SNS topic is invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -8185,6 +8393,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSNoAuthorization", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

There is no SNS authorization.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -8201,6 +8413,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSTopicArnNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The ARN of the SNS topic could not be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -8217,6 +8433,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SharedSnapshotQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -8233,6 +8453,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Request would result in user exceeding the allowed number of DB snapshots.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -8258,6 +8482,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SourceNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The source could not be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -8391,6 +8619,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "StorageQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Request would result in user exceeding the allowed amount of storage available across all DB instances.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -8407,6 +8639,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "StorageTypeNotSupported", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

\n StorageType specified cannot be associated with the DB Instance.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -8458,6 +8694,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetAlreadyInUse", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The DB subnet is already in use in the Availability Zone.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -8492,6 +8732,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionAlreadyExist", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

This subscription already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -8508,6 +8752,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionCategoryNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The designated subscription category could not be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -8524,6 +8772,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The designated subscription could not be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 diff --git a/aws/sdk/aws-models/proton.json b/aws/sdk/aws-models/proton.json index be9a2c3b5..3a569269d 100644 --- a/aws/sdk/aws-models/proton.json +++ b/aws/sdk/aws-models/proton.json @@ -2707,7 +2707,36 @@ ], "traits": { "smithy.api#documentation": "

Get detail data for an environment.

", - "smithy.api#readonly": {} + "smithy.api#readonly": {}, + "smithy.waiters#waitable": { + "EnvironmentDeployed": { + "documentation": "Wait until an Environment is deployed. Use this after invoking CreateEnvironment or UpdateEnvironment", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "environment.deploymentStatus", + "expected": "SUCCEEDED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "environment.deploymentStatus", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5, + "maxDelay": 4999 + } + } } }, "com.amazonaws.proton#GetEnvironmentAccountConnection": { @@ -2883,7 +2912,45 @@ ], "traits": { "smithy.api#documentation": "

View detail data for a major or minor version of an environment template.

", - "smithy.api#readonly": {} + "smithy.api#readonly": {}, + "smithy.waiters#waitable": { + "EnvironmentTemplateVersionRegistered": { + "documentation": "Wait until an EnvironmentTemplateVersion is registered. Use this after invoking CreateEnvironmentTemplateVersion", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "environmentTemplateVersion.status", + "expected": "DRAFT", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "environmentTemplateVersion.status", + "expected": "PUBLISHED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "environmentTemplateVersion.status", + "expected": "REGISTRATION_FAILED", + "comparator": "stringEquals" + } + } + } + ], + "maxDelay": 300 + } + } } }, "com.amazonaws.proton#GetEnvironmentTemplateVersionInput": { @@ -2958,7 +3025,163 @@ ], "traits": { "smithy.api#documentation": "

Get detail data for a service.

", - "smithy.api#readonly": {} + "smithy.api#readonly": {}, + "smithy.waiters#waitable": { + "ServiceCreated": { + "documentation": "Wait until an Service has deployed its instances and possibly pipeline. Use this after invoking CreateService", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "service.status", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "service.status", + "expected": "CREATE_FAILED_CLEANUP_COMPLETE", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "service.status", + "expected": "CREATE_FAILED_CLEANUP_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "service.status", + "expected": "CREATE_FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5, + "maxDelay": 4999 + }, + "ServiceUpdated": { + "documentation": "Wait until a Service, its instances, and possibly pipeline have been deployed after UpdateService is invoked", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "service.status", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "service.status", + "expected": "UPDATE_FAILED_CLEANUP_COMPLETE", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "service.status", + "expected": "UPDATE_FAILED_CLEANUP_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "service.status", + "expected": "UPDATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "service.status", + "expected": "UPDATE_COMPLETE_CLEANUP_FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5, + "maxDelay": 4999 + }, + "ServiceDeleted": { + "documentation": "Wait until a Service, its instances, and possibly pipeline have been deleted after DeleteService is invoked", + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "service.status", + "expected": "DELETE_FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5, + "maxDelay": 4999 + }, + "ServicePipelineDeployed": { + "documentation": "Wait until an ServicePipeline is deployed. Use this after invoking CreateService or UpdateServicePipeline", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "service.pipeline.deploymentStatus", + "expected": "SUCCEEDED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "service.pipeline.deploymentStatus", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 10, + "maxDelay": 3600 + } + } } }, "com.amazonaws.proton#GetServiceInput": { @@ -3007,7 +3230,36 @@ ], "traits": { "smithy.api#documentation": "

Get detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific\n environment.

", - "smithy.api#readonly": {} + "smithy.api#readonly": {}, + "smithy.waiters#waitable": { + "ServiceInstanceDeployed": { + "documentation": "Wait until a ServiceInstance is deployed. Use this after invoking CreateService or UpdateServiceInstance", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "serviceInstance.deploymentStatus", + "expected": "SUCCEEDED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "serviceInstance.deploymentStatus", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5, + "maxDelay": 4999 + } + } } }, "com.amazonaws.proton#GetServiceInstanceInput": { @@ -3147,7 +3399,45 @@ ], "traits": { "smithy.api#documentation": "

View detail data for a major or minor version of a service template.

", - "smithy.api#readonly": {} + "smithy.api#readonly": {}, + "smithy.waiters#waitable": { + "ServiceTemplateVersionRegistered": { + "documentation": "Wait until a ServiceTemplateVersion is registered. Use this after invoking CreateServiceTemplateVersion", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "serviceTemplateVersion.status", + "expected": "DRAFT", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "serviceTemplateVersion.status", + "expected": "PUBLISHED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "serviceTemplateVersion.status", + "expected": "REGISTRATION_FAILED", + "comparator": "stringEquals" + } + } + } + ], + "maxDelay": 300 + } + } } }, "com.amazonaws.proton#GetServiceTemplateVersionInput": { @@ -6192,4 +6482,4 @@ } } } -} +} \ No newline at end of file diff --git a/aws/sdk/aws-models/quicksight.json b/aws/sdk/aws-models/quicksight.json index c6968dc37..4affa5fca 100644 --- a/aws/sdk/aws-models/quicksight.json +++ b/aws/sdk/aws-models/quicksight.json @@ -1479,7 +1479,7 @@ "Permissions": { "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "

A structure that contains the permissions of the dashboard. You can use this structure\n for granting permissions by providing a list of IAM action information for each\n principal ARN.

\n \n

To specify no permissions, omit the permissions list.

" + "smithy.api#documentation": "

A structure that contains the permissions of the dashboard. You can use this structure\n for granting permissions by providing a list of IAM action information for each\n principal ARN.

\n\n

To specify no permissions, omit the permissions list.

" } }, "SourceEntity": { @@ -1877,6 +1877,236 @@ } } }, + "com.amazonaws.quicksight#CreateFolder": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateFolderRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateFolderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an empty shared folder.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateFolderMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateFolderMembershipRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateFolderMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds an asset, such as a dashboard, analysis, or dataset into a folder.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateFolderMembershipRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The AWS Account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The folder ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MemberId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the asset (the dashboard, analysis, or dataset).

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MemberType": { + "target": "com.amazonaws.quicksight#MemberType", + "traits": { + "smithy.api#documentation": "

The type of the member, including DASHBOARD, ANALYSIS, and DATASET.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.quicksight#CreateFolderMembershipResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "

The status of the folder membership. If succeeded, the status is SC_OK (200).

" + } + }, + "FolderMember": { + "target": "com.amazonaws.quicksight#FolderMember", + "traits": { + "smithy.api#documentation": "

Information about the member in the folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The request ID.

" + } + } + } + }, + "com.amazonaws.quicksight#CreateFolderRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The AWS Account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The folder ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#FolderName", + "traits": { + "smithy.api#documentation": "

The name of the folder.

" + } + }, + "FolderType": { + "target": "com.amazonaws.quicksight#FolderType", + "traits": { + "smithy.api#documentation": "

The type of folder. By default, folderType is SHARED.

" + } + }, + "ParentFolderArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the parent folder.

\n\t

\n ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions of a folder.

\n\t

To specify no permissions, omit Permissions.

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Tags for the folder.

" + } + } + } + }, + "com.amazonaws.quicksight#CreateFolderResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "

The status of the newly created folder. If succeeded, the status is SC_OK (200).

", + "smithy.api#httpResponseCode": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the newly created folder.

" + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The folder ID for the newly created folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The request ID for the newly created folder.

" + } + } + } + }, "com.amazonaws.quicksight#CreateGroup": { "type": "operation", "input": { @@ -2255,7 +2485,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates and starts a new SPICE ingestion on a dataset

\n\t\t \n\t\t

Any ingestions operating on tagged datasets inherit the same tags automatically for use in\n\t\t\taccess control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using\n\t\t\t\ttags? in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

", + "smithy.api#documentation": "

Creates and starts a new SPICE ingestion on a dataset

\n\t\t\n\t\t

Any ingestions operating on tagged datasets inherit the same tags automatically for use in\n\t\t\taccess control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using\n\t\t\t\ttags? in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}", @@ -4714,18 +4944,21 @@ } } }, - "com.amazonaws.quicksight#DeleteGroup": { + "com.amazonaws.quicksight#DeleteFolder": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#DeleteGroupRequest" + "target": "com.amazonaws.quicksight#DeleteFolderRequest" }, "output": { - "target": "com.amazonaws.quicksight#DeleteGroupResponse" + "target": "com.amazonaws.quicksight#DeleteFolderResponse" }, "errors": [ { "target": "com.amazonaws.quicksight#AccessDeniedException" }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, { "target": "com.amazonaws.quicksight#InternalFailureException" }, @@ -4739,28 +4972,28 @@ "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" + "target": "com.amazonaws.quicksight#ThrottlingException" }, { - "target": "com.amazonaws.quicksight#ThrottlingException" + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" } ], "traits": { - "smithy.api#documentation": "

Removes a user group from Amazon QuickSight.

", + "smithy.api#documentation": "

Deletes an empty folder.

", "smithy.api#http": { "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", "code": 200 } } }, - "com.amazonaws.quicksight#DeleteGroupMembership": { + "com.amazonaws.quicksight#DeleteFolderMembership": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#DeleteGroupMembershipRequest" + "target": "com.amazonaws.quicksight#DeleteFolderMembershipRequest" }, "output": { - "target": "com.amazonaws.quicksight#DeleteGroupMembershipResponse" + "target": "com.amazonaws.quicksight#DeleteFolderMembershipResponse" }, "errors": [ { @@ -4772,117 +5005,299 @@ { "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, { "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" + "target": "com.amazonaws.quicksight#ThrottlingException" }, { - "target": "com.amazonaws.quicksight#ThrottlingException" + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" } ], "traits": { - "smithy.api#documentation": "

Removes a user from a group so that the user is no longer a member of the group.

", + "smithy.api#documentation": "

Removes an asset, such as a dashboard, analysis, or dataset, from a folder.

", "smithy.api#http": { "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}", "code": 200 } } }, - "com.amazonaws.quicksight#DeleteGroupMembershipRequest": { + "com.amazonaws.quicksight#DeleteFolderMembershipRequest": { "type": "structure", "members": { - "MemberName": { - "target": "com.amazonaws.quicksight#GroupMemberName", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The name of the user that you want to delete from the group membership.

", + "smithy.api#documentation": "

The AWS Account ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The name of the group that you want to delete the user from.

", + "smithy.api#documentation": "

The Folder ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "MemberId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.

", + "smithy.api#documentation": "

The ID of the asset (the dashboard, analysis, or dataset) that you want to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "MemberType": { + "target": "com.amazonaws.quicksight#MemberType", "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#documentation": "

The type of the member, including DASHBOARD, ANALYSIS, and DATASET\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.quicksight#DeleteGroupMembershipResponse": { + "com.amazonaws.quicksight#DeleteFolderMembershipResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "

The AWS request ID for this operation.

" + "smithy.api#documentation": "

The status of deleting the asset. If succeeded, the status is SC_OK (200).

" } }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "

The request ID.

" } } } }, - "com.amazonaws.quicksight#DeleteGroupRequest": { + "com.amazonaws.quicksight#DeleteFolderRequest": { "type": "structure", "members": { - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.

", + "smithy.api#documentation": "

The AWS Account ID for the folder.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#documentation": "

The folder ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.quicksight#DeleteGroupResponse": { + "com.amazonaws.quicksight#DeleteFolderResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "

The status of deleting the folder. If succeeded, the status is SC_OK (200).

", + "smithy.api#httpResponseCode": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the deleted folder.

" + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The folder ID.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The request ID.

" + } + } + } + }, + "com.amazonaws.quicksight#DeleteGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteGroupRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a user group from Amazon QuickSight.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteGroupMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteGroupMembershipRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteGroupMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a user from a group so that the user is no longer a member of the group.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteGroupMembershipRequest": { + "type": "structure", + "members": { + "MemberName": { + "target": "com.amazonaws.quicksight#GroupMemberName", + "traits": { + "smithy.api#documentation": "

The name of the user that you want to delete from the group membership.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to delete the user from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.quicksight#DeleteGroupMembershipResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The AWS request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + } + }, + "com.amazonaws.quicksight#DeleteGroupRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.quicksight#DeleteGroupResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "

The AWS request ID for this operation.

" } @@ -6531,13 +6946,13 @@ } } }, - "com.amazonaws.quicksight#DescribeGroup": { + "com.amazonaws.quicksight#DescribeFolder": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#DescribeGroupRequest" + "target": "com.amazonaws.quicksight#DescribeFolderRequest" }, "output": { - "target": "com.amazonaws.quicksight#DescribeGroupResponse" + "target": "com.amazonaws.quicksight#DescribeFolderResponse" }, "errors": [ { @@ -6550,69 +6965,339 @@ "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" + "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" + "target": "com.amazonaws.quicksight#ThrottlingException" }, { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a folder.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeFolderPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeFolderPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeFolderPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, { "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" } ], "traits": { - "smithy.api#documentation": "

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

", + "smithy.api#documentation": "

Describes permissions for a folder.

", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/permissions", "code": 200 } } }, - "com.amazonaws.quicksight#DescribeGroupRequest": { + "com.amazonaws.quicksight#DescribeFolderPermissionsRequest": { "type": "structure", "members": { - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group that you want to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.

", + "smithy.api#documentation": "

The AWS Account ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#documentation": "

The folder ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.quicksight#DescribeGroupResponse": { + "com.amazonaws.quicksight#DescribeFolderPermissionsResponse": { "type": "structure", "members": { - "Group": { - "target": "com.amazonaws.quicksight#Group", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "

The name of the group.

" + "smithy.api#documentation": "

The status. If succeeded, the status is SC_OK.

", + "smithy.api#httpResponseCode": {} } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The AWS request ID for this operation.

" + "smithy.api#documentation": "

The folder ID.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the folder.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

Information about the permissions on the folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The request ID.

" + } + } + } + }, + "com.amazonaws.quicksight#DescribeFolderRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The folder ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.quicksight#DescribeFolderResolvedPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/resolved-permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The folder ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "

The status. If succeeded, the status is SC_OK\n

", + "smithy.api#httpResponseCode": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The folder ID.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN).

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

Information about the permissions on the dashboard.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The request ID.

" + } + } + } + }, + "com.amazonaws.quicksight#DescribeFolderResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "

The status. If succeeded, the status is SC_OK (200).

", + "smithy.api#httpResponseCode": {} + } + }, + "Folder": { + "target": "com.amazonaws.quicksight#Folder", + "traits": { + "smithy.api#documentation": "

Information about the folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The request ID.

" + } + } + } + }, + "com.amazonaws.quicksight#DescribeGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeGroupRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeGroupRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.quicksight#DescribeGroupResponse": { + "type": "structure", + "members": { + "Group": { + "target": "com.amazonaws.quicksight#Group", + "traits": { + "smithy.api#documentation": "

The name of the group.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The AWS request ID for this operation.

" } }, "Status": { @@ -7798,38 +8483,245 @@ "ConditionExpression": { "target": "com.amazonaws.quicksight#Expression", "traits": { - "smithy.api#documentation": "

An expression that must evaluate to a Boolean value. Rows for which the expression\n evaluates to true are kept in the dataset.

", - "smithy.api#required": {} + "smithy.api#documentation": "

An expression that must evaluate to a Boolean value. Rows for which the expression\n evaluates to true are kept in the dataset.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A transform operation that filters rows based on a condition.

" + } + }, + "com.amazonaws.quicksight#FilterOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "StringEquals", + "name": "StringEquals" + } + ] + } + }, + "com.amazonaws.quicksight#Folder": { + "type": "structure", + "members": { + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The folder ID.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The folder Amazon Resource Name (ARN).

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#FolderName", + "traits": { + "smithy.api#documentation": "

A display name for the folder.

" + } + }, + "FolderType": { + "target": "com.amazonaws.quicksight#FolderType", + "traits": { + "smithy.api#documentation": "

The type of the folder.

" + } + }, + "FolderPath": { + "target": "com.amazonaws.quicksight#Path", + "traits": { + "smithy.api#documentation": "

An array of ancestor folder ARN strings.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the folder was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the folder was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A folder.

" + } + }, + "com.amazonaws.quicksight#FolderColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5000 + } + } + }, + "com.amazonaws.quicksight#FolderFilterAttribute": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PARENT_FOLDER_ARN", + "name": "PARENT_FOLDER_ARN" + } + ] + } + }, + "com.amazonaws.quicksight#FolderMember": { + "type": "structure", + "members": { + "MemberId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the asset.

" + } + }, + "MemberType": { + "target": "com.amazonaws.quicksight#MemberType", + "traits": { + "smithy.api#documentation": "

The type of the asset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An asset in a folder, such as a dashboard, analysis, or dataset.

" + } + }, + "com.amazonaws.quicksight#FolderMemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MemberIdArnPair" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#FolderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#FolderSearchFilter": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.quicksight#FilterOperator", + "traits": { + "smithy.api#documentation": "

The comparison operator that you want to use as a filter. For example, \"Operator\": \"StringEquals\".

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#FolderFilterAttribute", + "traits": { + "smithy.api#documentation": "

The name of the value that you want to use as a filter. For example, \"Name\": \"PARENT_FOLDER_ARN\".

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, \"Value\": \"arn:aws:quicksight:us-east-1:1:folder/folderId\".

" } } }, "traits": { - "smithy.api#documentation": "

A transform operation that filters rows based on a condition.

" + "smithy.api#documentation": "

Searches a folder by a filter.

" } }, - "com.amazonaws.quicksight#FilterOperator": { - "type": "string", + "com.amazonaws.quicksight#FolderSearchFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FolderSearchFilter" + }, "traits": { - "smithy.api#enum": [ - { - "value": "StringEquals", - "name": "StringEquals" + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#FolderSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN).

" } - ] + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The folder ID.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#FolderName", + "traits": { + "smithy.api#documentation": "

The display name of the folder.

" + } + }, + "FolderType": { + "target": "com.amazonaws.quicksight#FolderType", + "traits": { + "smithy.api#documentation": "

The type of folder.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the folder was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the folder was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the folder.

" } }, - "com.amazonaws.quicksight#FolderColumnList": { + "com.amazonaws.quicksight#FolderSummaryList": { "type": "list", "member": { - "target": "com.amazonaws.quicksight#String" + "target": "com.amazonaws.quicksight#FolderSummary" }, "traits": { "smithy.api#length": { "min": 0, - "max": 5000 + "max": 100 } } }, + "com.amazonaws.quicksight#FolderType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SHARED", + "name": "SHARED" + } + ] + } + }, "com.amazonaws.quicksight#GeoSpatialColumnGroup": { "type": "structure", "members": { @@ -9340,7 +10232,201 @@ "DashboardSummaryList": { "target": "com.amazonaws.quicksight#DashboardSummaryList", "traits": { - "smithy.api#documentation": "

A structure that contains all of the dashboards in your AWS account. This structure\n provides basic information about the dashboards.

" + "smithy.api#documentation": "

A structure that contains all of the dashboards in your AWS account. This structure\n provides basic information about the dashboards.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The AWS request ID for this operation.

" + } + } + } + }, + "com.amazonaws.quicksight#ListDataSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListDataSetsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListDataSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the datasets belonging to the current AWS account in an AWS Region.

\n\t\t

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListDataSetsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + } + }, + "com.amazonaws.quicksight#ListDataSetsResponse": { + "type": "structure", + "members": { + "DataSetSummaries": { + "target": "com.amazonaws.quicksight#DataSetSummaryList", + "traits": { + "smithy.api#documentation": "

The list of dataset summaries.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The AWS request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + } + }, + "com.amazonaws.quicksight#ListDataSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListDataSourcesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListDataSourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists data sources in current AWS Region that belong to this AWS account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListDataSourcesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + } + }, + "com.amazonaws.quicksight#ListDataSourcesResponse": { + "type": "structure", + "members": { + "DataSources": { + "target": "com.amazonaws.quicksight#DataSourceList", + "traits": { + "smithy.api#documentation": "

A list of data sources.

" } }, "NextToken": { @@ -9349,28 +10435,28 @@ "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" } }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The AWS request ID for this operation.

" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "

The HTTP status of the request.

", "smithy.api#httpResponseCode": {} } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The AWS request ID for this operation.

" - } } } }, - "com.amazonaws.quicksight#ListDataSets": { + "com.amazonaws.quicksight#ListFolderMembers": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#ListDataSetsRequest" + "target": "com.amazonaws.quicksight#ListFolderMembersRequest" }, "output": { - "target": "com.amazonaws.quicksight#ListDataSetsResponse" + "target": "com.amazonaws.quicksight#ListFolderMembersResponse" }, "errors": [ { @@ -9385,25 +10471,26 @@ { "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, { "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" } ], "traits": { - "smithy.api#documentation": "

Lists all of the datasets belonging to the current AWS account in an AWS Region.

\n\t\t

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.

", + "smithy.api#documentation": "

List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.

", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/members", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" } } }, - "com.amazonaws.quicksight#ListDataSetsRequest": { + "com.amazonaws.quicksight#ListFolderMembersRequest": { "type": "structure", "members": { "AwsAccountId": { @@ -9414,6 +10501,14 @@ "smithy.api#required": {} } }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The folder ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -9431,13 +10526,20 @@ } } }, - "com.amazonaws.quicksight#ListDataSetsResponse": { + "com.amazonaws.quicksight#ListFolderMembersResponse": { "type": "structure", "members": { - "DataSetSummaries": { - "target": "com.amazonaws.quicksight#DataSetSummaryList", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "

The list of dataset summaries.

" + "smithy.api#documentation": "

The status. If succeeded, the status is SC_OK\n

", + "smithy.api#httpResponseCode": {} + } + }, + "FolderMemberList": { + "target": "com.amazonaws.quicksight#FolderMemberList", + "traits": { + "smithy.api#documentation": "

A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.

" } }, "NextToken": { @@ -9449,25 +10551,18 @@ "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The AWS request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "

The request ID.

" } } } }, - "com.amazonaws.quicksight#ListDataSources": { + "com.amazonaws.quicksight#ListFolders": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#ListDataSourcesRequest" + "target": "com.amazonaws.quicksight#ListFoldersRequest" }, "output": { - "target": "com.amazonaws.quicksight#ListDataSourcesResponse" + "target": "com.amazonaws.quicksight#ListFoldersResponse" }, "errors": [ { @@ -9482,25 +10577,26 @@ { "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, { "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" } ], "traits": { - "smithy.api#documentation": "

Lists data sources in current AWS Region that belong to this AWS account.

", + "smithy.api#documentation": "

Lists all folders in an account.

", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sources", + "uri": "/accounts/{AwsAccountId}/folders", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" } } }, - "com.amazonaws.quicksight#ListDataSourcesRequest": { + "com.amazonaws.quicksight#ListFoldersRequest": { "type": "structure", "members": { "AwsAccountId": { @@ -9528,13 +10624,20 @@ } } }, - "com.amazonaws.quicksight#ListDataSourcesResponse": { + "com.amazonaws.quicksight#ListFoldersResponse": { "type": "structure", "members": { - "DataSources": { - "target": "com.amazonaws.quicksight#DataSourceList", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "

A list of data sources.

" + "smithy.api#documentation": "

The status. If succeeded, the status is SC_OK\n

", + "smithy.api#httpResponseCode": {} + } + }, + "FolderSummaryList": { + "target": "com.amazonaws.quicksight#FolderSummaryList", + "traits": { + "smithy.api#documentation": "

A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders.

" } }, "NextToken": { @@ -9546,14 +10649,7 @@ "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The AWS request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "

The request ID.

" } } } @@ -11324,6 +12420,45 @@ } } }, + "com.amazonaws.quicksight#MemberIdArnPair": { + "type": "structure", + "members": { + "MemberId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the member.

" + } + }, + "MemberArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the member.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that consists of the member Amazon Resource Name (ARN) and member ID.

" + } + }, + "com.amazonaws.quicksight#MemberType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DASHBOARD", + "name": "DASHBOARD" + }, + { + "value": "ANALYSIS", + "name": "ANALYSIS" + }, + { + "value": "DATASET", + "name": "DATASET" + } + ] + } + }, "com.amazonaws.quicksight#MySqlParameters": { "type": "structure", "members": { @@ -11601,6 +12736,18 @@ } } }, + "com.amazonaws.quicksight#Path": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Arn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.quicksight#PhysicalTable": { "type": "union", "members": { @@ -11866,6 +13013,12 @@ { "target": "com.amazonaws.quicksight#CreateDataSource" }, + { + "target": "com.amazonaws.quicksight#CreateFolder" + }, + { + "target": "com.amazonaws.quicksight#CreateFolderMembership" + }, { "target": "com.amazonaws.quicksight#CreateGroup" }, @@ -11908,6 +13061,12 @@ { "target": "com.amazonaws.quicksight#DeleteDataSource" }, + { + "target": "com.amazonaws.quicksight#DeleteFolder" + }, + { + "target": "com.amazonaws.quicksight#DeleteFolderMembership" + }, { "target": "com.amazonaws.quicksight#DeleteGroup" }, @@ -11968,6 +13127,15 @@ { "target": "com.amazonaws.quicksight#DescribeDataSourcePermissions" }, + { + "target": "com.amazonaws.quicksight#DescribeFolder" + }, + { + "target": "com.amazonaws.quicksight#DescribeFolderPermissions" + }, + { + "target": "com.amazonaws.quicksight#DescribeFolderResolvedPermissions" + }, { "target": "com.amazonaws.quicksight#DescribeGroup" }, @@ -12022,6 +13190,12 @@ { "target": "com.amazonaws.quicksight#ListDataSources" }, + { + "target": "com.amazonaws.quicksight#ListFolderMembers" + }, + { + "target": "com.amazonaws.quicksight#ListFolders" + }, { "target": "com.amazonaws.quicksight#ListGroupMemberships" }, @@ -12079,6 +13253,9 @@ { "target": "com.amazonaws.quicksight#SearchDashboards" }, + { + "target": "com.amazonaws.quicksight#SearchFolders" + }, { "target": "com.amazonaws.quicksight#TagResource" }, @@ -12118,6 +13295,12 @@ { "target": "com.amazonaws.quicksight#UpdateDataSourcePermissions" }, + { + "target": "com.amazonaws.quicksight#UpdateFolder" + }, + { + "target": "com.amazonaws.quicksight#UpdateFolderPermissions" + }, { "target": "com.amazonaws.quicksight#UpdateGroup" }, @@ -12883,28 +14066,133 @@ "UploadSettings": { "target": "com.amazonaws.quicksight#UploadSettings", "traits": { - "smithy.api#documentation": "

Information about the format for the S3 source file or files.

" + "smithy.api#documentation": "

Information about the format for the S3 source file or files.

" + } + }, + "InputColumns": { + "target": "com.amazonaws.quicksight#InputColumnList", + "traits": { + "smithy.api#documentation": "

A physical table type for an S3 data source.

\n \n

For non-JSON files, only STRING data types are supported in input columns.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A physical table type for an S3 data source.

" + } + }, + "com.amazonaws.quicksight#SearchAnalyses": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#SearchAnalysesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#SearchAnalysesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches for analyses that belong to the user specified in the filter.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/search/analyses", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#SearchAnalysesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the AWS account that contains the analyses that you're searching\n for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#AnalysisSearchFilterList", + "traits": { + "smithy.api#documentation": "

The structure for the search filters that you want to apply to your search.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return.

" + } + } + } + }, + "com.amazonaws.quicksight#SearchAnalysesResponse": { + "type": "structure", + "members": { + "AnalysisSummaryList": { + "target": "com.amazonaws.quicksight#AnalysisSummaryList", + "traits": { + "smithy.api#documentation": "

Metadata describing the analyses that you searched for.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.\n

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} } }, - "InputColumns": { - "target": "com.amazonaws.quicksight#InputColumnList", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

A physical table type for as S3 data source.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The AWS request ID for this operation.

" } } - }, - "traits": { - "smithy.api#documentation": "

A physical table type for as S3 data source.

" } }, - "com.amazonaws.quicksight#SearchAnalyses": { + "com.amazonaws.quicksight#SearchDashboards": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#SearchAnalysesRequest" + "target": "com.amazonaws.quicksight#SearchDashboardsRequest" }, "output": { - "target": "com.amazonaws.quicksight#SearchAnalysesResponse" + "target": "com.amazonaws.quicksight#SearchDashboardsResponse" }, "errors": [ { @@ -12927,10 +14215,10 @@ } ], "traits": { - "smithy.api#documentation": "

Searches for analyses that belong to the user specified in the filter.

", + "smithy.api#documentation": "

Searches for dashboards that belong to a user.

", "smithy.api#http": { "method": "POST", - "uri": "/accounts/{AwsAccountId}/search/analyses", + "uri": "/accounts/{AwsAccountId}/search/dashboards", "code": 200 }, "smithy.api#paginated": { @@ -12940,52 +14228,52 @@ } } }, - "com.amazonaws.quicksight#SearchAnalysesRequest": { + "com.amazonaws.quicksight#SearchDashboardsRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID of the AWS account that contains the analyses that you're searching\n for.

", + "smithy.api#documentation": "

The ID of the AWS account that contains the user whose dashboards you're searching\n for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Filters": { - "target": "com.amazonaws.quicksight#AnalysisSearchFilterList", + "target": "com.amazonaws.quicksight#DashboardSearchFilterList", "traits": { - "smithy.api#documentation": "

The structure for the search filters that you want to apply to your search.

", + "smithy.api#documentation": "

The filters to apply to the search. Currently, you can search only by user name, for\n example, \"Filters\": [ { \"Name\": \"QUICKSIGHT_USER\", \"Operator\": \"StringEquals\",\n \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\" } ]\n

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" } }, "MaxResults": { "target": "com.amazonaws.quicksight#MaxResults", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

The maximum number of results to return.

" + "smithy.api#documentation": "

The maximum number of results to be returned per request.

" } } } }, - "com.amazonaws.quicksight#SearchAnalysesResponse": { + "com.amazonaws.quicksight#SearchDashboardsResponse": { "type": "structure", "members": { - "AnalysisSummaryList": { - "target": "com.amazonaws.quicksight#AnalysisSummaryList", + "DashboardSummaryList": { + "target": "com.amazonaws.quicksight#DashboardSummaryList", "traits": { - "smithy.api#documentation": "

Metadata describing the analyses that you searched for.

" + "smithy.api#documentation": "

The list of dashboards owned by the user specified in Filters in your\n request.

" } }, "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.\n

" + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" } }, "Status": { @@ -13003,15 +14291,18 @@ } } }, - "com.amazonaws.quicksight#SearchDashboards": { + "com.amazonaws.quicksight#SearchFolders": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#SearchDashboardsRequest" + "target": "com.amazonaws.quicksight#SearchFoldersRequest" }, "output": { - "target": "com.amazonaws.quicksight#SearchDashboardsResponse" + "target": "com.amazonaws.quicksight#SearchFoldersResponse" }, "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, { "target": "com.amazonaws.quicksight#InternalFailureException" }, @@ -13032,34 +14323,29 @@ } ], "traits": { - "smithy.api#documentation": "

Searches for dashboards that belong to a user.

", + "smithy.api#documentation": "

Searches the subfolders in a folder.

", "smithy.api#http": { "method": "POST", - "uri": "/accounts/{AwsAccountId}/search/dashboards", + "uri": "/accounts/{AwsAccountId}/search/folders", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" } } }, - "com.amazonaws.quicksight#SearchDashboardsRequest": { + "com.amazonaws.quicksight#SearchFoldersRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID of the AWS account that contains the user whose dashboards you're searching\n for.

", + "smithy.api#documentation": "

The AWS account ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Filters": { - "target": "com.amazonaws.quicksight#DashboardSearchFilterList", + "target": "com.amazonaws.quicksight#FolderSearchFilterList", "traits": { - "smithy.api#documentation": "

The filters to apply to the search. Currently, you can search only by user name, for\n example, \"Filters\": [ { \"Name\": \"QUICKSIGHT_USER\", \"Operator\": \"StringEquals\",\n \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\" } ]\n

", + "smithy.api#documentation": "

The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, \"Filters\": [ { \"Name\": \"PARENT_FOLDER_ARN\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:folder/folderId\" } ].

", "smithy.api#required": {} } }, @@ -13078,32 +14364,32 @@ } } }, - "com.amazonaws.quicksight#SearchDashboardsResponse": { + "com.amazonaws.quicksight#SearchFoldersResponse": { "type": "structure", "members": { - "DashboardSummaryList": { - "target": "com.amazonaws.quicksight#DashboardSummaryList", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "

The list of dashboards owned by the user specified in Filters in your\n request.

" + "smithy.api#documentation": "

The status. If succeeded, the status is SC_OK.

", + "smithy.api#httpResponseCode": {} } }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", + "FolderSummaryList": { + "target": "com.amazonaws.quicksight#FolderSummaryList", "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + "smithy.api#documentation": "

A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders.

" } }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "NextToken": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The AWS request ID for this operation.

" + "smithy.api#documentation": "

The request ID.

" } } } @@ -15898,6 +17184,215 @@ } } }, + "com.amazonaws.quicksight#UpdateFolder": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateFolderRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateFolderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the name of a folder.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateFolderPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateFolderPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateFolderPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates permissions of a folder.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateFolderPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The folder ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The permissions that you want to grant on a resource.

" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The permissions that you want to revoke from a resource.

" + } + } + } + }, + "com.amazonaws.quicksight#UpdateFolderPermissionsResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "

The status. If succeeded, the status is SC_OK.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN).

" + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The folder ID.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

Information about the permissions on the dashboard.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The request ID.

" + } + } + } + }, + "com.amazonaws.quicksight#UpdateFolderRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The folder ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#FolderName", + "traits": { + "smithy.api#documentation": "

The name of the folder.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.quicksight#UpdateFolderResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "

The status. If succeeded, the status is SC_OK.

", + "smithy.api#httpResponseCode": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN).

" + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The folder ID.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The request ID.

" + } + } + } + }, "com.amazonaws.quicksight#UpdateGroup": { "type": "operation", "input": { diff --git a/aws/sdk/aws-models/rds-data.json b/aws/sdk/aws-models/rds-data.json index 2e3e75b22..488e7ed12 100644 --- a/aws/sdk/aws-models/rds-data.json +++ b/aws/sdk/aws-models/rds-data.json @@ -1336,4 +1336,4 @@ } } } -} +} \ No newline at end of file diff --git a/aws/sdk/aws-models/rds.json b/aws/sdk/aws-models/rds.json index 3c4d42ea1..d3673b3a1 100644 --- a/aws/sdk/aws-models/rds.json +++ b/aws/sdk/aws-models/rds.json @@ -49,7 +49,7 @@ "AccountQuotaName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon RDS quota for this AWS account.

" + "smithy.api#documentation": "

The name of the Amazon RDS quota for this Amazon Web Services account.

" } }, "Used": { @@ -66,7 +66,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a quota for an AWS account.

\n

The following are account quotas:

\n \n

For more information, see Quotas for Amazon RDS in the\n Amazon RDS User Guide and Quotas for Amazon Aurora in the\n Amazon Aurora User Guide.

" + "smithy.api#documentation": "

Describes a quota for an Amazon Web Services account.

\n

The following are account quotas:

\n \n

For more information, see Quotas for Amazon RDS in the\n Amazon RDS User Guide and Quotas for Amazon Aurora in the\n Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#AccountQuotaList": { @@ -93,6 +93,12 @@ ] } }, + "com.amazonaws.rds#ActivityStreamModeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, "com.amazonaws.rds#ActivityStreamStatus": { "type": "string", "traits": { @@ -136,7 +142,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.\n For more information, see Authorizing Amazon Aurora MySQL \n to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n " + "smithy.api#documentation": "

Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.\n For more information, see Authorizing Amazon Aurora MySQL \n to Access Other Amazon Web Services Services on Your Behalf in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#AddRoleToDBClusterMessage": { @@ -184,7 +190,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates an AWS Identity and Access Management (IAM) role with a DB instance.

\n \n

To add a role to a DB instance, the status of the DB instance must be available.

\n " + "smithy.api#documentation": "

Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

\n \n

To add a role to a DB instance, the status of the DB instance must be available.

\n " } }, "com.amazonaws.rds#AddRoleToDBInstanceMessage": { @@ -849,6 +855,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified CIDR IP range or Amazon EC2 security group is already authorized for\n the specified DB security group.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -862,6 +872,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified CIDR IP range or Amazon EC2 security group might not be authorized\n for the specified DB security group.

\n

Or, RDS might not be authorized to perform necessary actions using IAM on your\n behalf.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -875,6 +889,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The DB security group authorization quota has been reached.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -903,7 +921,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security \n groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC \n instances. Second, IP ranges are available if the application accessing your database is running on the Internet. \n Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId \n and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

\n \n

You can't authorize ingress from an EC2 security group in one AWS Region to an Amazon RDS DB instance in \n another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

\n \n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.\n

" + "smithy.api#documentation": "

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security \n groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC \n instances. Second, IP ranges are available if the application accessing your database is running on the Internet. \n Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId \n and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

\n \n

You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in \n another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

\n \n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.\n

" } }, "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage": { @@ -937,7 +955,7 @@ "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n AWS account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The AWS access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

" + "smithy.api#documentation": "

\n Amazon Web Services account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The Amazon Web Services access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

" } } }, @@ -1092,6 +1110,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "BackupPolicyNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#deprecated": { "message": "Please avoid using this fault" }, @@ -1193,7 +1215,7 @@ } }, "traits": { - "smithy.api#documentation": "

A CA certificate for an AWS account.

" + "smithy.api#documentation": "

A CA certificate for an Amazon Web Services account.

" } }, "com.amazonaws.rds#CertificateList": { @@ -1211,7 +1233,7 @@ "Certificates": { "target": "com.amazonaws.rds#CertificateList", "traits": { - "smithy.api#documentation": "

The list of Certificate objects for the AWS account.

" + "smithy.api#documentation": "

The list of Certificate objects for the Amazon Web Services account.

" } }, "Marker": { @@ -1233,6 +1255,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "CertificateNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n CertificateIdentifier doesn't refer to an\n existing certificate.\n

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -1299,7 +1325,7 @@ "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

" + "smithy.api#documentation": "

A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" } }, "EngineVersion": { @@ -1478,7 +1504,7 @@ } ], "traits": { - "smithy.api#documentation": "

Copies a snapshot of a DB cluster.

\n

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

\n\n

You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action \n is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, \n you must provide the following values:

\n \n \n

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.

\n

For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.\n

\n

For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n \n

This action only applies to Aurora DB clusters.

\n " + "smithy.api#documentation": "

Copies a snapshot of a DB cluster.

\n

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

\n\n

You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot action \n is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, \n you must provide the following values:

\n \n \n

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.

\n

For more information on copying encrypted DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.\n

\n

For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n \n

This action only applies to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#CopyDBClusterSnapshotMessage": { @@ -1487,7 +1513,7 @@ "SourceDBClusterSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

\n

You can't copy an encrypted, shared DB cluster snapshot from one AWS Region to another.

\n

Constraints:

\n \n

Example: my-cluster-snapshot1\n

", + "smithy.api#documentation": "

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

\n

You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

\n

Constraints:

\n \n

Example: my-cluster-snapshot1\n

", "smithy.api#required": {} } }, @@ -1501,13 +1527,13 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for an encrypted DB cluster snapshot. \n The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

\n \n

If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new AWS KMS CMK. \n If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same AWS KMS key as the source DB cluster snapshot. \n

\n \n

If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

\n \n

To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId to the AWS KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot \n in the destination AWS Region. AWS KMS CMKs are specific to the AWS Region that they are created in, and you can't use CMKs from one AWS Region \n in another AWS Region.

\n \n

If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, \n an error is returned.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

\n \n

If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new Amazon Web Services KMS CMK. \n If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same Amazon Web Services KMS key as the source DB cluster snapshot. \n

\n \n

If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.

\n \n

To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot \n in the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region \n in another Amazon Web Services Region.

\n \n

If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, \n an error is returned.

" } }, "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the \n source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region. \n Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same AWS Region.

\n

The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be\n executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. \n The pre-signed URL request must contain the following parameter values:

\n \n \n \n

To learn how to generate a Signature Version 4 signed request, see \n\n \n Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n \n

If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source AWS Region.

\n " + "smithy.api#documentation": "

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the \n source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. \n Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

\n

The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be\n executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. \n The pre-signed URL request must contain the following parameter values:

\n \n \n \n

To learn how to generate a Signature Version 4 signed request, see \n\n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.

\n " } }, "CopyTags": { @@ -1624,7 +1650,7 @@ } ], "traits": { - "smithy.api#documentation": "

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

\n \n

You can copy a snapshot from one AWS Region to another. In that case, the AWS Region\n where you call the CopyDBSnapshot action is the destination AWS Region for the\n DB snapshot copy.

\n \n

For more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

\n \n

You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region\n where you call the CopyDBSnapshot action is the destination Amazon Web Services Region for the\n DB snapshot copy.

\n \n

For more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#CopyDBSnapshotMessage": { @@ -1633,7 +1659,7 @@ "SourceDBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the source DB snapshot.

\n \n

If the source snapshot is in the same AWS Region as the copy, specify a valid DB\n snapshot identifier. For example, you might specify\n rds:mysql-instance1-snapshot-20130805.

\n \n

If the source snapshot is in a different AWS Region than the copy, specify a valid DB\n snapshot ARN. For example, you might specify\n arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

\n\n

If you are copying from a shared manual DB snapshot, \n this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.\n

\n \n

If you are copying an encrypted snapshot\n this parameter must be in the ARN format for the source AWS Region, \n and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.\n

\n \n

Constraints:

\n \n\n

Example: rds:mydb-2012-04-02-00-01\n

\n\n

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805\n

", + "smithy.api#documentation": "

The identifier for the source DB snapshot.

\n \n

If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB\n snapshot identifier. For example, you might specify\n rds:mysql-instance1-snapshot-20130805.

\n \n

If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB\n snapshot ARN. For example, you might specify\n arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

\n\n

If you are copying from a shared manual DB snapshot, \n this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.\n

\n \n

If you are copying an encrypted snapshot\n this parameter must be in the ARN format for the source Amazon Web Services Region, \n and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.\n

\n \n

Constraints:

\n \n\n

Example: rds:mydb-2012-04-02-00-01\n

\n\n

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805\n

", "smithy.api#required": {} } }, @@ -1647,7 +1673,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for an encrypted DB snapshot. \n The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). \n

\n \n

If you copy an encrypted DB snapshot from your AWS account, \n you can specify a value for this parameter to encrypt the copy with a new AWS KMS CMK. \n If you don't specify a value for this parameter, \n then the copy of the DB snapshot is encrypted with the same AWS KMS key as the source DB snapshot. \n

\n\n

If you copy an encrypted DB snapshot that is shared from another AWS account, \n then you must specify a value for this parameter.\n

\n \n

If you specify this parameter when you copy an unencrypted snapshot, \n the copy is encrypted.\n

\n \n

If you copy an encrypted snapshot to a different AWS Region, then you must specify\n a AWS KMS key identifier for the destination AWS Region. AWS KMS CMKs are specific to the AWS Region\n that they are created in, and you can't use CMKs from one AWS Region in another\n AWS Region.\n

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). \n

\n \n

If you copy an encrypted DB snapshot from your Amazon Web Services account, \n you can specify a value for this parameter to encrypt the copy with a new Amazon Web Services KMS CMK. \n If you don't specify a value for this parameter, \n then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot. \n

\n\n

If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, \n then you must specify a value for this parameter.\n

\n \n

If you specify this parameter when you copy an unencrypted snapshot, \n the copy is encrypted.\n

\n \n

If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify\n a Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region\n that they are created in, and you can't use CMKs from one Amazon Web Services Region in another\n Amazon Web Services Region.\n

" } }, "Tags": { @@ -1662,13 +1688,13 @@ "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The URL that contains a Signature Version 4 signed request for the\n CopyDBSnapshot API action in the source AWS Region that contains the\n source DB snapshot to copy.

\n \n

You must specify this parameter when you copy an encrypted DB snapshot from another\n AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same AWS Region.

\n \n

The presigned URL must be a valid request for the CopyDBSnapshot API action \n that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. \n The presigned URL request must contain the following parameter values:\n

\n \n \n\n\t

To learn how to generate a Signature Version 4 signed request, see \n\t\tAuthenticating Requests: Using Query Parameters (AWS Signature Version 4) and\n\t\tSignature Version 4 Signing Process.\n\t

\n \n \n

If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source AWS Region.

\n " + "smithy.api#documentation": "

The URL that contains a Signature Version 4 signed request for the\n CopyDBSnapshot API action in the source Amazon Web Services Region that contains the\n source DB snapshot to copy.

\n \n

You must specify this parameter when you copy an encrypted DB snapshot from another\n Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same Amazon Web Services Region.

\n \n

The presigned URL must be a valid request for the CopyDBSnapshot API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. \n The presigned URL request must contain the following parameter values:\n

\n \n \n\n\t

To learn how to generate a Signature Version 4 signed request, see \n\t\tAuthenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n\t\tSignature Version 4 Signing Process.\n\t

\n \n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.

\n " } }, "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of an option group to associate with the copy of the snapshot.

\n \n

Specify this option if you are copying a snapshot from one AWS Region to another,\n and your DB instance uses a nondefault option group. \n If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, \n you must specify this option when copying across AWS Regions. \n For more information, see \n Option group considerations in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The name of an option group to associate with the copy of the snapshot.

\n \n

Specify this option if you are copying a snapshot from one Amazon Web Services Region to another,\n and your DB instance uses a nondefault option group. \n If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, \n you must specify this option when copying across Amazon Web Services Regions. \n For more information, see \n Option group considerations in the Amazon RDS User Guide.\n

" } }, "TargetCustomAvailabilityZone": { @@ -1882,7 +1908,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon Aurora DB cluster.

\n

You can use the ReplicationSourceIdentifier parameter to create the DB\n cluster as a read replica of another DB cluster or Amazon RDS MySQL DB instance. For\n cross-region replication where the DB cluster identified by\n ReplicationSourceIdentifier is encrypted, you must also specify the\n PreSignedUrl parameter.

\n\n

For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n \n

This action only applies to Aurora DB clusters.

\n " + "smithy.api#documentation": "

Creates a new Amazon Aurora DB cluster.

\n

You can use the ReplicationSourceIdentifier parameter to create the DB\n cluster as a read replica of another DB cluster or Amazon RDS MySQL or PostgreSQL DB instance. For\n cross-region replication where the DB cluster identified by\n ReplicationSourceIdentifier is encrypted, you must also specify the\n PreSignedUrl parameter.

\n\n

For more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n \n

This action only applies to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#CreateDBClusterEndpoint": { @@ -1967,7 +1993,7 @@ "AvailabilityZones": { "target": "com.amazonaws.rds#AvailabilityZones", "traits": { - "smithy.api#documentation": "

A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on\n AWS Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.\n

" + "smithy.api#documentation": "

A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.\n

" } }, "BackupRetentionPeriod": { @@ -2053,13 +2079,13 @@ "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.\n

\n

Constraints:

\n " + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.\n

\n

Constraints:

\n " } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" } }, "ReplicationSourceIdentifier": { @@ -2083,19 +2109,19 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for an encrypted DB cluster.

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).\n To use a CMK in a different AWS account, specify the key ARN or alias ARN.

\n

When a CMK isn't specified in KmsKeyId:

\n \n

There is a default CMK for your AWS account. Your AWS account\n has a different default CMK for each AWS Region.

\n

If you create a read replica of an encrypted DB cluster in another AWS Region, you\n must set KmsKeyId to a AWS KMS key identifier that is valid in the destination AWS\n Region. This CMK is used to encrypt the read replica in that AWS Region.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).\n To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

When a CMK isn't specified in KmsKeyId:

\n \n

There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account\n has a different default CMK for each Amazon Web Services Region.

\n

If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you\n must set KmsKeyId to a Amazon Web Services KMS key identifier that is valid in the destination Amazon Web Services\n Region. This CMK is used to encrypt the read replica in that Amazon Web Services Region.

" } }, "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A URL that contains a Signature Version 4 signed request for \n the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. \n You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

\n \n

The pre-signed URL must be a valid request for the CreateDBCluster API action \n that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

\n

The pre-signed URL request must contain the following parameter values:

\n \n \n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source AWS Region.

\n " + "smithy.api#documentation": "

A URL that contains a Signature Version 4 signed request for \n the CreateDBCluster action to be called in the source Amazon Web Services Region where the DB cluster is replicated from. \n You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

\n \n

The pre-signed URL must be a valid request for the CreateDBCluster API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied.

\n

The pre-signed URL request must contain the following parameter values:

\n \n \n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.

\n " } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

" } }, "BacktrackWindow": { @@ -2401,14 +2427,14 @@ "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

", + "smithy.api#documentation": "

The compute and memory capacity of the DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

", "smithy.api#required": {} } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this instance.\n

\n \n

Not every database engine is available for every AWS Region.\n

\n\n

Valid Values:\n

\n ", + "smithy.api#documentation": "

The name of the database engine to be used for this instance.\n

\n \n

Not every database engine is available for every Amazon Web Services Region.\n

\n\n

Valid Values:\n

\n ", "smithy.api#required": {} } }, @@ -2439,7 +2465,7 @@ "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The Availability Zone (AZ) where the database will be created. For information on\n AWS Regions and Availability Zones, see \n Regions\n and Availability Zones.\n

\n

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

\n

\n Example: us-east-1d\n

\n

\n Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same AWS Region as the current endpoint.\n

\n \n

If you're creating a DB instance in an RDS on VMware environment,\n specify the identifier of the custom Availability Zone to create the DB instance\n in.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

\n " + "smithy.api#documentation": "

\n The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.\n

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

\n Example: us-east-1d\n

\n

\n Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.\n

\n \n

If you're creating a DB instance in an RDS on VMware environment,\n specify the identifier of the custom Availability Zone to create the DB instance\n in.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

\n " } }, "DBSubnetGroupName": { @@ -2451,7 +2477,7 @@ "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window.\n

\n

\n Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region, occurring on a random day of the\n week.\n

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" + "smithy.api#documentation": "

The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window.\n

\n

\n Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week.\n

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" } }, "DBParameterGroupName": { @@ -2469,7 +2495,7 @@ "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. For more information, see Backup window in the Amazon RDS User Guide.\n

\n \n

\n Amazon Aurora\n

\n

Not applicable. The daily time range for creating automated backups is managed by\n the DB cluster.

\n \n

Constraints:

\n " + "smithy.api#documentation": "

\n The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.\n

\n \n

\n Amazon Aurora\n

\n

Not applicable. The daily time range for creating automated backups is managed by\n the DB cluster.

\n \n

Constraints:

\n " } }, "Port": { @@ -2487,7 +2513,7 @@ "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions action.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every AWS Region.

\n \n

\n Amazon Aurora\n

\n

Not applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.

\n \n

\n MariaDB\n

\n\n

See MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n \n

\n Microsoft SQL Server\n

\n \n

See Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.\n

\n \n

\n MySQL\n

\n\n

See MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n \n

\n Oracle\n

\n \n

See Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.\n

\n\n

\n PostgreSQL\n

\n\n

See Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

The version number of the database engine to use.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions action.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

\n \n

\n Amazon Aurora\n

\n

Not applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.

\n \n

\n MariaDB\n

\n\n

See MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n \n

\n Microsoft SQL Server\n

\n \n

See Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.\n

\n \n

\n MySQL\n

\n\n

See MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n \n

\n Oracle\n

\n \n

See Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.\n

\n\n

\n PostgreSQL\n

\n\n

See Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n

" } }, "AutoMinorVersionUpgrade": { @@ -2571,7 +2597,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for an encrypted DB instance.

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).\n To use a CMK in a different AWS account, specify the key ARN or alias ARN.

\n

\n Amazon Aurora\n

\n

Not applicable. The AWS KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.

\n

If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default CMK. There is a \n default CMK for your AWS account. Your AWS account has a different\n default CMK for each AWS Region.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).\n To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

\n Amazon Aurora\n

\n

Not applicable. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.

\n

If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default CMK. There is a \n default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different\n default CMK for each Amazon Web Services Region.

" } }, "Domain": { @@ -2619,7 +2645,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

This setting doesn't apply to Amazon Aurora. Mapping AWS IAM accounts to database accounts is managed by the DB\n cluster.

\n \n

For more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.

\n \n

For more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" } }, "EnablePerformanceInsights": { @@ -2631,7 +2657,7 @@ "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for encryption of Performance Insights data.

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default CMK. There is a default CMK for your AWS account. \n Your AWS account has a different default CMK for each AWS Region.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default CMK. There is a default CMK for your Amazon Web Services account. \n Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

" } }, "PerformanceInsightsRetentionPeriod": { @@ -2667,7 +2693,7 @@ "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the AWS Outposts User Guide.

" + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } } }, @@ -2759,20 +2785,20 @@ "SourceDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to five read replicas.

\n

Constraints:

\n ", + "smithy.api#documentation": "

The identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to five read replicas.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the read replica, for example,\n db.m4.large. Not all DB instance classes are available in all AWS\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.\n

\n

Default: Inherits from the source DB instance.

" + "smithy.api#documentation": "

The compute and memory capacity of the read replica, for example,\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.\n

\n

Default: Inherits from the source DB instance.

" } }, "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Availability Zone (AZ) where the read replica will be created.

\n

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

\n

\n Example: us-east-1d\n

" + "smithy.api#documentation": "

The Availability Zone (AZ) where the read replica will be created.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

\n Example: us-east-1d\n

" } }, "Port": { @@ -2823,7 +2849,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

\n

Constraints:

\n \n

Example: mySubnetgroup\n

" + "smithy.api#documentation": "

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

\n

Constraints:

\n \n

Example: mySubnetgroup\n

" } }, "VpcSecurityGroupIds": { @@ -2859,19 +2885,19 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for an encrypted read replica.

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS CMK.

\n

If you create an encrypted read replica in the same AWS Region as the source DB\n instance, then do not specify a value for this parameter. A read replica in the same Region\n is always encrypted with the same AWS KMS CMK as the source DB instance.

\n

If you create an encrypted read replica in a different AWS Region, then you must\n specify a AWS KMS key identifier for the destination AWS Region. AWS KMS CMKs are specific to\n the AWS Region that they are created in, and you can't use CMKs from one\n AWS Region in another AWS Region.

\n

You can't create an encrypted read replica from an unencrypted DB instance.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted read replica.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS CMK.

\n

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB\n instance, then do not specify a value for this parameter. A read replica in the same Region\n is always encrypted with the same Amazon Web Services KMS CMK as the source DB instance.

\n

If you create an encrypted read replica in a different Amazon Web Services Region, then you must\n specify a Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to\n the Amazon Web Services Region that they are created in, and you can't use CMKs from one\n Amazon Web Services Region in another Amazon Web Services Region.

\n

You can't create an encrypted read replica from an unencrypted DB instance.

" } }, "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action \n in the source AWS Region that contains the source DB instance.\n

\n \n

You must specify this parameter when you create an encrypted read replica from\n another AWS Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same AWS Region.

\n \n

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action \n that can be executed in the source AWS Region that contains the encrypted source DB instance. \n The presigned URL request must contain the following parameter values:\n

\n \n \n \n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and\n Signature Version 4 Signing Process.\n

\n \n \n

If you are using an AWS SDK tool or the AWS CLI, you can specify\n SourceRegion (or --source-region for the AWS CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can be executed in the source AWS Region.

\n

\n SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS\n doesn't support cross-region read replicas.

\n " + "smithy.api#documentation": "

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action \n in the source Amazon Web Services Region that contains the source DB instance.\n

\n \n

You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.

\n \n

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. \n The presigned URL request must contain the following parameter values:\n

\n \n \n \n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.\n

\n \n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can be executed in the source Amazon Web Services Region.

\n

\n SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS\n doesn't support cross-region read replicas.

\n " } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" } }, "EnablePerformanceInsights": { @@ -2883,7 +2909,7 @@ "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for encryption of Performance Insights data.

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default CMK. There is a default CMK for your AWS account. \n Your AWS account has a different default CMK for each AWS Region.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default CMK. There is a default CMK for your Amazon Web Services account. \n Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

" } }, "PerformanceInsightsRetentionPeriod": { @@ -2991,7 +3017,7 @@ "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n

\n \n

The output contains duplicates.

\n \n

The following are the valid DB engine values:

\n ", + "smithy.api#documentation": "

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n

\n \n

The output contains duplicates.

\n \n

The following are the valid DB engine values:

\n ", "smithy.api#required": {} } }, @@ -3131,7 +3157,7 @@ "DBProxyName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

", + "smithy.api#documentation": "

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

", "smithy.api#required": {} } }, @@ -3152,7 +3178,7 @@ "RoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

", "smithy.api#required": {} } }, @@ -3350,7 +3376,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

" + "smithy.api#documentation": "

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

" } }, "com.amazonaws.rds#CreateDBSubnetGroupMessage": { @@ -3511,7 +3537,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Creates an Aurora global database\n spread across multiple AWS Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.\n

\n

\n You can create a global database that is initially empty, and then\n add a primary cluster and a secondary cluster to it.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.\n

\n \n

This action only applies to Aurora DB clusters.

\n " + "smithy.api#documentation": "

\n Creates an Aurora global database\n spread across multiple Amazon Web Services Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.\n

\n

\n You can create a global database that is initially empty, and then\n add a primary cluster and a secondary cluster to it.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.\n

\n \n

This action only applies to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#CreateGlobalClusterMessage": { @@ -3602,7 +3628,7 @@ "EngineName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the engine that this option group should be associated with.

\n

Valid Values:\n

\n ", + "smithy.api#documentation": "

Specifies the name of the engine that this option group should be associated with.

\n

Valid Values:\n

\n ", "smithy.api#required": {} } }, @@ -3663,7 +3689,7 @@ "VpnDetails": { "target": "com.amazonaws.rds#VpnDetails", "traits": { - "smithy.api#documentation": "

Information about the virtual private network (VPN) between the VMware vSphere cluster\n and the AWS website.

" + "smithy.api#documentation": "

Information about the virtual private network (VPN) between the VMware vSphere cluster\n and the Amazon Web Services website.

" } } }, @@ -3679,6 +3705,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomAvailabilityZoneAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

\n CustomAvailabilityZoneName is already used by an existing custom\n Availability Zone.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3705,7 +3735,7 @@ "CustomAvailabilityZones": { "target": "com.amazonaws.rds#CustomAvailabilityZoneList", "traits": { - "smithy.api#documentation": "

The list of CustomAvailabilityZone objects for the AWS account.

" + "smithy.api#documentation": "

The list of CustomAvailabilityZone objects for the Amazon Web Services account.

" } } } @@ -3718,6 +3748,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomAvailabilityZoneNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n CustomAvailabilityZoneId doesn't refer to an existing custom\n Availability Zone identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -3731,6 +3765,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomAvailabilityZoneQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You have exceeded the maximum number of custom Availability Zones.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3916,13 +3954,13 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

" + "smithy.api#documentation": "

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

" } }, "DbClusterResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever \n the AWS KMS CMK for the DB cluster is accessed.

" + "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever \n the Amazon Web Services KMS CMK for the DB cluster is accessed.

" } }, "DBClusterArn": { @@ -3934,13 +3972,13 @@ "AssociatedRoles": { "target": "com.amazonaws.rds#DBClusterRoles", "traits": { - "smithy.api#documentation": "

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. \n IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services\n on your behalf.

" + "smithy.api#documentation": "

Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. \n IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services\n on your behalf.

" } }, "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether the mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

" + "smithy.api#documentation": "

A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" } }, "CloneGroupId": { @@ -4021,7 +4059,7 @@ "ActivityStreamKmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier used for encrypting messages in the database activity stream.

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

" } }, "ActivityStreamKinesisStreamName": { @@ -4039,7 +4077,7 @@ "CrossAccountClone": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether the DB cluster is a clone of a DB cluster owned by a different AWS account.

" + "smithy.api#documentation": "

Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

" } }, "DomainMemberships": { @@ -4082,6 +4120,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterAlreadyExistsFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The user already has a DB cluster with the given identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -4168,6 +4210,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterBacktrackNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n BacktrackIdentifier doesn't refer to an existing backtrack.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -4284,6 +4330,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterEndpointAlreadyExistsFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified custom endpoint can't be created because it already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -4323,6 +4373,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterEndpointNotFoundFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified custom endpoint doesn't exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -4336,6 +4390,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterEndpointQuotaExceededFault", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

The cluster already has the maximum number of custom endpoints.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -4429,6 +4487,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBClusterIdentifier doesn't refer to an existing DB cluster.\n

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -4546,6 +4608,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterParameterGroupNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBClusterParameterGroupName doesn't refer to an existing DB\n cluster parameter group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -4579,6 +4645,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterQuotaExceededFault", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

The user attempted to create a new DB cluster and the user has already reached the\n maximum allowed DB cluster quota.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -4596,18 +4666,18 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following\n values:

\n " + "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following\n values:

\n " } }, "FeatureName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the feature associated with the AWS Identity and Access Management (IAM) role.\n For the list of supported feature names, see DBEngineVersion.\n

" + "smithy.api#documentation": "

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For the list of supported feature names, see DBEngineVersion.\n

" } } }, "traits": { - "smithy.api#documentation": "

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.

" + "smithy.api#documentation": "

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.

" } }, "com.amazonaws.rds#DBClusterRoleAlreadyExistsFault": { @@ -4618,6 +4688,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterRoleAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -4631,6 +4705,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterRoleNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -4644,6 +4722,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterRoleQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -4766,7 +4848,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

" + "smithy.api#documentation": "

If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

" } }, "DBClusterSnapshotArn": { @@ -4784,7 +4866,7 @@ "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

" + "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

" } }, "TagList": { @@ -4803,6 +4885,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterSnapshotAlreadyExistsFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The user already has a DB cluster snapshot with the given identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -4814,18 +4900,18 @@ "AttributeName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the manual DB cluster snapshot attribute.

\n

The attribute named restore refers to the list of AWS accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBClusterSnapshotAttribute\n API action.

" + "smithy.api#documentation": "

The name of the manual DB cluster snapshot attribute.

\n

The attribute named restore refers to the list of Amazon Web Services accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBClusterSnapshotAttribute\n API action.

" } }, "AttributeValues": { "target": "com.amazonaws.rds#AttributeValueList", "traits": { - "smithy.api#documentation": "

The value(s) for the manual DB cluster snapshot attribute.

\n

If the AttributeName field is set to restore, then this element\n returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual\n DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot\n is public and available for any AWS account to copy or restore.

" + "smithy.api#documentation": "

The value(s) for the manual DB cluster snapshot attribute.

\n

If the AttributeName field is set to restore, then this element\n returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual\n DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot\n is public and available for any Amazon Web Services account to copy or restore.

" } } }, "traits": { - "smithy.api#documentation": "

Contains the name and values of a manual DB cluster snapshot attribute.

\n

Manual DB cluster snapshot attributes are used to authorize other AWS accounts\n to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.

" + "smithy.api#documentation": "

Contains the name and values of a manual DB cluster snapshot attribute.

\n

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.

" } }, "com.amazonaws.rds#DBClusterSnapshotAttributeList": { @@ -4854,7 +4940,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes\n API action.

\n

Manual DB cluster snapshot attributes are used to authorize other AWS accounts\n to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.

" + "smithy.api#documentation": "

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes\n API action.

\n

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.

" } }, "com.amazonaws.rds#DBClusterSnapshotList": { @@ -4894,6 +4980,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterSnapshotNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.\n

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -5284,13 +5374,13 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n If StorageEncrypted is true, the AWS KMS key identifier \n for the encrypted DB instance.\n

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

" + "smithy.api#documentation": "

\n If StorageEncrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB instance.\n

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

" } }, "DbiResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log \n entries whenever the AWS KMS customer master key (CMK) for the DB instance is accessed.

" + "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log \n entries whenever the Amazon Web Services KMS customer master key (CMK) for the DB instance is accessed.

" } }, "CACertificateIdentifier": { @@ -5350,7 +5440,7 @@ "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

\n\n

IAM database authentication can be enabled for the following database engines

\n " + "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

\n\n

IAM database authentication can be enabled for the following database engines

\n " } }, "PerformanceInsightsEnabled": { @@ -5362,7 +5452,7 @@ "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for encryption of Performance Insights data.

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

" } }, "PerformanceInsightsRetentionPeriod": { @@ -5392,7 +5482,7 @@ "AssociatedRoles": { "target": "com.amazonaws.rds#DBInstanceRoles", "traits": { - "smithy.api#documentation": "

\n The AWS Identity and Access Management (IAM) roles associated with the DB instance.\n

" + "smithy.api#documentation": "

\n The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.\n

" } }, "ListenerEndpoint": { @@ -5419,13 +5509,43 @@ "CustomerOwnedIpEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the AWS Outposts User Guide.

" + "smithy.api#documentation": "

Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } }, "AwsBackupRecoveryPointArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in AWS Backup.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

" + } + }, + "ActivityStreamStatus": { + "target": "com.amazonaws.rds#ActivityStreamStatus", + "traits": { + "smithy.api#documentation": "

The status of the database activity stream.

" + } + }, + "ActivityStreamKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS \n customer master key (CMK).

" + } + }, + "ActivityStreamKinesisStreamName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis data stream used for the database activity stream.

" + } + }, + "ActivityStreamMode": { + "target": "com.amazonaws.rds#ActivityStreamMode", + "traits": { + "smithy.api#documentation": "

The mode of the database activity stream. Database events such as a change or access generate \n an activity stream event. RDS for Oracle always handles these events asynchronously.

" + } + }, + "ActivityStreamEngineNativeAuditFieldsIncluded": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" } } }, @@ -5441,6 +5561,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The user already has a DB instance with the given identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5458,13 +5582,13 @@ "DbiResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

" + "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" } }, "Region": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS Region associated with the automated backup.

" + "smithy.api#documentation": "

The Amazon Web Services Region associated with the automated backup.

" } }, "DBInstanceIdentifier": { @@ -5500,7 +5624,7 @@ "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Availability Zone that the automated backup was created in. For information on\n AWS Regions and Availability Zones, see \n Regions\n and Availability Zones.

" + "smithy.api#documentation": "

The Availability Zone that the automated backup was created in. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

" } }, "VpcId": { @@ -5572,7 +5696,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key ID for an automated backup.

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

" + "smithy.api#documentation": "

The Amazon Web Services KMS key ID for an automated backup.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

" } }, "Timezone": { @@ -5584,7 +5708,7 @@ "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, \n and otherwise false.

" + "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, \n and otherwise false.

" } }, "BackupRetentionPeriod": { @@ -5602,7 +5726,7 @@ "DBInstanceAutomatedBackupsReplications": { "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList", "traits": { - "smithy.api#documentation": "

The list of replications to different AWS Regions associated with the automated backup.

" + "smithy.api#documentation": "

The list of replications to different Amazon Web Services Regions associated with the automated backup.

" } } }, @@ -5647,6 +5771,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceAutomatedBackupNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

No automated backup for this DB instance was found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -5660,6 +5788,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceAutomatedBackupQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The quota for retained automated backups was exceeded. This prevents you\n from retaining any additional automated backups. The retained automated backups \n quota is the same as your DB Instance quota.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5676,7 +5808,7 @@ } }, "traits": { - "smithy.api#documentation": "

Automated backups of a DB instance replicated to another AWS Region. They consist of system backups, transaction logs, and database instance properties.

" + "smithy.api#documentation": "

Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.

" } }, "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList": { @@ -5725,6 +5857,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBInstanceIdentifier doesn't refer to an existing DB instance.\n

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -5742,18 +5878,18 @@ "FeatureName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the feature associated with the AWS Identity and Access Management (IAM) role.\n For the list of supported feature names, see DBEngineVersion.\n

" + "smithy.api#documentation": "

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For the list of supported feature names, see DBEngineVersion.\n

" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values:

\n " + "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values:

\n " } } }, "traits": { - "smithy.api#documentation": "

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB instance.

" + "smithy.api#documentation": "

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.

" } }, "com.amazonaws.rds#DBInstanceRoleAlreadyExistsFault": { @@ -5764,6 +5900,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceRoleAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified RoleArn or FeatureName value is already associated with the DB instance.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5777,6 +5917,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceRoleNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified RoleArn value doesn't match the specified feature for\n the DB instance.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -5790,7 +5934,11 @@ } }, "traits": { - "smithy.api#documentation": "

You can't associate any more AWS Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.

", + "aws.protocols#awsQueryError": { + "code": "DBInstanceRoleQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -5853,6 +6001,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBLogFileNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n LogFileName doesn't refer to an existing DB log file.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -5898,6 +6050,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBParameterGroupAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

A DB parameter group with the same name exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5954,6 +6110,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBParameterGroupNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBParameterGroupName doesn't refer to an\n existing DB parameter group.\n

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -5967,6 +6127,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBParameterGroupQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB parameter\n groups.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -6027,7 +6191,7 @@ "DBProxyName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.

" + "smithy.api#documentation": "

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

" } }, "DBProxyArn": { @@ -6127,7 +6291,11 @@ } }, "traits": { - "smithy.api#documentation": "

The specified proxy name must be unique for all proxies owned by your AWS account in the specified AWS Region.

", + "aws.protocols#awsQueryError": { + "code": "DBProxyAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -6214,7 +6382,11 @@ } }, "traits": { - "smithy.api#documentation": "

The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.

", + "aws.protocols#awsQueryError": { + "code": "DBProxyEndpointAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -6243,6 +6415,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyEndpointNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The DB proxy endpoint doesn't exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -6256,6 +6432,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyEndpointQuotaExceededFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The DB proxy already has the maximum number of endpoints.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -6331,7 +6511,11 @@ } }, "traits": { - "smithy.api#documentation": "

The specified proxy name doesn't correspond to a proxy owned by your AWS account in the specified AWS Region.

", + "aws.protocols#awsQueryError": { + "code": "DBProxyNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -6344,7 +6528,11 @@ } }, "traits": { - "smithy.api#documentation": "

Your AWS account already has the maximum number of proxies in the specified AWS Region.

", + "aws.protocols#awsQueryError": { + "code": "DBProxyQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web Services Region.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -6456,6 +6644,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyTargetAlreadyRegisteredFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -6473,7 +6665,7 @@ "TargetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the target group. This name must be unique for all target groups owned by your AWS account in the specified AWS Region.

" + "smithy.api#documentation": "

The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.

" } }, "TargetGroupArn": { @@ -6525,7 +6717,11 @@ } }, "traits": { - "smithy.api#documentation": "

The specified target group isn't available for a proxy owned by your AWS account in the specified AWS Region.

", + "aws.protocols#awsQueryError": { + "code": "DBProxyTargetGroupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -6538,7 +6734,11 @@ } }, "traits": { - "smithy.api#documentation": "

The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your AWS account in the specified AWS Region.

", + "aws.protocols#awsQueryError": { + "code": "DBProxyTargetNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -6549,7 +6749,7 @@ "OwnerId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Provides the AWS ID of the owner of a specific DB security group.

" + "smithy.api#documentation": "

Provides the Amazon Web Services ID of the owner of a specific DB security group.

" } }, "DBSecurityGroupName": { @@ -6601,6 +6801,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSecurityGroupAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

\n A DB security group with the name specified in\n DBSecurityGroupName already exists.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -6672,6 +6876,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSecurityGroupNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBSecurityGroupName doesn't refer to an existing DB security group.\n

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -6685,6 +6893,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSecurityGroupNotSupported", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

A DB security group isn't allowed for this action.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -6698,6 +6910,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "QuotaExceeded.DBSecurityGroup", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB security\n groups.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -6820,7 +7036,7 @@ "SourceRegion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS Region that the DB snapshot was created in or copied from.

" + "smithy.api#documentation": "

The Amazon Web Services Region that the DB snapshot was created in or copied from.

" } }, "SourceDBSnapshotIdentifier": { @@ -6850,7 +7066,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n If Encrypted is true, the AWS KMS key identifier \n for the encrypted DB snapshot.\n

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

" + "smithy.api#documentation": "

\n If Encrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB snapshot.\n

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

" } }, "DBSnapshotArn": { @@ -6868,7 +7084,7 @@ "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

" + "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

" } }, "ProcessorFeatures": { @@ -6880,7 +7096,7 @@ "DbiResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

" + "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" } }, "TagList": { @@ -6899,6 +7115,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSnapshotAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

\n DBSnapshotIdentifier is already used by an existing snapshot.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -6910,18 +7130,18 @@ "AttributeName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the manual DB snapshot attribute.

\n

The attribute named restore refers to the list of AWS accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBSnapshotAttribute\n API action.

" + "smithy.api#documentation": "

The name of the manual DB snapshot attribute.

\n

The attribute named restore refers to the list of Amazon Web Services accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBSnapshotAttribute\n API action.

" } }, "AttributeValues": { "target": "com.amazonaws.rds#AttributeValueList", "traits": { - "smithy.api#documentation": "

The value or values for the manual DB snapshot attribute.

\n

If the AttributeName field is set to restore, then this element\n returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual\n DB snapshot. If a value of all is in the list, then the manual DB snapshot\n is public and available for any AWS account to copy or restore.

" + "smithy.api#documentation": "

The value or values for the manual DB snapshot attribute.

\n

If the AttributeName field is set to restore, then this element\n returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual\n DB snapshot. If a value of all is in the list, then the manual DB snapshot\n is public and available for any Amazon Web Services account to copy or restore.

" } } }, "traits": { - "smithy.api#documentation": "

Contains the name and values of a manual DB snapshot attribute

\n

Manual DB snapshot attributes are used to authorize other AWS accounts\n to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API.

" + "smithy.api#documentation": "

Contains the name and values of a manual DB snapshot attribute

\n

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API.

" } }, "com.amazonaws.rds#DBSnapshotAttributeList": { @@ -6950,7 +7170,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the results of a successful call to the DescribeDBSnapshotAttributes\n API action.

\n

Manual DB snapshot attributes are used to authorize other AWS accounts\n to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API action.

" + "smithy.api#documentation": "

Contains the results of a successful call to the DescribeDBSnapshotAttributes\n API action.

\n

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API action.

" } }, "com.amazonaws.rds#DBSnapshotList": { @@ -6990,6 +7210,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSnapshotNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBSnapshotIdentifier doesn't refer to an existing DB snapshot.\n

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -7047,6 +7271,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

\n DBSubnetGroupName is already used by an existing DB subnet group.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7060,6 +7288,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupDoesNotCoverEnoughAZs", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7093,6 +7325,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupNotAllowedFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The DBSubnetGroup shouldn't be specified while creating read replicas that lie\n in the same region as the source instance.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7106,6 +7342,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n DBSubnetGroupName doesn't refer to an existing DB subnet group.\n

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -7119,6 +7359,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB subnet\n groups.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7141,6 +7385,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetQuotaExceededFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of subnets in a\n DB subnet groups.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7154,6 +7402,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DBUpgradeDependencyFailure", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The DB upgrade failed because a resource the DB depends on can't be\n modified.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7431,7 +7683,7 @@ "DbiResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

" + "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" } }, "DBInstanceAutomatedBackupsArn": { @@ -7959,7 +8211,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the set of CA certificates provided by Amazon RDS for this AWS account.

", + "smithy.api#documentation": "

Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -8306,7 +8558,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

\n

When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes\n returns the restore attribute and a list of IDs for the AWS accounts that are \n authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB cluster snapshot is public and\n can be copied or restored by all AWS accounts.

\n

To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the\n manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

\n \n

This action only applies to Aurora DB clusters.

\n " + "smithy.api#documentation": "

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

\n

When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB cluster snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.

\n

To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the\n manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

\n \n

This action only applies to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesMessage": { @@ -8501,7 +8753,7 @@ "SnapshotType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The type of DB cluster snapshots to be returned. You can specify one of the following values:

\n \n

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are\n returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared\n parameter. You can include public DB cluster snapshots with these results by enabling the \n IncludePublic parameter.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

" + "smithy.api#documentation": "

The type of DB cluster snapshots to be returned. You can specify one of the following values:

\n \n

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are\n returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared\n parameter. You can include public DB cluster snapshots with these results by enabling the \n IncludePublic parameter.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

" } }, "Filters": { @@ -8525,13 +8777,13 @@ "IncludeShared": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether to include shared manual DB cluster snapshots \n from other AWS accounts that this AWS account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an AWS account permission to restore a manual DB cluster snapshot from\n another AWS account by the ModifyDBClusterSnapshotAttribute API action.

" + "smithy.api#documentation": "

A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from\n another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

" } }, "IncludePublic": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any AWS account. By default, the public snapshots are not included.

\n

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

" + "smithy.api#documentation": "

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

\n

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

" } } }, @@ -8592,7 +8844,7 @@ "IncludeShared": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

Optional Boolean parameter that specifies whether the output includes information about clusters\n shared from other AWS accounts.

" + "smithy.api#documentation": "

Optional Boolean parameter that specifies whether the output includes information about clusters\n shared from other Amazon Web Services accounts.

" } } }, @@ -8624,7 +8876,7 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database engine to return.

\n

Valid Values:\n

\n " + "smithy.api#documentation": "

The database engine to return.

\n

Valid Values:\n

\n " } }, "EngineVersion": { @@ -9144,7 +9396,7 @@ "DBProxyName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB proxy. If you omit this parameter,\n the output includes information about all DB proxies owned by\n your AWS account ID.

" + "smithy.api#documentation": "

The name of the DB proxy. If you omit this parameter,\n the output includes information about all DB proxies owned by\n your Amazon Web Services account ID.

" } }, "Filters": { @@ -9498,7 +9750,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

\n

When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes\n returns the restore attribute and a list of IDs for the AWS accounts that are \n authorized to copy or restore the manual DB snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB snapshot is public and\n can be copied or restored by all AWS accounts.

\n

To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the\n manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

" + "smithy.api#documentation": "

Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

\n

When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.

\n

To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the\n manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

" } }, "com.amazonaws.rds#DescribeDBSnapshotAttributesMessage": { @@ -9632,7 +9884,7 @@ "SnapshotType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The type of snapshots to be returned. You can specify one of the following values:

\n \n

If you don't specify a SnapshotType value, then both automated and manual snapshots are\n returned. Shared and public DB snapshots are not included in the returned results by default.\n You can include shared snapshots with these results by enabling the IncludeShared\n parameter. You can include public snapshots with these results by enabling the \n IncludePublic parameter.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

" + "smithy.api#documentation": "

The type of snapshots to be returned. You can specify one of the following values:

\n \n

If you don't specify a SnapshotType value, then both automated and manual snapshots are\n returned. Shared and public DB snapshots are not included in the returned results by default.\n You can include shared snapshots with these results by enabling the IncludeShared\n parameter. You can include public snapshots with these results by enabling the \n IncludePublic parameter.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

" } }, "Filters": { @@ -9656,13 +9908,13 @@ "IncludeShared": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether to include shared manual DB cluster snapshots \n from other AWS accounts that this AWS account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an AWS account permission to restore a manual DB snapshot from\n another AWS account by using the ModifyDBSnapshotAttribute API action.

" + "smithy.api#documentation": "

A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.

" } }, "IncludePublic": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any AWS account. By default, the public snapshots are not included.

\n

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

" + "smithy.api#documentation": "

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

\n

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

" } }, "DbiResourceId": { @@ -10196,7 +10448,7 @@ "EngineName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A required parameter. Options available for the given engine name are described.

\n

Valid Values:\n

\n ", + "smithy.api#documentation": "

A required parameter. Options available for the given engine name are described.

\n

Valid Values:\n

\n ", "smithy.api#required": {} } }, @@ -10282,7 +10534,7 @@ "EngineName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

Filters the list of option groups to only include groups associated with a specific database engine.

\n

Valid Values:\n

\n " + "smithy.api#documentation": "

Filters the list of option groups to only include groups associated with a specific database engine.

\n

Valid Values:\n

\n " } }, "MajorEngineVersion": { @@ -10320,7 +10572,7 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the engine to retrieve DB instance options for.

\n

Valid Values:\n

\n ", + "smithy.api#documentation": "

The name of the engine to retrieve DB instance options for.

\n

Valid Values:\n

\n ", "smithy.api#required": {} } }, @@ -10345,7 +10597,7 @@ "AvailabilityZoneGroup": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

\n

Omit this parameter to show the available offerings in the specified AWS Region.

" + "smithy.api#documentation": "

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

\n

Omit this parameter to show the available offerings in the specified Amazon Web Services Region.

" } }, "Vpc": { @@ -10503,7 +10755,7 @@ "LeaseId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

\n \n

AWS Support might request the lease ID for an issue related to a reserved DB instance.

\n " + "smithy.api#documentation": "

The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

\n \n

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

\n " } }, "Filters": { @@ -10623,7 +10875,7 @@ "target": "com.amazonaws.rds#SourceRegionMessage" }, "traits": { - "smithy.api#documentation": "

Returns a list of the source AWS Regions where the current AWS Region can create a read replica, \n copy a DB snapshot from, or replicate automated backups from. This API action supports pagination.

", + "smithy.api#documentation": "

Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, \n copy a DB snapshot from, or replicate automated backups from. This API action supports pagination.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -10638,7 +10890,7 @@ "RegionName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The source AWS Region name. For example, us-east-1.

\n

Constraints:

\n " + "smithy.api#documentation": "

The source Amazon Web Services Region name. For example, us-east-1.

\n

Constraints:

\n " } }, "MaxRecords": { @@ -10759,6 +11011,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DomainNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n Domain doesn't refer to an existing Active Directory domain.\n

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -10911,7 +11167,7 @@ "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n Specifies the AWS ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.\n

" + "smithy.api#documentation": "

\n Specifies the Amazon Web Services ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.\n

" } } }, @@ -11112,7 +11368,7 @@ "CustomerAwsId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS customer account associated with the RDS event notification subscription.

" + "smithy.api#documentation": "

The Amazon Web Services customer account associated with the RDS event notification subscription.

" } }, "CustSubscriptionId": { @@ -11182,6 +11438,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "EventSubscriptionQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You have reached the maximum number of event subscriptions.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -11299,7 +11559,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The key identifier of the AWS KMS customer master key (CMK) that is used to encrypt the snapshot when it's exported to\n Amazon S3. The AWS KMS CMK identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export\n must have encryption and decryption permissions to use this AWS KMS CMK.

" + "smithy.api#documentation": "

The key identifier of the Amazon Web Services KMS customer master key (CMK) that is used to encrypt the snapshot when it's exported to\n Amazon S3. The Amazon Web Services KMS CMK identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export\n must have encryption and decryption permissions to use this Amazon Web Services KMS CMK.

" } }, "Status": { @@ -11345,6 +11605,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ExportTaskAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You can't start an export task that's already running.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -11358,6 +11622,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ExportTaskNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The export task doesn't exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -11480,7 +11748,7 @@ "TargetDbClusterIdentifier": { "target": "com.amazonaws.rds#DBClusterIdentifier", "traits": { - "smithy.api#documentation": "

Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora\n global database (GlobalCluster.) Use the Amazon Resource Name (ARN) for the identifier so that\n Aurora can locate the cluster in its AWS Region. \n

", + "smithy.api#documentation": "

Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora\n global database (GlobalCluster.) Use the Amazon Resource Name (ARN) for the identifier so that\n Aurora can locate the cluster in its Amazon Web Services Region. \n

", "smithy.api#required": {} } } @@ -11597,7 +11865,7 @@ "GlobalClusterResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in\n AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB cluster is accessed.\n

" + "smithy.api#documentation": "

\n The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in\n Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS customer master key (CMK) for the DB cluster is accessed.\n

" } }, "GlobalClusterArn": { @@ -11667,6 +11935,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalClusterAlreadyExistsFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The GlobalClusterIdentifier already exists. Choose a new global database identifier (unique name) to create a new global database cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -11740,6 +12012,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalClusterNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -11753,6 +12029,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalClusterQuotaExceededFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The number of global database clusters for this account is already at the maximum allowed.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -11827,6 +12107,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "IamRoleMissingPermissions", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The IAM role requires additional permissions to export to an Amazon S3 bucket.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -11840,6 +12124,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "IamRoleNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The IAM role is missing for exporting to an Amazon S3 bucket.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -11969,6 +12257,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InstallationMediaAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified installation medium has already been imported.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12009,7 +12301,7 @@ "InstallationMedia": { "target": "com.amazonaws.rds#InstallationMediaList", "traits": { - "smithy.api#documentation": "

The list of InstallationMedia objects for the AWS account.

" + "smithy.api#documentation": "

The list of InstallationMedia objects for the Amazon Web Services account.

" } } } @@ -12022,6 +12314,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InstallationMediaNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

\n InstallationMediaID doesn't refer to an existing installation medium.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -12035,6 +12331,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InstanceQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB\n instances.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12048,6 +12348,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientAvailableIPsInSubnetFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The requested operation can't be performed because there aren't enough available IP addresses \n in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required \n from the subnets.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12061,6 +12365,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientDBClusterCapacityFault", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

The DB cluster doesn't have enough capacity for the current operation.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -12074,6 +12382,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientDBInstanceCapacity", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified DB instance class isn't available in the specified Availability\n Zone.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12087,6 +12399,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientStorageClusterCapacity", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

There is insufficient storage available for the current action. You might be able to\n resolve this error by updating your subnet group to use different Availability Zones\n that have more storage available.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12109,6 +12425,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterCapacityFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

\n Capacity isn't a valid Aurora Serverless DB cluster\n capacity. Valid capacity values are 2, 4, 8, 16, \n 32, 64, 128, and 256.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12122,6 +12442,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterEndpointStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The requested operation can't be performed on the endpoint while the endpoint is in this state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12135,6 +12459,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterSnapshotStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The supplied value isn't a valid DB cluster snapshot state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12148,6 +12476,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The requested operation can't be performed while the cluster is in this state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12161,6 +12493,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBInstanceAutomatedBackupState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The automated backup is in an invalid state. \n \t For example, this automated backup is associated with an active instance.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12174,6 +12510,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBInstanceState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The DB instance isn't in a valid state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12187,6 +12527,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBParameterGroupState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The DB parameter group is in use or is in an invalid state. If you are attempting\n to delete the parameter group, you can't delete it when the parameter group is in\n this state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12200,6 +12544,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBProxyEndpointStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You can't perform this operation while the DB proxy endpoint is in a particular state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12213,6 +12561,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBProxyStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The requested operation can't be performed while the proxy is in this state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12226,6 +12578,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSecurityGroupState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The state of the DB security group doesn't allow deletion.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12239,6 +12595,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSnapshotState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The state of the DB snapshot doesn't allow deletion.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12252,6 +12612,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSubnetGroupFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The DBSubnetGroup doesn't belong to the same VPC as that of an existing\n cross-region read replica of the same source instance.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12265,6 +12629,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSubnetGroupStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The DB subnet group cannot be deleted because it's in use.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12278,6 +12646,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSubnetStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

\n The DB subnet isn't in the available state.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12291,6 +12663,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidEventSubscriptionState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

This error can occur if someone else is modifying a subscription. You should retry the action.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12304,6 +12680,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidExportOnly", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The export is invalid for exporting to an Amazon S3 bucket.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12317,6 +12697,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidExportSourceState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12330,6 +12714,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidExportTaskStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You can't cancel an export task that has completed.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12343,6 +12731,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidGlobalClusterStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The global cluster is in an invalid state and can't perform the requested operation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12356,6 +12748,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidOptionGroupStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

\n The option group isn't in the available state.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12369,6 +12765,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidRestoreFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Cannot restore from VPC backup to non-VPC DB instance.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12382,6 +12782,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidS3BucketFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified Amazon S3 bucket name can't be found or Amazon RDS isn't\n authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12395,6 +12799,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSubnet", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12408,6 +12816,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidVPCNetworkStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The DB subnet group doesn't cover all Availability Zones after it's\n created because of users' change.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12421,7 +12833,11 @@ } }, "traits": { - "smithy.api#documentation": "

An error occurred accessing an AWS KMS key.

", + "aws.protocols#awsQueryError": { + "code": "KMSKeyNotAccessibleFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

An error occurred accessing an Amazon Web Services KMS key.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -12550,7 +12966,7 @@ } ], "traits": { - "smithy.api#documentation": "

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)\n certificate for Amazon RDS for new DB instances temporarily, or remove the override.

\n

By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB\n instances that is different from the default certificate provided by RDS. You can also\n use this operation to remove the override, so that new DB instances use the default\n certificate provided by RDS.

\n

You might need to override the default certificate in the following situations:

\n \n

For more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

\n

For more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

" + "smithy.api#documentation": "

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)\n certificate for Amazon RDS for new DB instances temporarily, or remove the override.

\n

By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB\n instances that is different from the default certificate provided by RDS. You can also\n use this operation to remove the override, so that new DB instances use the default\n certificate provided by RDS.

\n

You might need to override the default certificate in the following situations:

\n \n

For more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

\n

For more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#ModifyCertificatesMessage": { @@ -12559,7 +12975,7 @@ "CertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The new default certificate identifier to override the current one with.

\n

To determine the valid values, use the describe-certificates AWS CLI\n command or the DescribeCertificates API operation.

" + "smithy.api#documentation": "

The new default certificate identifier to override the current one with.

\n

To determine the valid values, use the describe-certificates CLI\n command or the DescribeCertificates API operation.

" } }, "RemoveCustomerOverride": { @@ -12801,19 +13217,19 @@ "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.\n

\n

Constraints:

\n " + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.\n

\n

Constraints:

\n " } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.\n

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

" } }, "BacktrackWindow": { @@ -12963,7 +13379,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

\n

To share a manual DB cluster snapshot with other AWS accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the AWS accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all AWS accounts.

\n \n

Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all AWS\n accounts.

\n \n

If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized AWS account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.

\n

To view which AWS accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API action. The accounts are\n returned as values for the restore attribute.

\n \n

This action only applies to Aurora DB clusters.

\n " + "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

\n

To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API action. The accounts are\n returned as values for the restore attribute.

\n \n

This action only applies to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeMessage": { @@ -12979,20 +13395,20 @@ "AttributeName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB cluster snapshot attribute to modify.

\n

To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBClusterSnapshotAttributes API action.

\n ", + "smithy.api#documentation": "

The name of the DB cluster snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBClusterSnapshotAttributes API action.

\n ", "smithy.api#required": {} } }, "ValuesToAdd": { "target": "com.amazonaws.rds#AttributeValueList", "traits": { - "smithy.api#documentation": "

A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account\n IDs, or all to make the manual DB cluster snapshot restorable by \n any AWS account. Do not add the all value for any\n manual DB cluster snapshots that contain private information that you don't want available\n to all AWS accounts.

" + "smithy.api#documentation": "

A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB cluster snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB cluster snapshots that contain private information that you don't want available\n to all Amazon Web Services accounts.

" } }, "ValuesToRemove": { "target": "com.amazonaws.rds#AttributeValueList", "traits": { - "smithy.api#documentation": "

A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

\n

To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include\n one or more AWS account\n identifiers, or all to remove authorization for any AWS account to copy or\n restore the DB cluster snapshot. If you specify all, an AWS account whose account ID is\n explicitly added to the restore attribute\n can still copy or restore a manual DB cluster snapshot.

" + "smithy.api#documentation": "

A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

\n

To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include\n one or more Amazon Web Services account\n identifiers, or all to remove authorization for any Amazon Web Services account to copy or\n restore the DB cluster snapshot. If you specify all, an Amazon Web Services account whose account ID is\n explicitly added to the restore attribute\n can still copy or restore a manual DB cluster snapshot.

" } } }, @@ -13098,7 +13514,7 @@ "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The new compute and memory capacity of the DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

If you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.\n

\n

Default: Uses existing setting

" + "smithy.api#documentation": "

The new compute and memory capacity of the DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

If you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.\n

\n

Default: Uses existing setting

" } }, "DBSubnetGroupName": { @@ -13146,7 +13562,7 @@ "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod parameter. \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. For more information, see Backup window in the Amazon RDS User Guide.\n

\n \n

\n Amazon Aurora\n

\n

Not applicable. The daily time range for creating automated backups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

\n \n

Constraints:

\n " + "smithy.api#documentation": "

\n The daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod parameter. \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.\n

\n \n

\n Amazon Aurora\n

\n

Not applicable. The daily time range for creating automated backups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

\n \n

Constraints:

\n " } }, "PreferredMaintenanceWindow": { @@ -13278,7 +13694,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

This setting doesn't apply to Amazon Aurora. Mapping AWS IAM accounts to database accounts is managed by the DB\n cluster.

\n \n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.

\n \n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" } }, "EnablePerformanceInsights": { @@ -13290,7 +13706,7 @@ "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for encryption of Performance Insights data.

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default CMK. There is a default CMK for your AWS account. \n Your AWS account has a different default CMK for each AWS Region.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default CMK. There is a default CMK for your Amazon Web Services account. \n Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

" } }, "PerformanceInsightsRetentionPeriod": { @@ -13344,13 +13760,13 @@ "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the AWS Outposts User Guide.

" + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } }, "AwsBackupRecoveryPointArn": { "target": "com.amazonaws.rds#AwsBackupRecoveryPointArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in AWS Backup.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

" } } }, @@ -13535,7 +13951,7 @@ "RoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

" } }, "SecurityGroups": { @@ -13659,7 +14075,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

\n

To share a manual DB snapshot with other AWS accounts, specify restore\n as the AttributeName and use the ValuesToAdd parameter to add\n a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot.\n Uses the value all to make the manual DB snapshot public, which means it\n can be copied or restored by all AWS accounts.

\n \n

Don't add the all value for any manual DB snapshots that\n contain private information that you don't want available to all AWS\n accounts.

\n \n

If the manual DB snapshot is encrypted, it can be shared, but only by specifying a\n list of authorized AWS account IDs for the ValuesToAdd parameter. You\n can't use all as a value for that parameter in this case.

\n

To view which AWS accounts have access to copy or restore a manual DB snapshot, or\n whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. The accounts are returned as\n values for the restore attribute.

" + "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

\n

To share a manual DB snapshot with other Amazon Web Services accounts, specify restore\n as the AttributeName and use the ValuesToAdd parameter to add\n a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot.\n Uses the value all to make the manual DB snapshot public, which means it\n can be copied or restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB snapshots that\n contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If the manual DB snapshot is encrypted, it can be shared, but only by specifying a\n list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You\n can't use all as a value for that parameter in this case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or\n whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. The accounts are returned as\n values for the restore attribute.

" } }, "com.amazonaws.rds#ModifyDBSnapshotAttributeMessage": { @@ -13675,20 +14091,20 @@ "AttributeName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB snapshot attribute to modify.

\n

To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBSnapshotAttributes API action.

\n ", + "smithy.api#documentation": "

The name of the DB snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBSnapshotAttributes API action.

\n ", "smithy.api#required": {} } }, "ValuesToAdd": { "target": "com.amazonaws.rds#AttributeValueList", "traits": { - "smithy.api#documentation": "

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account\n IDs, or all to make the manual DB snapshot restorable by \n any AWS account. Do not add the all value for any\n manual DB snapshots that contain private information that you don't want available\n to all AWS accounts.

" + "smithy.api#documentation": "

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB snapshots that contain private information that you don't want available\n to all Amazon Web Services accounts.

" } }, "ValuesToRemove": { "target": "com.amazonaws.rds#AttributeValueList", "traits": { - "smithy.api#documentation": "

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

\n

To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include \n one or more AWS account\n identifiers, or all to remove authorization for any AWS account to copy or\n restore the DB snapshot. If you specify all, an AWS account whose\n account ID is explicitly added to the restore attribute\n can still copy or restore the manual DB snapshot.

" + "smithy.api#documentation": "

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

\n

To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include \n one or more Amazon Web Services account\n identifiers, or all to remove authorization for any Amazon Web Services account to copy or\n restore the DB snapshot. If you specify all, an Amazon Web Services account whose\n account ID is explicitly added to the restore attribute\n can still copy or restore the manual DB snapshot.

" } } }, @@ -13762,7 +14178,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

" + "smithy.api#documentation": "

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

" } }, "com.amazonaws.rds#ModifyDBSubnetGroupMessage": { @@ -14190,6 +14606,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "OptionGroupAlreadyExistsFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The option group you are trying to create already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -14232,6 +14652,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "OptionGroupNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified option group could not be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -14452,7 +14876,11 @@ } }, "traits": { - "smithy.api#documentation": "

The quota of 20 option groups was exceeded for this AWS account.

", + "aws.protocols#awsQueryError": { + "code": "OptionGroupQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The quota of 20 option groups was exceeded for this Amazon Web Services account.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -14775,7 +15203,13 @@ "OutpostCapable": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

Whether a DB instance supports RDS on Outposts.

\n

For more information about RDS on Outposts, see Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Whether a DB instance supports RDS on Outposts.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" + } + }, + "SupportedActivityStreamModes": { + "target": "com.amazonaws.rds#ActivityStreamModeList", + "traits": { + "smithy.api#documentation": "

The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync,\n async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams \n isn't supported, the return value is an empty list.

" } }, "SupportsGlobalDatabases": { @@ -14829,7 +15263,7 @@ } }, "traits": { - "smithy.api#documentation": "

A data type that represents an Outpost.

\n

For more information about RDS on Outposts, see Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

A data type that represents an Outpost.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#Parameter": { @@ -15110,7 +15544,7 @@ "IAMDatabaseAuthenticationEnabled": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

" + "smithy.api#documentation": "

Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" } } }, @@ -15126,6 +15560,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "PointInTimeRestoreNotEnabled", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

\n SourceDBInstanceIdentifier\n refers to a DB instance with\n BackupRetentionPeriod equal to 0.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -15242,7 +15680,7 @@ "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n

\n

\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. \n To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.\n

\n

Constraints:

\n " + "smithy.api#documentation": "

\n The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n

\n

\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.\n

\n

Constraints:

\n " } } }, @@ -15266,6 +15704,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ProvisionedIopsNotAvailableInAZFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Provisioned IOPS not available in the specified Availability Zone.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -15625,7 +16067,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.\n For more information, see Authorizing Amazon Aurora MySQL \n to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n " + "smithy.api#documentation": "

Disassociates an Amazon Web Services Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.\n For more information, see Authorizing Amazon Aurora MySQL \n to Access Other Amazon Web Services Services on Your Behalf in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#RemoveRoleFromDBClusterMessage": { @@ -15670,7 +16112,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.

" + "smithy.api#documentation": "

Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.

" } }, "com.amazonaws.rds#RemoveRoleFromDBInstanceMessage": { @@ -15908,7 +16350,7 @@ "LeaseId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The unique identifier for the lease associated with the reserved DB instance.

\n \n

AWS Support might request the lease ID for an issue related to a reserved DB instance.

\n " + "smithy.api#documentation": "

The unique identifier for the lease associated with the reserved DB instance.

\n \n

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

\n " } } }, @@ -15924,6 +16366,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedDBInstanceAlreadyExists", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

User already has a reservation with the given identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -15966,6 +16412,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedDBInstanceNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified reserved DB Instance not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -15979,6 +16429,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedDBInstanceQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Request would exceed the user's DB Instance quota.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -16089,6 +16543,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedDBInstancesOfferingNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

Specified offering does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -16196,6 +16654,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified resource ID was not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -16371,13 +16833,13 @@ "PreferredBackupWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.\n

\n

Constraints:

\n " + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.\n

\n

Constraints:

\n " } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each AWS Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.\n

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.\n

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" } }, "Tags": { @@ -16392,13 +16854,13 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for an encrypted DB cluster.

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).\n To use a CMK in a different AWS account, specify the key ARN or alias ARN.

\n

If the StorageEncrypted parameter is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS will use your default CMK. There is a \n default CMK for your AWS account. Your AWS account has a different\n default CMK for each AWS Region.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).\n To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If the StorageEncrypted parameter is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS will use your default CMK. There is a \n default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different\n default CMK for each Amazon Web Services Region.

" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

" } }, "SourceEngine": { @@ -16431,7 +16893,7 @@ "S3IngestionRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes\n Amazon RDS to access the Amazon S3 bucket on your behalf.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes\n Amazon RDS to access the Amazon S3 bucket on your behalf.

", "smithy.api#required": {} } }, @@ -16621,13 +17083,13 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).\n To use a CMK in a different AWS account, specify the key ARN or alias ARN.

\n

When you don't specify a value for the KmsKeyId parameter, then the\n following occurs:

\n " + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).\n To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

When you don't specify a value for the KmsKeyId parameter, then the\n following occurs:

\n " } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

" } }, "BacktrackWindow": { @@ -16830,13 +17292,13 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).\n To use a CMK in a different AWS account, specify the key ARN or alias ARN.

\n

You can restore to a new DB cluster and encrypt the new DB cluster with a AWS KMS CMK that is different than the\n AWS KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the AWS KMS CMK\n identified by the KmsKeyId parameter.

\n

If you don't specify a value for the KmsKeyId parameter, then the following occurs:

\n \n\n

If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request\n is rejected.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).\n To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

You can restore to a new DB cluster and encrypt the new DB cluster with a Amazon Web Services KMS CMK that is different than the\n Amazon Web Services KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the Amazon Web Services KMS CMK\n identified by the KmsKeyId parameter.

\n

If you don't specify a value for the KmsKeyId parameter, then the following occurs:

\n \n\n

If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request\n is rejected.

" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.\n

" } }, "BacktrackWindow": { @@ -16880,6 +17342,18 @@ "traits": { "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

" } + }, + "ScalingConfiguration": { + "target": "com.amazonaws.rds#ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine mode of the new cluster. Specify provisioned or serverless,\n depending on the type of the cluster you are creating. You can create an Aurora Serverless clone\n from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone\n that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or\n an encrypted provisioned cluster.

" + } } }, "traits": { @@ -16988,7 +17462,7 @@ "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

Default: The same DBInstanceClass as the original DB instance.

" + "smithy.api#documentation": "

The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

Default: The same DBInstanceClass as the original DB instance.

" } }, "Port": { @@ -17042,7 +17516,7 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database engine to use for the new instance.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

\n\n

Valid Values:

\n \n " + "smithy.api#documentation": "

The database engine to use for the new instance.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

\n\n

Valid Values:

\n \n " } }, "Iops": { @@ -17105,7 +17579,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" } }, "EnableCloudwatchLogsExports": { @@ -17141,7 +17615,7 @@ "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the AWS Outposts User Guide.

" + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } } }, @@ -17247,7 +17721,7 @@ "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the DB instance, \n for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, \n or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.\n

\n

Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.\n

", + "smithy.api#documentation": "

The compute and memory capacity of the DB instance, \n for example, db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, \n or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.\n

\n

Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.\n

", "smithy.api#required": {} } }, @@ -17285,7 +17759,7 @@ "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Availability Zone that the DB instance is created in. \n For information about AWS Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.\n

\n

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.\n

\n

\n Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same AWS Region as the current endpoint.\n

" + "smithy.api#documentation": "

The Availability Zone that the DB instance is created in. \n For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.\n

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.\n

\n

\n Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.\n

" } }, "DBSubnetGroupName": { @@ -17387,7 +17861,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for an encrypted DB instance.\n

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).\n To use a CMK in a different AWS account, specify the key ARN or alias ARN.

\n

If the StorageEncrypted parameter is enabled, \n and you do not specify a value for the KmsKeyId parameter, \n then Amazon RDS will use your default CMK. \n There is a default CMK for your AWS account. \n Your AWS account has a different default CMK for each AWS Region.\n

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB instance.\n

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).\n To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If the StorageEncrypted parameter is enabled, \n and you do not specify a value for the KmsKeyId parameter, \n then Amazon RDS will use your default CMK. \n There is a default CMK for your Amazon Web Services account. \n Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.\n

" } }, "CopyTagsToSnapshot": { @@ -17411,7 +17885,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" } }, "SourceEngine": { @@ -17444,7 +17918,7 @@ "S3IngestionRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket. \n

", + "smithy.api#documentation": "

An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket. \n

", "smithy.api#required": {} } }, @@ -17457,7 +17931,7 @@ "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for encryption of Performance Insights data.

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default CMK. There is a default CMK for your AWS account. \n Your AWS account has a different default CMK for each AWS Region.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default CMK. There is a default CMK for your Amazon Web Services account. \n Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

" } }, "PerformanceInsightsRetentionPeriod": { @@ -17617,7 +18091,7 @@ "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all AWS Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

Default: The same DBInstanceClass as the original DB instance.

" + "smithy.api#documentation": "

The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

Default: The same DBInstanceClass as the original DB instance.

" } }, "Port": { @@ -17671,7 +18145,7 @@ "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The database engine to use for the new instance.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source

\n\n

Valid Values:

\n \n " + "smithy.api#documentation": "

The database engine to use for the new instance.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source

\n\n

Valid Values:

\n \n " } }, "Iops": { @@ -17734,7 +18208,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of AWS Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n \n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" } }, "EnableCloudwatchLogsExports": { @@ -17788,7 +18262,7 @@ "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the AWS Outposts User Guide.

" + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" } } }, @@ -17878,7 +18352,7 @@ "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

\n The AWS account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The AWS access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

" + "smithy.api#documentation": "

\n The Amazon Web Services account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The Amazon Web Services access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

" } } }, @@ -17902,6 +18376,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSInvalidTopic", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

SNS has responded that there is a problem with the SND topic specified.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -17915,6 +18393,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSNoAuthorization", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You do not have permission to publish to the SNS topic ARN.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -17928,6 +18410,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSTopicArnNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The SNS topic ARN does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -18017,6 +18503,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SharedSnapshotQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -18030,6 +18520,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB\n snapshots.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -18052,6 +18546,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SourceNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The requested source could not be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -18063,30 +18561,30 @@ "RegionName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the source AWS Region.

" + "smithy.api#documentation": "

The name of the source Amazon Web Services Region.

" } }, "Endpoint": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The endpoint for the source AWS Region endpoint.

" + "smithy.api#documentation": "

The endpoint for the source Amazon Web Services Region endpoint.

" } }, "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The status of the source AWS Region.

" + "smithy.api#documentation": "

The status of the source Amazon Web Services Region.

" } }, "SupportsDBInstanceAutomatedBackupsReplication": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

Whether the source AWS Region supports replicating automated backups to the current AWS Region.

" + "smithy.api#documentation": "

Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.

" } } }, "traits": { - "smithy.api#documentation": "

Contains an AWS Region name as the result of a successful call to the DescribeSourceRegions action.

" + "smithy.api#documentation": "

Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.

" } }, "com.amazonaws.rds#SourceRegionList": { @@ -18110,7 +18608,7 @@ "SourceRegions": { "target": "com.amazonaws.rds#SourceRegionList", "traits": { - "smithy.api#documentation": "

A list of SourceRegion instances that contains each source AWS Region that the\n current AWS Region can get a read replica or a DB snapshot from.

" + "smithy.api#documentation": "

A list of SourceRegion instances that contains each source Amazon Web Services Region that the\n current Amazon Web Services Region can get a read replica or a DB snapshot from.

" } } }, @@ -18201,7 +18699,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for encrypting messages in the database activity stream.\n The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

", + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream.\n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

", "smithy.api#required": {} } }, @@ -18210,6 +18708,12 @@ "traits": { "smithy.api#documentation": "

Specifies whether or not the database activity stream is to start as soon as possible, \n regardless of the maintenance window for the database.

" } + }, + "EngineNativeAuditFieldsIncluded": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the database activity stream includes engine-native audit fields. This option only applies\n to an Oracle DB instance. By default, no engine-native audit fields are included.

" + } } } }, @@ -18219,7 +18723,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for encryption of messages in the database activity stream.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

" } }, "KinesisStreamName": { @@ -18245,6 +18749,12 @@ "traits": { "smithy.api#documentation": "

Indicates whether or not the database activity stream will start as soon as possible, \n regardless of the maintenance window for the database.

" } + }, + "EngineNativeAuditFieldsIncluded": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" + } } } }, @@ -18268,7 +18778,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster\n AWS CLI command, or the StopDBCluster action.

\n \n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.\n

\n \n

This action only applies to Aurora DB clusters.

\n " + "smithy.api#documentation": "

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster\n CLI command, or the StopDBCluster action.

\n \n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.\n

\n \n

This action only applies to Aurora DB clusters.

\n " } }, "com.amazonaws.rds#StartDBClusterMessage": { @@ -18335,7 +18845,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action.\n

\n \n

For more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n

\n \n \n

\n This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.\n

\n " + "smithy.api#documentation": "

\n Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.\n

\n \n

For more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n

\n \n \n

\n This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.\n

\n " } }, "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplication": { @@ -18364,7 +18874,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables replication of automated backups to a different AWS Region.

\n

For more information, see \n Replicating Automated Backups to Another AWS Region in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Enables replication of automated backups to a different Amazon Web Services Region.

\n

For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationMessage": { @@ -18386,13 +18896,13 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the\n Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS Region, for example, \n arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the\n Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, \n arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.

" } }, "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication action to be \n called in the AWS Region of the source DB instance. The presigned URL must be a valid request for the\n StartDBInstanceAutomatedBackupsReplication API action that can be executed in the AWS Region that contains\n the source DB instance.

" + "smithy.api#documentation": "

A URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication action to be \n called in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the\n StartDBInstanceAutomatedBackupsReplication API action that can be executed in the Amazon Web Services Region that contains\n the source DB instance.

" } } } @@ -18500,7 +19010,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The ID of the AWS KMS customer master key (CMK) to use to encrypt the snapshot exported to Amazon S3. The AWS KMS \n key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). \n The caller of this operation must be authorized to \n execute the following operations. These can be set in the AWS KMS key policy:

\n ", + "smithy.api#documentation": "

The ID of the Amazon Web Services KMS customer master key (CMK) to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS \n key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). \n The caller of this operation must be authorized to \n execute the following operations. These can be set in the Amazon Web Services KMS key policy:

\n ", "smithy.api#required": {} } }, @@ -18544,7 +19054,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops a database activity stream that was started using the AWS console, \n the start-activity-stream AWS CLI command, or the StartActivityStream action.

\n

For more information, see \n Database Activity Streams\n in the Amazon Aurora User Guide.

" + "smithy.api#documentation": "

Stops a database activity stream that was started using the Amazon Web Services console, \n the start-activity-stream CLI command, or the StartActivityStream action.

\n

For more information, see \n Database Activity Streams\n in the Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#StopActivityStreamRequest": { @@ -18571,7 +19081,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The AWS KMS key identifier used for encrypting messages in the database activity stream.

\n

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

" + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

" } }, "KinesisStreamName": { @@ -18677,7 +19187,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops automated backup replication for a DB instance.

\n

For more information, see \n Replicating Automated Backups to Another AWS Region in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Stops automated backup replication for a DB instance.

\n

For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage": { @@ -18734,6 +19244,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "StorageQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request would result in the user exceeding the allowed amount of storage\n available across all DB instances.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -18747,6 +19261,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "StorageTypeNotSupported", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Storage of the StorageType specified can't be associated\n with the DB instance.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -18782,7 +19300,7 @@ "SubnetOutpost": { "target": "com.amazonaws.rds#Outpost", "traits": { - "smithy.api#documentation": "

If the subnet is associated with an Outpost, this value specifies the Outpost.

\n

For more information about RDS on Outposts, see Amazon RDS on AWS Outposts \n in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

If the subnet is associated with an Outpost, this value specifies the Outpost.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" } }, "SubnetStatus": { @@ -18804,6 +19322,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetAlreadyInUse", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The DB subnet is already in use in the Availability Zone.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -18835,6 +19357,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionAlreadyExist", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The supplied subscription name already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -18848,6 +19374,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionCategoryNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The supplied category does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -18861,6 +19391,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The subscription name does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -18893,13 +19427,13 @@ "Key": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").

" + "smithy.api#documentation": "

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").

" } }, "Value": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").

" + "smithy.api#documentation": "

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").

" } } }, @@ -19155,7 +19689,7 @@ "IAMAuth": { "target": "com.amazonaws.rds#IAMAuthMode", "traits": { - "smithy.api#documentation": "

Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.

" + "smithy.api#documentation": "

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.

" } } }, @@ -19193,7 +19727,7 @@ "IAMAuth": { "target": "com.amazonaws.rds#IAMAuthMode", "traits": { - "smithy.api#documentation": "

Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.

" + "smithy.api#documentation": "

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.

" } } }, @@ -19345,7 +19879,7 @@ "VpnGatewayIp": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The IP address of network traffic from AWS to your on-premises data center.

" + "smithy.api#documentation": "

The IP address of network traffic from Amazon Web Services to your on-premises data center.

" } }, "VpnPSK": { @@ -19368,7 +19902,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

" + "smithy.api#documentation": "

Information about the virtual private network (VPN) between the VMware vSphere cluster and the Amazon Web Services website.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

" } }, "com.amazonaws.rds#WriteForwardingStatus": { diff --git a/aws/sdk/aws-models/redshift-data.json b/aws/sdk/aws-models/redshift-data.json index 60f4251c4..9b4600e23 100644 --- a/aws/sdk/aws-models/redshift-data.json +++ b/aws/sdk/aws-models/redshift-data.json @@ -317,6 +317,12 @@ "traits": { "smithy.api#documentation": "

A value that indicates whether the statement has a result set. The result set can be empty.

" } + }, + "QueryParameters": { + "target": "com.amazonaws.redshiftdata#SqlParametersList", + "traits": { + "smithy.api#documentation": "

The parameters for the SQL statement.

" + } } } }, @@ -524,6 +530,12 @@ "traits": { "smithy.api#documentation": "

The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

" } + }, + "Parameters": { + "target": "com.amazonaws.redshiftdata#SqlParametersList", + "traits": { + "smithy.api#documentation": "

The parameters for the SQL statement.

" + } } } }, @@ -1109,6 +1121,20 @@ } } }, + "com.amazonaws.redshiftdata#ParameterName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-zA-Z_]+$" + } + }, + "com.amazonaws.redshiftdata#ParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.redshiftdata#RedshiftData": { "type": "service", "version": "2019-12-20", @@ -1191,6 +1217,39 @@ "com.amazonaws.redshiftdata#SecretArn": { "type": "string" }, + "com.amazonaws.redshiftdata#SqlParameter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.redshiftdata#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the parameter.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.redshiftdata#ParameterValue", + "traits": { + "smithy.api#documentation": "

The value of the parameter. \n Amazon Redshift implicitly converts to the proper data type. For more inforation, see \n Data types in the \n Amazon Redshift Database Developer Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A parameter used in a SQL statement.

" + } + }, + "com.amazonaws.redshiftdata#SqlParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftdata#SqlParameter" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.redshiftdata#SqlRecords": { "type": "list", "member": { @@ -1242,6 +1301,12 @@ "traits": { "smithy.api#documentation": "

The date and time (UTC) that the statement metadata was last updated.

" } + }, + "QueryParameters": { + "target": "com.amazonaws.redshiftdata#SqlParametersList", + "traits": { + "smithy.api#documentation": "

The parameters used in a SQL statement.

" + } } }, "traits": { @@ -1358,4 +1423,4 @@ "type": "boolean" } } -} +} \ No newline at end of file diff --git a/aws/sdk/aws-models/redshift.json b/aws/sdk/aws-models/redshift.json index afd4f1fe9..75a02b129 100644 --- a/aws/sdk/aws-models/redshift.json +++ b/aws/sdk/aws-models/redshift.json @@ -102,6 +102,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "AccessToClusterDenied", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You are not authorized to access the cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -115,6 +119,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "AccessToSnapshotDenied", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The owner of the specified snapshot has not authorized your account to access the\n snapshot.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -338,6 +346,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified CIDR block or EC2 security group is already authorized for the\n specified cluster security group.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -351,6 +363,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified CIDR IP range or EC2 security group is not authorized for the\n specified cluster security group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -364,6 +380,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The authorization quota for the cluster security group has been reached.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -658,6 +678,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "BatchDeleteRequestSizeExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The maximum number for a batch delete of snapshots has been reached. The limit is\n 100.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -691,6 +715,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "BatchModifyClusterSnapshotsLimitExceededFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The maximum number for snapshot identifiers has been reached. The limit is 100.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -772,6 +800,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "BucketNotFoundFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Could not find the specified S3 bucket.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1131,6 +1163,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The account already has a cluster with the given identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1318,6 +1354,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The ClusterIdentifier parameter does not refer to an existing cluster.\n

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -1331,6 +1371,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterOnLatestRevision", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Cluster is already on the latest database revision.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1376,6 +1420,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterParameterGroupAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

A cluster parameter group with the same name already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1429,6 +1477,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterParameterGroupNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The parameter group name does not refer to an existing parameter group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -1442,6 +1494,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterParameterGroupQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of cluster\n parameter groups. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Cluster Management Guide.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1542,6 +1598,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request would exceed the allowed number of cluster instances for this account.\n \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Cluster Management Guide.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1593,6 +1653,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterSecurityGroupAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

A cluster security group with the same name already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1664,6 +1728,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterSecurityGroupNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The cluster security group name does not refer to an existing cluster security\n group.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -1677,6 +1745,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "QuotaExceeded.ClusterSecurityGroup", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of cluster\n security groups. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Cluster Management Guide.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1699,6 +1771,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterSnapshotAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The value specified as a snapshot identifier is already used by an existing\n snapshot.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1744,6 +1820,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterSnapshotNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The snapshot identifier does not refer to an existing cluster snapshot.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -1757,6 +1837,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterSnapshotQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of cluster\n snapshots.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1814,6 +1898,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterSubnetGroupAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

A ClusterSubnetGroupName is already used by an existing\n cluster subnet group.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1847,6 +1935,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterSubnetGroupNotFoundFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The cluster subnet group name does not refer to an existing cluster subnet\n group.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1860,6 +1952,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterSubnetGroupQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request would result in user exceeding the allowed number of cluster subnet\n groups. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Cluster Management Guide.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1882,6 +1978,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterSubnetQuotaExceededFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request would result in user exceeding the allowed number of subnets in a\n cluster subnet groups. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Cluster Management Guide.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2041,6 +2141,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "CopyToRegionDisabledFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Cross-region snapshot copy was temporarily disabled. Try your request\n again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -4010,6 +4114,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DependentServiceRequestThrottlingFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request cannot be completed because a dependent service is throttling requests\n made by Amazon Redshift on your behalf. Wait and retry the request.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -4023,6 +4131,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DependentServiceUnavailableFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Your request cannot be completed because a dependent internal service is\n temporarily unavailable. Wait 30 to 60 seconds and try again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -5961,6 +6073,9 @@ "errors": [ { "target": "com.amazonaws.redshift#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#InvalidClusterStateFault" } ], "traits": { @@ -6387,6 +6502,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "EndpointAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The account already has a Redshift-managed VPC endpoint with the given identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -6462,6 +6581,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "EndpointAuthorizationAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The authorization already exists for this endpoint.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -6492,6 +6615,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "EndpointAuthorizationNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The authorization for this endpoint can't be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -6511,6 +6638,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "EndpointAuthorizationsPerClusterLimitExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The number of endpoint authorizations per cluster has exceeded its limit.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -6524,6 +6655,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "EndpointNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The endpoint name doesn't refer to an existing endpoint.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -6537,6 +6672,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "EndpointsPerAuthorizationLimitExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The number of Redshift-managed VPC endpoints per authorization has exceeded its limit.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -6550,6 +6689,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "EndpointsPerClusterLimitExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The number of Redshift-managed VPC endpoints per cluster has exceeded its limit.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -6789,6 +6932,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "EventSubscriptionQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request would exceed the allowed number of event subscriptions for this\n account. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Cluster Management Guide.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7028,6 +7175,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "HsmClientCertificateAlreadyExistsFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

There is already an existing Amazon Redshift HSM client certificate with the specified\n identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7070,6 +7221,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "HsmClientCertificateNotFoundFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

There is no Amazon Redshift HSM client certificate with the specified\n identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7083,6 +7238,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "HsmClientCertificateQuotaExceededFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The quota for HSM client certificates has been reached. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Cluster Management Guide.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7134,6 +7293,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "HsmConfigurationAlreadyExistsFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

There is already an existing Amazon Redshift HSM configuration with the specified\n identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7176,6 +7339,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "HsmConfigurationNotFoundFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

There is no Amazon Redshift HSM configuration with the specified identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7189,6 +7356,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "HsmConfigurationQuotaExceededFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The quota for HSM configurations has been reached. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Cluster Management Guide.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7290,6 +7461,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InProgressTableRestoreQuotaExceededFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You have exceeded the allowed number of table restore requests. Wait for your\n current table restore requests to complete before making a new request.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7303,6 +7478,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "IncompatibleOrderableOptions", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified options are incompatible.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7316,6 +7495,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientClusterCapacity", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The number of nodes specified exceeds the allotted capacity of the\n cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7329,6 +7512,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientS3BucketPolicyFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The cluster does not have read bucket or put object permissions on the S3 bucket\n specified when enabling logging.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7351,6 +7538,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidAuthorizationState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The status of the authorization is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7364,6 +7555,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidClusterParameterGroupState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The cluster parameter group action can not be completed because another task is in\n progress that involves the parameter group. Wait a few moments and try the operation\n again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7377,6 +7572,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidClusterSecurityGroupState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The state of the cluster security group is not available.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7390,6 +7589,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidClusterSnapshotScheduleState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The cluster snapshot schedule state is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7403,6 +7606,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidClusterSnapshotState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified cluster snapshot is not in the available state, or other\n accounts are authorized to access the snapshot.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7416,6 +7623,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidClusterState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified cluster is not in the available state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7429,6 +7640,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidClusterSubnetGroupStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The cluster subnet group cannot be deleted because it is in use.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7442,6 +7657,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidClusterSubnetStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The state of the subnet is invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7455,6 +7674,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidClusterTrack", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The provided cluster track name is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7468,6 +7691,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidElasticIpFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The Elastic IP (EIP) is invalid or cannot be found.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7481,6 +7708,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidEndpointState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The status of the endpoint is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7494,6 +7725,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidHsmClientCertificateStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified HSM client certificate is not in the available state, or\n it is still in use by one or more Amazon Redshift clusters.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7507,6 +7742,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidHsmConfigurationStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified HSM configuration is not in the available state, or it\n is still in use by one or more Amazon Redshift clusters.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7520,6 +7759,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidReservedNodeState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Indicates that the Reserved Node being exchanged is not in an active state.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7533,6 +7776,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidRestore", + "httpResponseCode": 406 + }, "smithy.api#documentation": "

The restore is invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 406 @@ -7546,6 +7793,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidRetentionPeriodFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The retention period specified is either in the past or is not a valid value.

\n

The value must be either -1 or an integer between 1 and 3,653.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7559,6 +7810,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidS3BucketNameFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The S3 bucket name is invalid. For more information about naming rules, go to\n Bucket\n Restrictions and Limitations in the Amazon Simple Storage Service (S3)\n Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7572,6 +7827,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidS3KeyPrefixFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The string specified for the logging S3 key prefix does not comply with the\n documented constraints.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7585,6 +7844,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSchedule", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The schedule you submitted isn't valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7598,6 +7861,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidScheduledAction", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The scheduled action is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7611,6 +7878,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSnapshotCopyGrantStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The snapshot copy grant can't be deleted because it is used by one or more\n clusters.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7624,6 +7895,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSubnet", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The requested subnet is not valid, or not all of the subnets are in the same\n VPC.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7637,6 +7912,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSubscriptionStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The subscription request is invalid because it is a duplicate request. This\n subscription request is already in progress.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7650,6 +7929,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidTableRestoreArgument", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The value specified for the sourceDatabaseName,\n sourceSchemaName, or sourceTableName parameter, or a\n combination of these, doesn't exist in the snapshot.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7663,6 +7946,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidTagFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The tag is invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7676,6 +7963,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidUsageLimit", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The usage limit is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7689,6 +7980,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidVPCNetworkStateFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The cluster subnet group does not cover all Availability Zones.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -7702,6 +7997,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "LimitExceededFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The encryption key has exceeded its grant limit in AWS KMS.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -9028,6 +9327,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "NumberOfNodesPerClusterLimitExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The operation would exceed the number of nodes allowed for a cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -9041,6 +9344,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "NumberOfNodesQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The operation would exceed the number of nodes allotted to the account.\n \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Cluster Management Guide.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -9421,6 +9728,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "PartnerNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The name of the partner was not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -10106,6 +10417,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedNodeAlreadyExists", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

User already has a reservation with the given identifier.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -10119,6 +10434,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedNodeAlreadyMigrated", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Indicates that the reserved node has already been exchanged.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -10141,6 +10460,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedNodeNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified reserved compute node not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -10225,6 +10548,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedNodeOfferingNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

Specified offering does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -10273,6 +10600,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedNodeQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Request would exceed the user's compute node quota. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Cluster Management Guide.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -10461,6 +10792,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ResizeNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

A resize operation for the specified cluster is not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -10578,6 +10913,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFoundFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The resource could not be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -11343,6 +11682,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSInvalidTopic", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Amazon SNS has responded that there is a problem with the specified Amazon SNS\n topic.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -11356,6 +11699,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSNoAuthorization", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You do not have permission to publish to the specified Amazon SNS topic.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -11369,6 +11716,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSTopicArnNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not\n exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -11391,6 +11742,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ScheduleDefinitionTypeUnsupported", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The definition you submitted is not supported.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -11485,6 +11840,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ScheduledActionAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The scheduled action already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -11553,6 +11912,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ScheduledActionNotFound", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The scheduled action cannot be found.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -11566,6 +11929,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ScheduledActionQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The quota for scheduled actions exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -11629,6 +11996,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ScheduledActionTypeUnsupported", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The action type specified for a scheduled action is not supported.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -11924,6 +12295,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotCopyAlreadyDisabledFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The cluster already has cross-region snapshot copy disabled.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -11937,6 +12312,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotCopyAlreadyEnabledFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The cluster already has cross-region snapshot copy enabled.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -11950,6 +12329,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotCopyDisabledFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Cross-region snapshot copy was temporarily disabled. Try your request\n again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -11989,6 +12372,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotCopyGrantAlreadyExistsFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The snapshot copy grant can't be created because a grant with the same name already\n exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12031,6 +12418,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotCopyGrantNotFoundFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified snapshot copy grant can't be found. Make sure that the name is typed\n correctly and that the grant exists in the destination region.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12044,6 +12435,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotCopyGrantQuotaExceededFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The AWS account has exceeded the maximum number of snapshot copy grants in this\n region.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12177,6 +12572,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotScheduleAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified snapshot schedule already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12199,6 +12598,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotScheduleNotFound", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

We could not find the specified snapshot schedule.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12212,6 +12615,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotScheduleQuotaExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You have exceeded the quota of snapshot schedules.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12225,6 +12632,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotScheduleUpdateInProgress", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified snapshot schedule is already being updated.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12292,6 +12703,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SourceNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified Amazon Redshift event source could not be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -12367,6 +12782,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetAlreadyInUse", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

A specified subnet is already in use by another cluster.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12398,6 +12817,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionAlreadyExist", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

There is already an existing event notification subscription with the specified\n name.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12411,6 +12834,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionCategoryNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The value specified for the event category was not one of the allowed values, or it\n specified a category that does not apply to the specified source type. The allowed\n values are Configuration, Management, Monitoring, and Security.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -12424,6 +12851,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionEventIdNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

An Amazon Redshift event with the specified event ID does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -12437,6 +12868,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

An Amazon Redshift event notification subscription with the specified name does not\n exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -12450,6 +12885,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionSeverityNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The value specified for the event severity was not one of the allowed values, or it\n specified a severity that does not apply to the specified source type. The allowed\n values are ERROR and INFO.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -12512,6 +12951,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "TableLimitExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The number of tables in the cluster exceeds the limit for the requested new cluster\n node type.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12525,6 +12968,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "TableRestoreNotFoundFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified TableRestoreRequestId value was not found.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12715,6 +13162,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "TagLimitExceededFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You have exceeded the number of tags allowed.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12827,6 +13278,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "UnauthorizedOperation", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Your account is not authorized to perform the requested operation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12840,6 +13295,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "UnauthorizedPartnerIntegration", + "httpResponseCode": 401 + }, "smithy.api#documentation": "

The partner integration is not authorized.

", "smithy.api#error": "client", "smithy.api#httpError": 401 @@ -12853,6 +13312,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "UnknownSnapshotCopyRegionFault", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The specified region is incorrect or does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -12866,6 +13329,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "UnsupportedOperation", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The requested operation isn't supported.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -12879,6 +13346,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "UnsupportedOptionFault", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

A request option was specified that is not supported.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -13043,6 +13514,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "UsageLimitAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The usage limit already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -13122,6 +13597,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "UsageLimitNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The usage limit identifier can't be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 diff --git a/aws/sdk/aws-models/route53.json b/aws/sdk/aws-models/route53.json index 48528b07b..bc57aec1d 100644 --- a/aws/sdk/aws-models/route53.json +++ b/aws/sdk/aws-models/route53.json @@ -3104,6 +3104,23 @@ "method": "GET", "uri": "/2013-04-01/change/{Id}", "code": 200 + }, + "smithy.waiters#waitable": { + "ResourceRecordSetsChanged": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ChangeInfo.Status", + "expected": "INSYNC", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + } } } }, diff --git a/aws/sdk/aws-models/runtime.lex.v2.json b/aws/sdk/aws-models/runtime.lex.v2.json index af1c77e48..1446c79f6 100644 --- a/aws/sdk/aws-models/runtime.lex.v2.json +++ b/aws/sdk/aws-models/runtime.lex.v2.json @@ -104,12 +104,13 @@ "contextAttributes": { "target": "com.amazonaws.lexruntimev2#ActiveContextParametersMap", "traits": { - "smithy.api#documentation": "

A lis tof contexts active for the request. A context can be\n activated when a previous intent is fulfilled, or by including the\n context in the request.

\n

If you don't specify a list of contexts, Amazon Lex will use the\n current list of contexts for the session. If you specify an empty list,\n all contexts for the session are cleared.

" + "smithy.api#documentation": "

A lis tof contexts active for the request. A context can be\n activated when a previous intent is fulfilled, or by including the\n context in the request.

\n

If you don't specify a list of contexts, Amazon Lex will use the\n current list of contexts for the session. If you specify an empty list,\n all contexts for the session are cleared.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Contains information about the contexts that a user is using in a\n session. You can configure Amazon Lex to set a context when an intent is\n fulfilled, or you can set a context using the , , or operations.

\n

Use a context to indicate to Amazon Lex intents that should be used as\n follow-up intents. For example, if the active context is\n order-fulfilled, only intents that have\n order-fulfilled configured as a trigger are considered\n for follow up.

" + "smithy.api#documentation": "

Contains information about the contexts that a user is using in a\n session. You can configure Amazon Lex V2 to set a context when an intent is\n fulfilled, or you can set a context using the , , or operations.

\n

Use a context to indicate to Amazon Lex V2 intents that should be used as\n follow-up intents. For example, if the active context is\n order-fulfilled, only intents that have\n order-fulfilled configured as a trigger are considered\n for follow up.

" } }, "com.amazonaws.lexruntimev2#ActiveContextName": { @@ -237,12 +238,12 @@ "clientTimestampMillis": { "target": "com.amazonaws.lexruntimev2#EpochMillis", "traits": { - "smithy.api#documentation": "

A timestamp set by the client of the date and time that the event\n was sent to Amazon Lex.

" + "smithy.api#documentation": "

A timestamp set by the client of the date and time that the event\n was sent to Amazon Lex V2.

" } } }, "traits": { - "smithy.api#documentation": "

Represents a chunk of audio sent from the client application to\n Amazon Lex. The audio is all or part of an utterance from the user.

\n

Amazon Lex accumulates audio chunks until it recognizes a natural pause\n in speech before processing the input.

" + "smithy.api#documentation": "

Represents a chunk of audio sent from the client application to\n Amazon Lex V2. The audio is all or part of an utterance from the user.

\n

Amazon Lex V2 accumulates audio chunks until it recognizes a natural pause\n in speech before processing the input.

" } }, "com.amazonaws.lexruntimev2#AudioResponseEvent": { @@ -263,12 +264,12 @@ "eventId": { "target": "com.amazonaws.lexruntimev2#EventId", "traits": { - "smithy.api#documentation": "

A unique identifier of the event sent by Amazon Lex. The identifier is in\n the form RESPONSE-N, where N is a number starting with one\n and incremented for each event sent by Amazon Lex in the current\n session.

" + "smithy.api#documentation": "

A unique identifier of the event sent by Amazon Lex V2. The identifier is in\n the form RESPONSE-N, where N is a number starting with one\n and incremented for each event sent by Amazon Lex V2 in the current\n session.

" } } }, "traits": { - "smithy.api#documentation": "

An event sent from Amazon Lex to your client application containing audio\n to play to the user.

" + "smithy.api#documentation": "

An event sent from Amazon Lex V2 to your client application containing audio\n to play to the user.

" } }, "com.amazonaws.lexruntimev2#BadGatewayException": { @@ -322,7 +323,7 @@ "value": { "target": "com.amazonaws.lexruntimev2#ButtonValue", "traits": { - "smithy.api#documentation": "

The value returned to Amazon Lex when a user chooses the button.

", + "smithy.api#documentation": "

The value returned to Amazon Lex V2 when a user chooses the button.

", "smithy.api#required": {} } } @@ -367,12 +368,12 @@ "score": { "target": "com.amazonaws.lexruntimev2#Double", "traits": { - "smithy.api#documentation": "

A score that indicates how confident Amazon Lex is that an intent\n satisfies the user's intent. Ranges between 0.00 and 1.00. Higher\n scores indicate higher confidence.

" + "smithy.api#documentation": "

A score that indicates how confident Amazon Lex V2 is that an intent\n satisfies the user's intent. Ranges between 0.00 and 1.00. Higher\n scores indicate higher confidence.

" } } }, "traits": { - "smithy.api#documentation": "

Provides a score that indicates the confidence that Amazon Lex has that\n an intent is the one that satisfies the user's intent.

" + "smithy.api#documentation": "

Provides a score that indicates the confidence that Amazon Lex V2 has that\n an intent is the one that satisfies the user's intent.

" } }, "com.amazonaws.lexruntimev2#ConfigurationEvent": { @@ -381,13 +382,13 @@ "requestAttributes": { "target": "com.amazonaws.lexruntimev2#StringMap", "traits": { - "smithy.api#documentation": "

Request-specific information passed between the client application\n and Amazon Lex.

\n

The namespace x-amz-lex: is reserved for special\n attributes. Don't create any request attributes for prefix\n x-amz-lex:.

" + "smithy.api#documentation": "

Request-specific information passed between the client application\n and Amazon Lex V2.

\n

The namespace x-amz-lex: is reserved for special\n attributes. Don't create any request attributes for prefix\n x-amz-lex:.

" } }, "responseContentType": { "target": "com.amazonaws.lexruntimev2#NonEmptyString", "traits": { - "smithy.api#documentation": "

The message that Amazon Lex returns in the response can be either text or\n speech based on the responseContentType value.

\n ", + "smithy.api#documentation": "

The message that Amazon Lex V2 returns in the response can be either text or\n speech based on the responseContentType value.

\n ", "smithy.api#required": {} } }, @@ -403,7 +404,7 @@ "disablePlayback": { "target": "com.amazonaws.lexruntimev2#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether Amazon Lex should send audio responses to the\n client application. When this parameter if false,\n the client application needs to create responses for the user.\n \n

" + "smithy.api#documentation": "

Determines whether Amazon Lex V2 should send audio responses to the client\n application. When this parameter if false, the client\n application needs to create responses for the user. \n

" } }, "eventId": { @@ -415,12 +416,12 @@ "clientTimestampMillis": { "target": "com.amazonaws.lexruntimev2#EpochMillis", "traits": { - "smithy.api#documentation": "

A timestamp set by the client of the date and time that the event\n was sent to Amazon Lex.

" + "smithy.api#documentation": "

A timestamp set by the client of the date and time that the event\n was sent to Amazon Lex V2.

" } } }, "traits": { - "smithy.api#documentation": "

The initial event sent from the application to Amazon Lex to configure\n the conversation, including session and request attributes and the\n response content type.

" + "smithy.api#documentation": "

The initial event sent from the application to Amazon Lex V2 to configure\n the conversation, including session and request attributes and the\n response content type.

" } }, "com.amazonaws.lexruntimev2#ConfirmationState": { @@ -492,12 +493,12 @@ "clientTimestampMillis": { "target": "com.amazonaws.lexruntimev2#EpochMillis", "traits": { - "smithy.api#documentation": "

A timestamp set by the client of the date and time that the event\n was sent to Amazon Lex.

" + "smithy.api#documentation": "

A timestamp set by the client of the date and time that the event\n was sent to Amazon Lex V2.

" } } }, "traits": { - "smithy.api#documentation": "

A DTMF character sent from the client application. DTMF characters\n are typically sent from a phone keypad to represent numbers. For\n example, you can have Amazon Lex process a credit card number input from a\n phone.

" + "smithy.api#documentation": "

A DTMF character sent from the client application. DTMF characters\n are typically sent from a phone keypad to represent numbers. For\n example, you can have Amazon Lex V2 process a credit card number input from a\n phone.

" } }, "com.amazonaws.lexruntimev2#DTMFRegex": { @@ -636,7 +637,7 @@ "type": { "target": "com.amazonaws.lexruntimev2#DialogActionType", "traits": { - "smithy.api#documentation": "

The next action that the bot should take in its interaction with the\n user. The possible values are:

\n ", + "smithy.api#documentation": "

The next action that the bot should take in its interaction with the\n user. The possible values are:

\n ", "smithy.api#required": {} } }, @@ -648,7 +649,7 @@ } }, "traits": { - "smithy.api#documentation": "

The next action that Amazon Lex should take.

" + "smithy.api#documentation": "

The next action that Amazon Lex V2 should take.

" } }, "com.amazonaws.lexruntimev2#DialogActionType": { @@ -690,12 +691,12 @@ "clientTimestampMillis": { "target": "com.amazonaws.lexruntimev2#EpochMillis", "traits": { - "smithy.api#documentation": "

A timestamp set by the client of the date and time that the event\n was sent to Amazon Lex.

" + "smithy.api#documentation": "

A timestamp set by the client of the date and time that the event\n was sent to Amazon Lex V2.

" } } }, "traits": { - "smithy.api#documentation": "

A notification from the client that it is disconnecting from Amazon Lex.\n Sending a DisconnectionEvent event is optional, but can\n help identify a conversation in logs.

" + "smithy.api#documentation": "

A notification from the client that it is disconnecting from Amazon Lex V2.\n Sending a DisconnectionEvent event is optional, but can\n help identify a conversation in logs.

" } }, "com.amazonaws.lexruntimev2#Double": { @@ -711,7 +712,7 @@ "min": 2, "max": 100 }, - "smithy.api#pattern": "[0-9a-zA-Z._:-]+" + "smithy.api#pattern": "^[0-9a-zA-Z._:-]+$" } }, "com.amazonaws.lexruntimev2#GetSession": { @@ -740,7 +741,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns session information for a specified bot, alias, and\n user.

\n

For example, you can use this operation to retrieve session\n information for a user that has left a long-running session in\n use.

\n

If the bot, alias, or session identifier doesn't exist, Amazon Lex\n returns a BadRequestException. If the locale doesn't exist\n or is not enabled for the alias, you receive a\n BadRequestException.

", + "smithy.api#documentation": "

Returns session information for a specified bot, alias, and\n user.

\n

For example, you can use this operation to retrieve session\n information for a user that has left a long-running session in\n use.

\n

If the bot, alias, or session identifier doesn't exist, Amazon Lex V2\n returns a BadRequestException. If the locale doesn't exist\n or is not enabled for the alias, you receive a\n BadRequestException.

", "smithy.api#http": { "method": "GET", "uri": "/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}", @@ -803,7 +804,7 @@ "interpretations": { "target": "com.amazonaws.lexruntimev2#Interpretations", "traits": { - "smithy.api#documentation": "

A list of intents that Amazon Lex determined might satisfy the user's\n utterance.

\n

Each interpretation includes the intent, a score that indicates how\n confident Amazon Lex is that the interpretation is the correct one, and an\n optional sentiment response that indicates the sentiment expressed in\n the utterance.

" + "smithy.api#documentation": "

A list of intents that Amazon Lex V2 determined might satisfy the user's\n utterance.

\n

Each interpretation includes the intent, a score that indicates how\n confident Amazon Lex V2 is that the interpretation is the correct one, and an\n optional sentiment response that indicates the sentiment expressed in\n the utterance.

" } }, "sessionState": { @@ -820,12 +821,12 @@ "eventId": { "target": "com.amazonaws.lexruntimev2#EventId", "traits": { - "smithy.api#documentation": "

A unique identifier of the event sent by Amazon Lex. The identifier is in\n the form RESPONSE-N, where N is a number starting with one\n and incremented for each event sent by Amazon Lex in the current\n session.

" + "smithy.api#documentation": "

A unique identifier of the event sent by Amazon Lex V2. The identifier is in\n the form RESPONSE-N, where N is a number starting with one\n and incremented for each event sent by Amazon Lex V2 in the current\n session.

" } } }, "traits": { - "smithy.api#documentation": "

Event that Amazon Lex sends to indicate that the stream is still open\n between the client application and Amazon Lex

" + "smithy.api#documentation": "

Event that Amazon Lex V2 sends to indicate that the stream is still open\n between the client application and Amazon Lex V2

" } }, "com.amazonaws.lexruntimev2#ImageResponseCard": { @@ -910,7 +911,7 @@ } }, "traits": { - "smithy.api#documentation": "

The current intent that Amazon Lex is attempting to fulfill.

" + "smithy.api#documentation": "

The current intent that Amazon Lex V2 is attempting to fulfill.

" } }, "com.amazonaws.lexruntimev2#IntentResultEvent": { @@ -919,13 +920,13 @@ "inputMode": { "target": "com.amazonaws.lexruntimev2#InputMode", "traits": { - "smithy.api#documentation": "

Indicates whether the input to the operation was text or speech.

" + "smithy.api#documentation": "

Indicates whether the input to the operation was text or\n speech.

" } }, "interpretations": { "target": "com.amazonaws.lexruntimev2#Interpretations", "traits": { - "smithy.api#documentation": "

A list of intents that Amazon Lex determined might satisfy the user's\n utterance.

\n\n

Each interpretation includes the intent, a score that indicates how\n confident Amazon Lex is that the interpretation is the correct one, and an\n optional sentiment response that indicates the sentiment expressed in\n the utterance.

" + "smithy.api#documentation": "

A list of intents that Amazon Lex V2 determined might satisfy the user's\n utterance.

\n\n

Each interpretation includes the intent, a score that indicates how\n confident Amazon Lex V2 is that the interpretation is the correct one, and an\n optional sentiment response that indicates the sentiment expressed in\n the utterance.

" } }, "sessionState": { @@ -946,12 +947,12 @@ "eventId": { "target": "com.amazonaws.lexruntimev2#EventId", "traits": { - "smithy.api#documentation": "

A unique identifier of the event sent by Amazon Lex. The identifier is in\n the form RESPONSE-N, where N is a number starting with one\n and incremented for each event sent by Amazon Lex in the current\n session.

" + "smithy.api#documentation": "

A unique identifier of the event sent by Amazon Lex V2. The identifier is in\n the form RESPONSE-N, where N is a number starting with one\n and incremented for each event sent by Amazon Lex V2 in the current\n session.

" } } }, "traits": { - "smithy.api#documentation": "

Contains the current state of the conversation between the client\n application and Amazon Lex.

" + "smithy.api#documentation": "

Contains the current state of the conversation between the client\n application and Amazon Lex V2.

" } }, "com.amazonaws.lexruntimev2#IntentState": { @@ -1003,7 +1004,7 @@ "nluConfidence": { "target": "com.amazonaws.lexruntimev2#ConfidenceScore", "traits": { - "smithy.api#documentation": "

Determines the threshold where Amazon Lex will insert the\n AMAZON.FallbackIntent,\n AMAZON.KendraSearchIntent, or both when returning\n alternative intents in a response. AMAZON.FallbackIntent\n and AMAZON.KendraSearchIntent are only inserted if they\n are configured for the bot.

" + "smithy.api#documentation": "

Determines the threshold where Amazon Lex V2 will insert the\n AMAZON.FallbackIntent,\n AMAZON.KendraSearchIntent, or both when returning\n alternative intents in a response. AMAZON.FallbackIntent\n and AMAZON.KendraSearchIntent are only inserted if they\n are configured for the bot.

" } }, "sentimentResponse": { @@ -1020,7 +1021,7 @@ } }, "traits": { - "smithy.api#documentation": "

An intent that Amazon Lex determined might satisfy the user's utterance.\n The intents are ordered by the confidence score.

" + "smithy.api#documentation": "

An intent that Amazon Lex V2 determined might satisfy the user's utterance.\n The intents are ordered by the confidence score.

" } }, "com.amazonaws.lexruntimev2#Interpretations": { @@ -1055,7 +1056,8 @@ "contentType": { "target": "com.amazonaws.lexruntimev2#MessageContentType", "traits": { - "smithy.api#documentation": "

Indicates the type of response.

" + "smithy.api#documentation": "

Indicates the type of response.

", + "smithy.api#required": {} } }, "imageResponseCard": { @@ -1130,12 +1132,12 @@ "clientTimestampMillis": { "target": "com.amazonaws.lexruntimev2#EpochMillis", "traits": { - "smithy.api#documentation": "

A timestamp set by the client of the date and time that the event\n was sent to Amazon Lex.

" + "smithy.api#documentation": "

A timestamp set by the client of the date and time that the event\n was sent to Amazon Lex V2.

" } } }, "traits": { - "smithy.api#documentation": "

Event sent from the client application to Amazon Lex to indicate that\n playback of audio is complete and that Amazon Lex should start processing\n the user's input.

" + "smithy.api#documentation": "

Event sent from the client application to Amazon Lex V2 to indicate that\n playback of audio is complete and that Amazon Lex V2 should start processing\n the user's input.

" } }, "com.amazonaws.lexruntimev2#PlaybackInterruptionEvent": { @@ -1144,7 +1146,7 @@ "eventReason": { "target": "com.amazonaws.lexruntimev2#PlaybackInterruptionReason", "traits": { - "smithy.api#documentation": "

Indicates the type of user input that Amazon Lex detected.

" + "smithy.api#documentation": "

Indicates the type of user input that Amazon Lex V2 detected.

" } }, "causedByEventId": { @@ -1156,12 +1158,12 @@ "eventId": { "target": "com.amazonaws.lexruntimev2#EventId", "traits": { - "smithy.api#documentation": "

A unique identifier of the event sent by Amazon Lex. The identifier is in\n the form RESPONSE-N, where N is a number starting with one\n and incremented for each event sent by Amazon Lex in the current\n session.

" + "smithy.api#documentation": "

A unique identifier of the event sent by Amazon Lex V2. The identifier is in\n the form RESPONSE-N, where N is a number starting with one\n and incremented for each event sent by Amazon Lex V2 in the current\n session.

" } } }, "traits": { - "smithy.api#documentation": "

Event sent from Amazon Lex to indicate to the client application should\n stop playback of audio. For example, if the client is playing a prompt\n that asks for the user's telephone number, the user might start to say\n the phone number before the prompt is complete. Amazon Lex sends this event\n to the client application to indicate that the user is responding and\n that Amazon Lex is processing their input.

" + "smithy.api#documentation": "

Event sent from Amazon Lex V2 to indicate to the client application should\n stop playback of audio. For example, if the client is playing a prompt\n that asks for the user's telephone number, the user might start to say\n the phone number before the prompt is complete. Amazon Lex V2 sends this event\n to the client application to indicate that the user is responding and\n that Amazon Lex V2 is processing their input.

" } }, "com.amazonaws.lexruntimev2#PlaybackInterruptionReason": { @@ -1218,7 +1220,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new session or modifies an existing session with an Amazon Lex\n bot. Use this operation to enable your application to set the state of\n the bot.

", + "smithy.api#documentation": "

Creates a new session or modifies an existing session with an Amazon Lex V2\n bot. Use this operation to enable your application to set the state of\n the bot.

", "smithy.api#http": { "method": "POST", "uri": "/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}", @@ -1270,20 +1272,20 @@ "sessionState": { "target": "com.amazonaws.lexruntimev2#SessionState", "traits": { - "smithy.api#documentation": "

Sets the state of the session with the user. You can use this to set\n the current intent, attributes, context, and dialog action. Use the\n dialog action to determine the next step that Amazon Lex should use in the\n conversation with the user.

", + "smithy.api#documentation": "

Sets the state of the session with the user. You can use this to set\n the current intent, attributes, context, and dialog action. Use the\n dialog action to determine the next step that Amazon Lex V2 should use in the\n conversation with the user.

", "smithy.api#required": {} } }, "requestAttributes": { "target": "com.amazonaws.lexruntimev2#StringMap", "traits": { - "smithy.api#documentation": "

Request-specific information passed between Amazon Lex and the client\n application.

\n

The namespace x-amz-lex: is reserved for special\n attributes. Don't create any request attributes with the prefix\n x-amz-lex:.

" + "smithy.api#documentation": "

Request-specific information passed between Amazon Lex V2 and the client\n application.

\n

The namespace x-amz-lex: is reserved for special\n attributes. Don't create any request attributes with the prefix\n x-amz-lex:.

" } }, "responseContentType": { "target": "com.amazonaws.lexruntimev2#NonEmptyString", "traits": { - "smithy.api#documentation": "

The message that Amazon Lex returns in the response can be either text or\n speech depending on the value of this parameter.

\n ", + "smithy.api#documentation": "

The message that Amazon Lex V2 returns in the response can be either text or\n speech depending on the value of this parameter.

\n ", "smithy.api#httpHeader": "ResponseContentType" } } @@ -1316,7 +1318,7 @@ "requestAttributes": { "target": "com.amazonaws.lexruntimev2#NonEmptyString", "traits": { - "smithy.api#documentation": "

Request-specific information passed between the client application\n and Amazon Lex. These are the same as the requestAttribute\n parameter in the call to the PutSession operation.

", + "smithy.api#documentation": "

Request-specific information passed between the client application\n and Amazon Lex V2. These are the same as the requestAttribute\n parameter in the call to the PutSession operation.

", "smithy.api#httpHeader": "x-amz-lex-request-attributes" } }, @@ -1371,7 +1373,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sends user input to Amazon Lex. Client applications use this API to send\n requests to Amazon Lex at runtime. Amazon Lex then interprets the user input\n using the machine learning model that it build for the bot.

\n

In response, Amazon Lex returns the next message to convey to the user\n and an optional response card to display.

", + "smithy.api#documentation": "

Sends user input to Amazon Lex V2. Client applications use this API to send\n requests to Amazon Lex V2 at runtime. Amazon Lex V2 then interprets the user input\n using the machine learning model that it build for the bot.

\n

In response, Amazon Lex V2 returns the next message to convey to the user\n and an optional response card to display.

", "smithy.api#http": { "method": "POST", "uri": "/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}/text", @@ -1417,7 +1419,7 @@ "text": { "target": "com.amazonaws.lexruntimev2#Text", "traits": { - "smithy.api#documentation": "

The text that the user entered. Amazon Lex interprets this text.

", + "smithy.api#documentation": "

The text that the user entered. Amazon Lex V2 interprets this text.

", "smithy.api#required": {} } }, @@ -1430,7 +1432,7 @@ "requestAttributes": { "target": "com.amazonaws.lexruntimev2#StringMap", "traits": { - "smithy.api#documentation": "

Request-specific information passed between the client application\n and Amazon Lex

\n

The namespace x-amz-lex: is reserved for special\n attributes. Don't create any request attributes with the prefix\n x-amz-lex:.

" + "smithy.api#documentation": "

Request-specific information passed between the client application\n and Amazon Lex V2

\n

The namespace x-amz-lex: is reserved for special\n attributes. Don't create any request attributes with the prefix\n x-amz-lex:.

" } } } @@ -1453,7 +1455,7 @@ "interpretations": { "target": "com.amazonaws.lexruntimev2#Interpretations", "traits": { - "smithy.api#documentation": "

A list of intents that Amazon Lex determined might satisfy the user's\n utterance.

\n

Each interpretation includes the intent, a score that indicates now\n confident Amazon Lex is that the interpretation is the correct one, and an\n optional sentiment response that indicates the sentiment expressed in\n the utterance.

" + "smithy.api#documentation": "

A list of intents that Amazon Lex V2 determined might satisfy the user's\n utterance.

\n

Each interpretation includes the intent, a score that indicates now\n confident Amazon Lex V2 is that the interpretation is the correct one, and an\n optional sentiment response that indicates the sentiment expressed in\n the utterance.

" } }, "requestAttributes": { @@ -1509,7 +1511,7 @@ "smithy.api#auth": [ "aws.auth#sigv4" ], - "smithy.api#documentation": "

Sends user input to Amazon Lex. You can send text or speech. Clients use\n this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex\n interprets the user input using the machine learning model built for\n the bot.

", + "smithy.api#documentation": "

Sends user input to Amazon Lex V2. You can send text or speech. Clients use\n this API to send text and audio requests to Amazon Lex V2 at runtime. Amazon Lex V2\n interprets the user input using the machine learning model built for\n the bot.

\n

The following request fields must be compressed with gzip and then\n base64 encoded before you send them to Amazon Lex V2.

\n \n

The following response fields are compressed using gzip and then\n base64 encoded by Amazon Lex V2. Before you can use these fields, you must\n decode and decompress them.

\n \n

The example contains a Java application that compresses and encodes\n a Java object to send to Amazon Lex V2, and a second that decodes and\n decompresses a response from Amazon Lex V2.

", "smithy.api#http": { "method": "POST", "uri": "/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}/utterance", @@ -1555,14 +1557,14 @@ "sessionState": { "target": "com.amazonaws.lexruntimev2#SensitiveNonEmptyString", "traits": { - "smithy.api#documentation": "

Sets the state of the session with the user. You can use this to set\n the current intent, attributes, context, and dialog action. Use the\n dialog action to determine the next step that Amazon Lex should use in the\n conversation with the user.

", + "smithy.api#documentation": "

Sets the state of the session with the user. You can use this to set\n the current intent, attributes, context, and dialog action. Use the\n dialog action to determine the next step that Amazon Lex V2 should use in the\n conversation with the user.

\n

The sessionState field must be compressed using gzip\n and then base64 encoded before sending to Amazon Lex V2.

", "smithy.api#httpHeader": "x-amz-lex-session-state" } }, "requestAttributes": { "target": "com.amazonaws.lexruntimev2#SensitiveNonEmptyString", "traits": { - "smithy.api#documentation": "

Request-specific information passed between the client application\n and Amazon Lex

\n

The namespace x-amz-lex: is reserved for special\n attributes. Don't create any request attributes for prefix\n x-amz-lex:.

", + "smithy.api#documentation": "

Request-specific information passed between the client application\n and Amazon Lex V2

\n

The namespace x-amz-lex: is reserved for special\n attributes. Don't create any request attributes for prefix\n x-amz-lex:.

\n

The requestAttributes field must be compressed using\n gzip and then base64 encoded before sending to Amazon Lex V2.

", "smithy.api#httpHeader": "x-amz-lex-request-attributes" } }, @@ -1577,7 +1579,7 @@ "responseContentType": { "target": "com.amazonaws.lexruntimev2#NonEmptyString", "traits": { - "smithy.api#documentation": "

The message that Amazon Lex returns in the response can be either text or\n speech based on the responseContentType value.

\n ", + "smithy.api#documentation": "

The message that Amazon Lex V2 returns in the response can be either text or\n speech based on the responseContentType value.

\n ", "smithy.api#httpHeader": "Response-Content-Type" } }, @@ -1610,28 +1612,28 @@ "messages": { "target": "com.amazonaws.lexruntimev2#NonEmptyString", "traits": { - "smithy.api#documentation": "

A list of messages that were last sent to the user. The messages are\n ordered based on the order that you returned the messages from your\n Lambda function or the order that the messages are defined in the\n bot.

", + "smithy.api#documentation": "

A list of messages that were last sent to the user. The messages are\n ordered based on the order that you returned the messages from your\n Lambda function or the order that the messages are defined in the\n bot.

\n

The messages field is compressed with gzip and then\n base64 encoded. Before you can use the contents of the field, you must\n decode and decompress the contents. See the example for a simple\n function to decode and decompress the contents.

", "smithy.api#httpHeader": "x-amz-lex-messages" } }, "interpretations": { "target": "com.amazonaws.lexruntimev2#NonEmptyString", "traits": { - "smithy.api#documentation": "

A list of intents that Amazon Lex determined might satisfy the user's\n utterance.

\n

Each interpretation includes the intent, a score that indicates how\n confident Amazon Lex is that the interpretation is the correct one, and an\n optional sentiment response that indicates the sentiment expressed in\n the utterance.

", + "smithy.api#documentation": "

A list of intents that Amazon Lex V2 determined might satisfy the user's\n utterance.

\n

Each interpretation includes the intent, a score that indicates how\n confident Amazon Lex V2 is that the interpretation is the correct one, and an\n optional sentiment response that indicates the sentiment expressed in\n the utterance.

\n

The interpretations field is compressed with gzip and\n then base64 encoded. Before you can use the contents of the field, you\n must decode and decompress the contents. See the example for a simple\n function to decode and decompress the contents.

", "smithy.api#httpHeader": "x-amz-lex-interpretations" } }, "sessionState": { "target": "com.amazonaws.lexruntimev2#NonEmptyString", "traits": { - "smithy.api#documentation": "

Represents the current state of the dialog between the user and the\n bot.

\n

Use this to determine the progress of the conversation and what the\n next action might be.

", + "smithy.api#documentation": "

Represents the current state of the dialog between the user and the\n bot.

\n

Use this to determine the progress of the conversation and what the\n next action might be.

\n

The sessionState field is compressed with gzip and then\n base64 encoded. Before you can use the contents of the field, you must\n decode and decompress the contents. See the example for a simple\n function to decode and decompress the contents.

", "smithy.api#httpHeader": "x-amz-lex-session-state" } }, "requestAttributes": { "target": "com.amazonaws.lexruntimev2#NonEmptyString", "traits": { - "smithy.api#documentation": "

The attributes sent in the request.

", + "smithy.api#documentation": "

The attributes sent in the request.

\n

The requestAttributes field is compressed with gzip and\n then base64 encoded. Before you can use the contents of the field, you\n must decode and decompress the contents.

", "smithy.api#httpHeader": "x-amz-lex-request-attributes" } }, @@ -1645,14 +1647,14 @@ "inputTranscript": { "target": "com.amazonaws.lexruntimev2#NonEmptyString", "traits": { - "smithy.api#documentation": "

The text used to process the request.

\n

If the input was an audio stream, the inputTranscript\n field contains the text extracted from the audio stream. This is the\n text that is actually processed to recognize intents and slot values.\n You can use this information to determine if Amazon Lex is correctly\n processing the audio that you send.

", + "smithy.api#documentation": "

The text used to process the request.

\n

If the input was an audio stream, the inputTranscript\n field contains the text extracted from the audio stream. This is the\n text that is actually processed to recognize intents and slot values.\n You can use this information to determine if Amazon Lex V2 is correctly\n processing the audio that you send.

\n

The inputTranscript field is compressed with gzip and\n then base64 encoded. Before you can use the contents of the field, you\n must decode and decompress the contents. See the example for a simple\n function to decode and decompress the contents.

", "smithy.api#httpHeader": "x-amz-lex-input-transcript" } }, "audioStream": { "target": "com.amazonaws.lexruntimev2#BlobStream", "traits": { - "smithy.api#documentation": "

The prompt or statement to send to the user. This is based on the\n bot configuration and context. For example, if Amazon Lex did not understand\n the user intent, it sends the clarificationPrompt\n configured for the bot. If the intent requires confirmation before\n taking the fulfillment action, it sends the\n confirmationPrompt. Another example: Suppose that the\n Lambda function successfully fulfilled the intent, and sent a message\n to convey to the user. Then Amazon Lex sends that message in the\n response.

", + "smithy.api#documentation": "

The prompt or statement to send to the user. This is based on the\n bot configuration and context. For example, if Amazon Lex V2 did not understand\n the user intent, it sends the clarificationPrompt\n configured for the bot. If the intent requires confirmation before\n taking the fulfillment action, it sends the\n confirmationPrompt. Another example: Suppose that the\n Lambda function successfully fulfilled the intent, and sent a message\n to convey to the user. Then Amazon Lex V2 sends that message in the\n response.

", "smithy.api#httpPayload": {} } } @@ -1759,7 +1761,7 @@ "min": 2, "max": 100 }, - "smithy.api#pattern": "[0-9a-zA-Z._:-]+" + "smithy.api#pattern": "^[0-9a-zA-Z._:-]+$" } }, "com.amazonaws.lexruntimev2#SessionState": { @@ -1768,25 +1770,25 @@ "dialogAction": { "target": "com.amazonaws.lexruntimev2#DialogAction", "traits": { - "smithy.api#documentation": "

The next step that Amazon Lex should take in the conversation with a\n user.

" + "smithy.api#documentation": "

The next step that Amazon Lex V2 should take in the conversation with a\n user.

" } }, "intent": { "target": "com.amazonaws.lexruntimev2#Intent", "traits": { - "smithy.api#documentation": "

The active intent that Amazon Lex is processing.

" + "smithy.api#documentation": "

The active intent that Amazon Lex V2 is processing.

" } }, "activeContexts": { "target": "com.amazonaws.lexruntimev2#ActiveContextsList", "traits": { - "smithy.api#documentation": "

One or more contexts that indicate to Amazon Lex the context of a\n request. When a context is active, Amazon Lex considers intents with the\n matching context as a trigger as the next intent in a session.

" + "smithy.api#documentation": "

One or more contexts that indicate to Amazon Lex V2 the context of a\n request. When a context is active, Amazon Lex V2 considers intents with the\n matching context as a trigger as the next intent in a session.

" } }, "sessionAttributes": { "target": "com.amazonaws.lexruntimev2#StringMap", "traits": { - "smithy.api#documentation": "

Map of key/value pairs representing session-specific context\n information. It contains application information passed between Amazon Lex\n and a client application.

" + "smithy.api#documentation": "

Map of key/value pairs representing session-specific context\n information. It contains application information passed between Amazon Lex V2\n and a client application.

" } }, "originatingRequestId": { @@ -1797,7 +1799,22 @@ } }, "traits": { - "smithy.api#documentation": "

The state of the user's session with Amazon Lex.

" + "smithy.api#documentation": "

The state of the user's session with Amazon Lex V2.

" + } + }, + "com.amazonaws.lexruntimev2#Shape": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Scalar", + "name": "SCALAR" + }, + { + "value": "List", + "name": "LIST" + } + ] } }, "com.amazonaws.lexruntimev2#Slot": { @@ -1808,10 +1825,22 @@ "traits": { "smithy.api#documentation": "

The current value of the slot.

" } + }, + "shape": { + "target": "com.amazonaws.lexruntimev2#Shape", + "traits": { + "smithy.api#documentation": "

When the shape value is List, it indicates\n that the values field contains a list of slot values. When\n the value is Scalar, it indicates that the\n value field contains a single value.

" + } + }, + "values": { + "target": "com.amazonaws.lexruntimev2#Values", + "traits": { + "smithy.api#documentation": "

A list of one or more values that the user provided for the slot.\n For example, if a for a slot that elicits pizza toppings, the values might\n be \"pepperoni\" and \"pineapple.\"

" + } } }, "traits": { - "smithy.api#documentation": "

A value that Amazon Lex uses to fulfill an intent.

" + "smithy.api#documentation": "

A value that Amazon Lex V2 uses to fulfill an intent.

" } }, "com.amazonaws.lexruntimev2#Slots": { @@ -1846,7 +1875,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an HTTP/2 bidirectional event stream that enables you to send\n audio, text, or DTMF input in real time. After your application starts\n a conversation, users send input to Amazon Lex as a stream of events. Amazon Lex\n processes the incoming events and responds with streaming text or audio\n events. \n

\n

", + "smithy.api#documentation": "

Starts an HTTP/2 bidirectional event stream that enables you to send\n audio, text, or DTMF input in real time. After your application starts\n a conversation, users send input to Amazon Lex V2 as a stream of events. Amazon Lex V2\n processes the incoming events and responds with streaming text or audio\n events. \n

\n

Audio input must be in the following format: audio/lpcm\n sample-rate=8000 sample-size-bits=16 channel-count=1;\n is-big-endian=false.

\n

The StartConversation operation is supported only in\n the following SDKs:

\n ", "smithy.api#http": { "method": "POST", "uri": "/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}/conversation", @@ -1892,14 +1921,14 @@ "conversationMode": { "target": "com.amazonaws.lexruntimev2#ConversationMode", "traits": { - "smithy.api#documentation": "

The conversation type that you are using the Amazon Lex. If the\n conversation mode is AUDIO you can send both audio and\n DTMF information. If the mode is TEXT you can only send\n text.

", + "smithy.api#documentation": "

The conversation type that you are using the Amazon Lex V2. If the\n conversation mode is AUDIO you can send both audio and\n DTMF information. If the mode is TEXT you can only send\n text.

", "smithy.api#httpHeader": "x-amz-lex-conversation-mode" } }, "requestEventStream": { "target": "com.amazonaws.lexruntimev2#StartConversationRequestEventStream", "traits": { - "smithy.api#documentation": "

Represents the stream of events to Amazon Lex from your application. The\n events are encoded as HTTP/2 data frames.

", + "smithy.api#documentation": "

Represents the stream of events to Amazon Lex V2 from your application. The\n events are encoded as HTTP/2 data frames.

", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -1912,42 +1941,42 @@ "ConfigurationEvent": { "target": "com.amazonaws.lexruntimev2#ConfigurationEvent", "traits": { - "smithy.api#documentation": "

Configuration information sent from your client application to\n Amazon Lex

" + "smithy.api#documentation": "

Configuration information sent from your client application to\n Amazon Lex V2

" } }, "AudioInputEvent": { "target": "com.amazonaws.lexruntimev2#AudioInputEvent", "traits": { - "smithy.api#documentation": "

Speech audio sent from your client application to Amazon Lex. Audio\n starts accumulating when Amazon Lex identifies a voice and continues until a\n natural pause in the speech is found before processing.

" + "smithy.api#documentation": "

Speech audio sent from your client application to Amazon Lex V2. Audio\n starts accumulating when Amazon Lex V2 identifies a voice and continues until a\n natural pause in the speech is found before processing.

" } }, "DTMFInputEvent": { "target": "com.amazonaws.lexruntimev2#DTMFInputEvent", "traits": { - "smithy.api#documentation": "

DTMF information sent to Amazon Lex by your application. Amazon Lex\n accumulates the DMTF information from when the user sends the first\n character and ends

\n " + "smithy.api#documentation": "

DTMF information sent to Amazon Lex V2 by your application. Amazon Lex V2\n accumulates the DMTF information from when the user sends the first\n character and ends

\n " } }, "TextInputEvent": { "target": "com.amazonaws.lexruntimev2#TextInputEvent", "traits": { - "smithy.api#documentation": "

Text sent from your client application to Amazon Lex. Each\n TextInputEvent is processed individually.

" + "smithy.api#documentation": "

Text sent from your client application to Amazon Lex V2. Each\n TextInputEvent is processed individually.

" } }, "PlaybackCompletionEvent": { "target": "com.amazonaws.lexruntimev2#PlaybackCompletionEvent", "traits": { - "smithy.api#documentation": "

Event sent from the client application to Amazon Lex to indicate that it\n has finished playing audio and that Amazon Lex should start listening for\n user input.

" + "smithy.api#documentation": "

Event sent from the client application to Amazon Lex V2 to indicate that it\n has finished playing audio and that Amazon Lex V2 should start listening for\n user input.

" } }, "DisconnectionEvent": { "target": "com.amazonaws.lexruntimev2#DisconnectionEvent", "traits": { - "smithy.api#documentation": "

Event sent from the client application to indicate to Amazon Lex that the\n conversation is over.

" + "smithy.api#documentation": "

Event sent from the client application to indicate to Amazon Lex V2 that the\n conversation is over.

" } } }, "traits": { - "smithy.api#documentation": "

Represents a stream of events between your application and\n Amazon Lex.

", + "smithy.api#documentation": "

Represents a stream of events between your application and\n Amazon Lex V2.

", "smithy.api#streaming": {} } }, @@ -1957,7 +1986,7 @@ "responseEventStream": { "target": "com.amazonaws.lexruntimev2#StartConversationResponseEventStream", "traits": { - "smithy.api#documentation": "

Represents the stream of events from Amazon Lex to your application. The\n events are encoded as HTTP/2 data frames.

", + "smithy.api#documentation": "

Represents the stream of events from Amazon Lex V2 to your application. The\n events are encoded as HTTP/2 data frames.

", "smithy.api#httpPayload": {} } } @@ -1975,7 +2004,7 @@ "IntentResultEvent": { "target": "com.amazonaws.lexruntimev2#IntentResultEvent", "traits": { - "smithy.api#documentation": "

Event sent from Amazon Lex to the client application containing the\n current state of the conversation between the user and Amazon Lex.

" + "smithy.api#documentation": "

Event sent from Amazon Lex V2 to the client application containing the\n current state of the conversation between the user and Amazon Lex V2.

" } }, "TextResponseEvent": { @@ -2014,13 +2043,13 @@ "InternalServerException": { "target": "com.amazonaws.lexruntimev2#InternalServerException", "traits": { - "smithy.api#documentation": "

An error occurred with Amazon Lex.

" + "smithy.api#documentation": "

An error occurred with Amazon Lex V2.

" } }, "ConflictException": { "target": "com.amazonaws.lexruntimev2#ConflictException", "traits": { - "smithy.api#documentation": "

Exception thrown when two clients are using the same AWS account,\n Amazon Lex bot, and session ID.

" + "smithy.api#documentation": "

Exception thrown when two clients are using the same AWS account,\n Amazon Lex V2 bot, and session ID.

" } }, "DependencyFailedException": { @@ -2031,7 +2060,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a stream of events between Amazon Lex and your\n application.

", + "smithy.api#documentation": "

Represents a stream of events between Amazon Lex V2 and your\n application.

", "smithy.api#streaming": {} } }, @@ -2069,7 +2098,7 @@ "text": { "target": "com.amazonaws.lexruntimev2#Text", "traits": { - "smithy.api#documentation": "

The text from the user. Amazon Lex processes this as a complete\n statement.

", + "smithy.api#documentation": "

The text from the user. Amazon Lex V2 processes this as a complete\n statement.

", "smithy.api#required": {} } }, @@ -2082,12 +2111,12 @@ "clientTimestampMillis": { "target": "com.amazonaws.lexruntimev2#EpochMillis", "traits": { - "smithy.api#documentation": "

A timestamp set by the client of the date and time that the event\n was sent to Amazon Lex.

" + "smithy.api#documentation": "

A timestamp set by the client of the date and time that the event\n was sent to Amazon Lex V2.

" } } }, "traits": { - "smithy.api#documentation": "

The event sent from your client application to Amazon Lex with text input\n from the user.

" + "smithy.api#documentation": "

The event sent from your client application to Amazon Lex V2 with text input\n from the user.

" } }, "com.amazonaws.lexruntimev2#TextResponseEvent": { @@ -2102,12 +2131,12 @@ "eventId": { "target": "com.amazonaws.lexruntimev2#EventId", "traits": { - "smithy.api#documentation": "

A unique identifier of the event sent by Amazon Lex. The identifier is in\n the form RESPONSE-N, where N is a number starting with one\n and incremented for each event sent by Amazon Lex in the current\n session.

" + "smithy.api#documentation": "

A unique identifier of the event sent by Amazon Lex V2. The identifier is in\n the form RESPONSE-N, where N is a number starting with one\n and incremented for each event sent by Amazon Lex V2 in the current\n session.

" } } }, "traits": { - "smithy.api#documentation": "

The event sent from Amazon Lex to your application with text to present\n to the user.

" + "smithy.api#documentation": "

The event sent from Amazon Lex V2 to your application with text to present\n to the user.

" } }, "com.amazonaws.lexruntimev2#ThrottlingException": { @@ -2138,12 +2167,12 @@ "eventId": { "target": "com.amazonaws.lexruntimev2#EventId", "traits": { - "smithy.api#documentation": "

A unique identifier of the event sent by Amazon Lex. The identifier is in\n the form RESPONSE-N, where N is a number starting with one\n and incremented for each event sent by Amazon Lex in the current\n session.

" + "smithy.api#documentation": "

A unique identifier of the event sent by Amazon Lex V2. The identifier is in\n the form RESPONSE-N, where N is a number starting with one\n and incremented for each event sent by Amazon Lex V2 in the current\n session.

" } } }, "traits": { - "smithy.api#documentation": "

Event sent from Amazon Lex to your client application that contains a\n transcript of voice audio.

" + "smithy.api#documentation": "

Event sent from Amazon Lex V2 to your client application that contains a\n transcript of voice audio.

" } }, "com.amazonaws.lexruntimev2#ValidationException": { @@ -2174,7 +2203,7 @@ "interpretedValue": { "target": "com.amazonaws.lexruntimev2#NonEmptyString", "traits": { - "smithy.api#documentation": "

The value that Amazon Lex determines for the slot. The actual value\n depends on the setting of the value selection strategy for the bot. You\n can choose to use the value entered by the user, or you can have Amazon Lex\n choose the first value in the resolvedValues list.

", + "smithy.api#documentation": "

The value that Amazon Lex V2 determines for the slot. The actual value\n depends on the setting of the value selection strategy for the bot. You\n can choose to use the value entered by the user, or you can have Amazon Lex V2\n choose the first value in the resolvedValues list.

", "smithy.api#required": {} } }, @@ -2188,6 +2217,12 @@ "traits": { "smithy.api#documentation": "

The value of a slot.

" } + }, + "com.amazonaws.lexruntimev2#Values": { + "type": "list", + "member": { + "target": "com.amazonaws.lexruntimev2#Slot" + } } } } diff --git a/aws/sdk/aws-models/sagemaker.json b/aws/sdk/aws-models/sagemaker.json index d95ec1588..ba25a5d67 100644 --- a/aws/sdk/aws-models/sagemaker.json +++ b/aws/sdk/aws-models/sagemaker.json @@ -240,7 +240,7 @@ "target": "com.amazonaws.sagemaker#AddTagsOutput" }, "traits": { - "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified Amazon SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.

\n

Each tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see AWS\n Tagging Strategies.

\n \n

Tags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n

\n \n \n

Tags that you add to a SageMaker Studio Domain or User Profile by calling this API\n are also added to any Apps that the Domain or User Profile launches after you call\n this API, but not to Apps that the Domain or User Profile launched before you called\n this API. To make sure that the tags associated with a Domain or User Profile are\n also added to all Apps that the Domain or User Profile launches, add the tags when\n you first create the Domain or User Profile by specifying them in the\n Tags parameter of CreateDomain or CreateUserProfile.

\n " + "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified Amazon SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.

\n

Each tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services\n Tagging Strategies.

\n \n

Tags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n

\n \n \n

Tags that you add to a SageMaker Studio Domain or User Profile by calling this API\n are also added to any Apps that the Domain or User Profile launches after you call\n this API, but not to Apps that the Domain or User Profile launched before you called\n this API. To make sure that the tags associated with a Domain or User Profile are\n also added to all Apps that the Domain or User Profile launches, add the tags when\n you first create the Domain or User Profile by specifying them in the\n Tags parameter of CreateDomain or CreateUserProfile.

\n " } }, "com.amazonaws.sagemaker#AddTagsInput": { @@ -256,7 +256,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your AWS resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging AWS\n Resources.

", + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

", "smithy.api#required": {} } } @@ -396,7 +396,7 @@ "AlgorithmName": { "target": "com.amazonaws.sagemaker#ArnOrName", "traits": { - "smithy.api#documentation": "

The name of the algorithm resource to use for the training job. This must be an\n algorithm resource that you created or subscribe to on AWS Marketplace. If you specify a value for\n this parameter, you can't specify a value for TrainingImage.

" + "smithy.api#documentation": "

The name of the algorithm resource to use for the training job. This must be an\n algorithm resource that you created or subscribe to on Amazon Web Services Marketplace. If you specify a value for\n this parameter, you can't specify a value for TrainingImage.

" } }, "TrainingInputMode": { @@ -577,7 +577,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines a training job and a batch transform job that Amazon SageMaker runs to validate your\n algorithm.

\n

The data provided in the validation profile is made available to your buyers on AWS\n Marketplace.

" + "smithy.api#documentation": "

Defines a training job and a batch transform job that Amazon SageMaker runs to validate your\n algorithm.

\n

The data provided in the validation profile is made available to your buyers on Amazon Web Services\n Marketplace.

" } }, "com.amazonaws.sagemaker#AlgorithmValidationProfiles": { @@ -1402,7 +1402,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data generated from\n an Athena query execution.

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data generated from\n an Athena query execution.

" } }, "OutputFormat": { @@ -2081,7 +2081,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS KMS encryption key ID.

" + "smithy.api#documentation": "

The Amazon Web Services KMS encryption key ID.

" } }, "S3OutputPath": { @@ -3027,7 +3027,7 @@ "GitConfig": { "target": "com.amazonaws.sagemaker#GitConfig", "traits": { - "smithy.api#documentation": "

Configuration details for the Git repository, including the URL where it is located\n and the ARN of the AWS Secrets Manager secret that contains the credentials used to\n access the repository.

" + "smithy.api#documentation": "

Configuration details for the Git repository, including the URL where it is located\n and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to\n access the repository.

" } } }, @@ -3438,7 +3438,7 @@ "ModelDataUrl": { "target": "com.amazonaws.sagemaker#Url", "traits": { - "smithy.api#documentation": "

The S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3\n path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms.\n For more information on built-in algorithms, see Common\n Parameters.

\n \n

The model artifacts must be in an S3 bucket that is in the same region as the\n model or endpoint you are creating.

\n \n

If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to\n download model artifacts from the S3 path you provide. AWS STS is activated in your\n IAM user account by default. If you previously deactivated AWS STS for a region, you\n need to reactivate AWS STS for that region. For more information, see Activating and\n Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User\n Guide.

\n \n

If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide\n a S3 path to the model artifacts in ModelDataUrl.

\n " + "smithy.api#documentation": "

The S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3\n path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms.\n For more information on built-in algorithms, see Common\n Parameters.

\n \n

The model artifacts must be in an S3 bucket that is in the same region as the\n model or endpoint you are creating.

\n \n

If you provide a value for this parameter, Amazon SageMaker uses Amazon Web Services Security Token Service to\n download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your\n IAM user account by default. If you previously deactivated Amazon Web Services STS for a region, you\n need to reactivate Amazon Web Services STS for that region. For more information, see Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User\n Guide.

\n \n

If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide\n a S3 path to the model artifacts in ModelDataUrl.

\n " } }, "Environment": { @@ -3765,7 +3765,7 @@ "ActionName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

The name of the action. Must be unique to your account in an AWS Region.

", + "smithy.api#documentation": "

The name of the action. Must be unique to your account in an Amazon Web Services Region.

", "smithy.api#required": {} } }, @@ -3832,7 +3832,7 @@ "target": "com.amazonaws.sagemaker#CreateAlgorithmOutput" }, "traits": { - "smithy.api#documentation": "

Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS\n Marketplace.

" + "smithy.api#documentation": "

Create a machine learning algorithm that you can use in Amazon SageMaker and list in the Amazon Web Services\n Marketplace.

" } }, "com.amazonaws.sagemaker#CreateAlgorithmInput": { @@ -3873,13 +3873,13 @@ "CertifyForMarketplace": { "target": "com.amazonaws.sagemaker#CertifyForMarketplace", "traits": { - "smithy.api#documentation": "

Whether to certify the algorithm so that it can be listed in AWS Marketplace.

" + "smithy.api#documentation": "

Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.

" } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your AWS resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging AWS\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" } } } @@ -4047,7 +4047,7 @@ "ArtifactName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

The name of the artifact. Must be unique to your account in an AWS Region.

" + "smithy.api#documentation": "

The name of the artifact. Must be unique to your account in an Amazon Web Services Region.

" } }, "Source": { @@ -4202,7 +4202,7 @@ "target": "com.amazonaws.sagemaker#CreateCodeRepositoryOutput" }, "traits": { - "smithy.api#documentation": "

Creates a Git repository as a resource in your Amazon SageMaker account. You can associate the\n repository with notebook instances so that you can use Git source control for the\n notebooks you create. The Git repository is a resource in your Amazon SageMaker account, so it can\n be associated with more than one notebook instance, and it persists independently from\n the lifecycle of any notebook instances it is associated with.

\n

The repository can be hosted either in AWS CodeCommit or in any\n other Git repository.

" + "smithy.api#documentation": "

Creates a Git repository as a resource in your Amazon SageMaker account. You can associate the\n repository with notebook instances so that you can use Git source control for the\n notebooks you create. The Git repository is a resource in your Amazon SageMaker account, so it can\n be associated with more than one notebook instance, and it persists independently from\n the lifecycle of any notebook instances it is associated with.

\n

The repository can be hosted either in Amazon Web Services CodeCommit or in any\n other Git repository.

" } }, "com.amazonaws.sagemaker#CreateCodeRepositoryInput": { @@ -4225,7 +4225,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your AWS resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging AWS\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" } } } @@ -4259,7 +4259,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the\n resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

\n

If\n you choose to host your model using Amazon SageMaker hosting services, you can use the resulting\n model artifacts as part of the model. You can also use the artifacts with\n AWS\n IoT Greengrass. In that case, deploy them as an ML\n resource.

\n

In the request body, you provide the following:

\n \n

You can also provide a Tag to track the model compilation job's resource\n use and costs. The response body contains the\n CompilationJobArn\n for the compiled job.

\n

To stop a model compilation job, use StopCompilationJob. To get\n information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model\n compilation jobs, use ListCompilationJobs.

" + "smithy.api#documentation": "

Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the\n resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

\n

If\n you choose to host your model using Amazon SageMaker hosting services, you can use the resulting\n model artifacts as part of the model. You can also use the artifacts with\n Amazon Web Services\n IoT Greengrass. In that case, deploy them as an ML\n resource.

\n

In the request body, you provide the following:

\n \n

You can also provide a Tag to track the model compilation job's resource\n use and costs. The response body contains the\n CompilationJobArn\n for the compiled job.

\n

To stop a model compilation job, use StopCompilationJob. To get\n information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model\n compilation jobs, use ListCompilationJobs.

" } }, "com.amazonaws.sagemaker#CreateCompilationJobRequest": { @@ -4268,7 +4268,7 @@ "CompilationJobName": { "target": "com.amazonaws.sagemaker#EntityName", "traits": { - "smithy.api#documentation": "

A name for the model compilation job. The name must be unique within the AWS Region\n and within your AWS account.

", + "smithy.api#documentation": "

A name for the model compilation job. The name must be unique within the Amazon Web Services Region\n and within your Amazon Web Services account.

", "smithy.api#required": {} } }, @@ -4293,6 +4293,12 @@ "smithy.api#required": {} } }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#NeoVpcConfig", + "traits": { + "smithy.api#documentation": "

A VpcConfig object that specifies the VPC that you want your\n compilation job to connect to. Control access to your models by\n configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon\n Virtual Private Cloud.

" + } + }, "StoppingCondition": { "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { @@ -4303,7 +4309,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your AWS resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging AWS\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" } } } @@ -4343,7 +4349,7 @@ "ContextName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

The name of the context. Must be unique to your account in an AWS Region.

", + "smithy.api#documentation": "

The name of the context. Must be unique to your account in an Amazon Web Services Region.

", "smithy.api#required": {} } }, @@ -4473,7 +4479,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management\n User Guide.

" + "smithy.api#documentation": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management\n User Guide.

" } } } @@ -4520,7 +4526,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

" } }, "Description": { @@ -4545,7 +4551,7 @@ "EnableIotRoleAlias": { "target": "com.amazonaws.sagemaker#EnableIotRoleAlias", "traits": { - "smithy.api#documentation": "

Whether to create an AWS IoT Role Alias during device fleet creation. \n The name of the role alias generated will match this pattern: \n \"SageMakerEdge-{DeviceFleetName}\".

\n

For example, if your device fleet is called \"demo-fleet\", the name of \n the role alias will be \"SageMakerEdge-demo-fleet\".

" + "smithy.api#documentation": "

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. \n The name of the role alias generated will match this pattern: \n \"SageMakerEdge-{DeviceFleetName}\".

\n

For example, if your device fleet is called \"demo-fleet\", the name of \n the role alias will be \"SageMakerEdge-demo-fleet\".

" } } } @@ -4567,7 +4573,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated\n Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application,\n policy, and Amazon Virtual Private Cloud (VPC) configurations. An AWS account is limited to one domain per region.\n Users within a domain can share notebook files and other artifacts with each other.

\n\n

\n EFS storage\n

\n

When a domain is created, an EFS volume is created for use by all of the users within the\n domain. Each user receives a private home directory within the EFS volume for notebooks,\n Git repositories, and data files.

\n

SageMaker uses the AWS Key Management Service (AWS KMS) to encrypt the EFS volume attached to the domain with\n an AWS managed customer master key (CMK) by default. For more control, you can specify a\n customer managed CMK. For more information, see\n Protect Data at\n Rest Using Encryption.

\n\n

\n VPC configuration\n

\n

All SageMaker Studio traffic between the domain and the EFS volume is through the specified\n VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType\n parameter. AppNetworkAccessType corresponds to the network access type that you\n choose when you onboard to Studio. The following options are available:

\n \n

For more information, see\n Connect\n SageMaker Studio Notebooks to Resources in a VPC.

" + "smithy.api#documentation": "

Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated\n Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application,\n policy, and Amazon Virtual Private Cloud (VPC) configurations. An Amazon Web Services account is limited to one domain per region.\n Users within a domain can share notebook files and other artifacts with each other.

\n\n

\n EFS storage\n

\n

When a domain is created, an EFS volume is created for use by all of the users within the\n domain. Each user receives a private home directory within the EFS volume for notebooks,\n Git repositories, and data files.

\n

SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with\n an Amazon Web Services managed customer master key (CMK) by default. For more control, you can specify a\n customer managed CMK. For more information, see\n Protect Data at\n Rest Using Encryption.

\n\n

\n VPC configuration\n

\n

All SageMaker Studio traffic between the domain and the EFS volume is through the specified\n VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType\n parameter. AppNetworkAccessType corresponds to the network access type that you\n choose when you onboard to Studio. The following options are available:

\n \n \n

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules\n in order to launch a SageMaker Studio app successfully.

\n \n

For more information, see\n Connect\n SageMaker Studio Notebooks to Resources in a VPC.

" } }, "com.amazonaws.sagemaker#CreateDomainRequest": { @@ -4632,7 +4638,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

SageMaker uses AWS KMS to encrypt the EFS volume attached to the domain with an AWS managed\n customer master key (CMK) by default. For more control, specify a customer managed CMK.

" + "smithy.api#documentation": "

SageMaker uses Amazon Web Services KMS to encrypt the EFS volume attached to the domain with an Amazon Web Services managed\n customer master key (CMK) by default. For more control, specify a customer managed CMK.

" } } } @@ -4741,7 +4747,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an endpoint using the endpoint configuration specified in the request. Amazon SageMaker\n uses the endpoint to provision resources and deploy models. You create the endpoint\n configuration with the CreateEndpointConfig API.

\n

Use this API to deploy models using Amazon SageMaker hosting services.

\n

For an example that calls this method when deploying a model to Amazon SageMaker hosting services,\n see Deploy the\n Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto\n 3)).\n

\n \n

You must not delete an EndpointConfig that is in use by an endpoint\n that is live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.

\n \n

The endpoint name must be unique within an AWS Region in your AWS account.

\n

When it receives the request, Amazon SageMaker creates the endpoint, launches the resources (ML\n compute instances), and deploys the model(s) on them.

\n \n \n

When you call CreateEndpoint, a load call is made to DynamoDB to\n verify that your endpoint configuration exists. When you read data from a DynamoDB\n table supporting \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

\n \n

When Amazon SageMaker receives the request, it sets the endpoint status to\n Creating. After it creates the endpoint, it sets the status to\n InService. Amazon SageMaker can then process incoming requests for inferences. To\n check the status of an endpoint, use the DescribeEndpoint\n API.

\n

If any of the models hosted at this endpoint get model data from an Amazon S3 location,\n Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you\n provided. AWS STS is activated in your IAM user account by default. If you previously\n deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For\n more information, see Activating and\n Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User\n Guide.

\n \n

To add the IAM role policies for using this API operation, go to the IAM console, and choose\n Roles in the left navigation pane. Search the IAM role that you want to grant\n access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to\n the role.

\n \n\n " + "smithy.api#documentation": "

Creates an endpoint using the endpoint configuration specified in the request. Amazon SageMaker\n uses the endpoint to provision resources and deploy models. You create the endpoint\n configuration with the CreateEndpointConfig API.

\n

Use this API to deploy models using Amazon SageMaker hosting services.

\n

For an example that calls this method when deploying a model to Amazon SageMaker hosting services,\n see Deploy the\n Model to Amazon SageMaker Hosting Services (Amazon Web Services SDK for Python (Boto\n 3)).\n

\n \n

You must not delete an EndpointConfig that is in use by an endpoint\n that is live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.

\n \n

The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.

\n

When it receives the request, Amazon SageMaker creates the endpoint, launches the resources (ML\n compute instances), and deploys the model(s) on them.

\n \n \n

When you call CreateEndpoint, a load call is made to DynamoDB to\n verify that your endpoint configuration exists. When you read data from a DynamoDB\n table supporting \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

\n \n

When Amazon SageMaker receives the request, it sets the endpoint status to\n Creating. After it creates the endpoint, it sets the status to\n InService. Amazon SageMaker can then process incoming requests for inferences. To\n check the status of an endpoint, use the DescribeEndpoint\n API.

\n

If any of the models hosted at this endpoint get model data from an Amazon S3 location,\n Amazon SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you\n provided. Amazon Web Services STS is activated in your IAM user account by default. If you previously\n deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For\n more information, see Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User\n Guide.

\n \n

To add the IAM role policies for using this API operation, go to the IAM console, and choose\n Roles in the left navigation pane. Search the IAM role that you want to grant\n access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to\n the role.

\n \n\n " } }, "com.amazonaws.sagemaker#CreateEndpointConfig": { @@ -4758,7 +4764,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models. In\n the configuration, you identify one or more models, created using the\n CreateModel API, to deploy and the resources that you want Amazon SageMaker to\n provision. Then you call the CreateEndpoint API.

\n \n

Use this API if you want to use Amazon SageMaker hosting services to deploy models into\n production.

\n \n

In the request, you define a ProductionVariant, for each model that you\n want to deploy. Each ProductionVariant parameter also describes the\n resources that you want Amazon SageMaker to provision. This includes the number and type of ML\n compute instances to deploy.

\n

If you are hosting multiple models, you also assign a VariantWeight to\n specify how much traffic you want to allocate to each model. For example, suppose that\n you want to host two models, A and B, and you assign traffic weight 2 for model A and 1\n for model B. Amazon SageMaker distributes two-thirds of the traffic to Model A, and one-third to\n model B.

\n

For an example that calls this method when deploying a model to Amazon SageMaker hosting services,\n see Deploy the\n Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto\n 3)).\n

\n \n

When you call CreateEndpoint, a load call is made to DynamoDB to\n verify that your endpoint configuration exists. When you read data from a DynamoDB\n table supporting \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

\n " + "smithy.api#documentation": "

Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models. In\n the configuration, you identify one or more models, created using the\n CreateModel API, to deploy and the resources that you want Amazon SageMaker to\n provision. Then you call the CreateEndpoint API.

\n \n

Use this API if you want to use Amazon SageMaker hosting services to deploy models into\n production.

\n \n

In the request, you define a ProductionVariant, for each model that you\n want to deploy. Each ProductionVariant parameter also describes the\n resources that you want Amazon SageMaker to provision. This includes the number and type of ML\n compute instances to deploy.

\n

If you are hosting multiple models, you also assign a VariantWeight to\n specify how much traffic you want to allocate to each model. For example, suppose that\n you want to host two models, A and B, and you assign traffic weight 2 for model A and 1\n for model B. Amazon SageMaker distributes two-thirds of the traffic to Model A, and one-third to\n model B.

\n

For an example that calls this method when deploying a model to Amazon SageMaker hosting services,\n see Deploy the\n Model to Amazon SageMaker Hosting Services (Amazon Web Services SDK for Python (Boto\n 3)).\n

\n \n

When you call CreateEndpoint, a load call is made to DynamoDB to\n verify that your endpoint configuration exists. When you read data from a DynamoDB\n table supporting \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

\n " } }, "com.amazonaws.sagemaker#CreateEndpointConfigInput": { @@ -4784,13 +4790,13 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your AWS resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging AWS\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" } }, "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint.

\n

The KmsKeyId can be any of the following formats:

\n \n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint, UpdateEndpoint requests. For more\n information, refer to the AWS Key Management Service section Using Key\n Policies in AWS KMS \n

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a KmsKeyId when using an instance type with local\n storage. If any of the models that you specify in the\n ProductionVariants parameter use nitro-based instances with local\n storage, do not specify a value for the KmsKeyId parameter. If you\n specify a value for KmsKeyId when using any nitro-based instances with\n local storage, the call to CreateEndpointConfig fails.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n " + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint.

\n

The KmsKeyId can be any of the following formats:

\n \n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint, UpdateEndpoint requests. For more\n information, refer to the Amazon Web Services Key Management Service section Using Key\n Policies in Amazon Web Services KMS \n

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a KmsKeyId when using an instance type with local\n storage. If any of the models that you specify in the\n ProductionVariants parameter use nitro-based instances with local\n storage, do not specify a value for the KmsKeyId parameter. If you\n specify a value for KmsKeyId when using any nitro-based instances with\n local storage, the call to CreateEndpointConfig fails.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n " } } } @@ -4813,7 +4819,7 @@ "EndpointName": { "target": "com.amazonaws.sagemaker#EndpointName", "traits": { - "smithy.api#documentation": "

The name of the endpoint.The name must be unique within an AWS Region in your AWS\n account. The name is case-insensitive in CreateEndpoint, but the case is\n preserved and must be matched in .

", + "smithy.api#documentation": "

The name of the endpoint.The name must be unique within an Amazon Web Services Region in your Amazon Web Services\n account. The name is case-insensitive in CreateEndpoint, but the case is\n preserved and must be matched in .

", "smithy.api#required": {} } }, @@ -4827,7 +4833,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your AWS resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging AWS\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" } } } @@ -4858,7 +4864,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an SageMaker experiment. An experiment is a collection of\n trials that are observed, compared and evaluated as a group. A trial is\n a set of steps, called trial components, that produce a machine learning\n model.

\n

The goal of an experiment is to determine the components that produce the best model.\n Multiple trials are performed, each one isolating and measuring the impact of a change to one\n or more inputs, while keeping the remaining inputs constant.

\n

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.

\n

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

\n

To add a description to an experiment, specify the optional Description\n parameter. To add a description later, or to change the description, call the UpdateExperiment API.

\n

To get a list of all your experiments, call the ListExperiments API. To\n view an experiment's properties, call the DescribeExperiment API. To get a\n list of all the trials associated with an experiment, call the ListTrials\n API. To create a trial call the CreateTrial API.

" + "smithy.api#documentation": "

Creates an SageMaker experiment. An experiment is a collection of\n trials that are observed, compared and evaluated as a group. A trial is\n a set of steps, called trial components, that produce a machine learning\n model.

\n

The goal of an experiment is to determine the components that produce the best model.\n Multiple trials are performed, each one isolating and measuring the impact of a change to one\n or more inputs, while keeping the remaining inputs constant.

\n

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.

\n

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

\n

To add a description to an experiment, specify the optional Description\n parameter. To add a description later, or to change the description, call the UpdateExperiment API.

\n

To get a list of all your experiments, call the ListExperiments API. To\n view an experiment's properties, call the DescribeExperiment API. To get a\n list of all the trials associated with an experiment, call the ListTrials\n API. To create a trial call the CreateTrial API.

" } }, "com.amazonaws.sagemaker#CreateExperimentRequest": { @@ -4867,7 +4873,7 @@ "ExperimentName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

The name of the experiment. The name must be unique in your AWS account and is not\n case-sensitive.

", + "smithy.api#documentation": "

The name of the experiment. The name must be unique in your Amazon Web Services account and is not\n case-sensitive.

", "smithy.api#required": {} } }, @@ -4919,7 +4925,7 @@ } ], "traits": { - "smithy.api#documentation": "

Create a new FeatureGroup. A FeatureGroup is a group of\n Features defined in the FeatureStore to describe a\n Record.

\n

The FeatureGroup defines the schema and features contained in the\n FeatureGroup. A FeatureGroup definition is composed of a list of\n Features, a RecordIdentifierFeatureName, an\n EventTimeFeatureName and configurations for its OnlineStore\n and OfflineStore. Check AWS service quotas to see\n the FeatureGroups quota for your AWS account.

\n \n

You must include at least one of OnlineStoreConfig and\n OfflineStoreConfig to create a FeatureGroup.

\n " + "smithy.api#documentation": "

Create a new FeatureGroup. A FeatureGroup is a group of\n Features defined in the FeatureStore to describe a\n Record.

\n

The FeatureGroup defines the schema and features contained in the\n FeatureGroup. A FeatureGroup definition is composed of a list of\n Features, a RecordIdentifierFeatureName, an\n EventTimeFeatureName and configurations for its OnlineStore\n and OfflineStore. Check Amazon Web Services service quotas to see\n the FeatureGroups quota for your Amazon Web Services account.

\n \n

You must include at least one of OnlineStoreConfig and\n OfflineStoreConfig to create a FeatureGroup.

\n " } }, "com.amazonaws.sagemaker#CreateFeatureGroupRequest": { @@ -4928,7 +4934,7 @@ "FeatureGroupName": { "target": "com.amazonaws.sagemaker#FeatureGroupName", "traits": { - "smithy.api#documentation": "

The name of the FeatureGroup. The name must be unique within an AWS Region\n in an AWS account. The name:

\n ", + "smithy.api#documentation": "

The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region\n in an Amazon Web Services account. The name:

\n ", "smithy.api#required": {} } }, @@ -4956,13 +4962,13 @@ "OnlineStoreConfig": { "target": "com.amazonaws.sagemaker#OnlineStoreConfig", "traits": { - "smithy.api#documentation": "

You can turn the OnlineStore on or off by specifying True for\n the EnableOnlineStore flag in OnlineStoreConfig; the default\n value is False.

\n

You can also include an AWS KMS key ID (KMSKeyId) for at-rest encryption of\n the OnlineStore.

" + "smithy.api#documentation": "

You can turn the OnlineStore on or off by specifying True for\n the EnableOnlineStore flag in OnlineStoreConfig; the default\n value is False.

\n

You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of\n the OnlineStore.

" } }, "OfflineStoreConfig": { "target": "com.amazonaws.sagemaker#OfflineStoreConfig", "traits": { - "smithy.api#documentation": "

Use this to configure an OfflineFeatureStore. This parameter allows you to\n specify:

\n \n

To learn more about this parameter, see OfflineStoreConfig.

" + "smithy.api#documentation": "

Use this to configure an OfflineFeatureStore. This parameter allows you to\n specify:

\n \n

To learn more about this parameter, see OfflineStoreConfig.

" } }, "RoleArn": { @@ -5162,7 +5168,7 @@ "HyperParameterTuningJobName": { "target": "com.amazonaws.sagemaker#HyperParameterTuningJobName", "traits": { - "smithy.api#documentation": "

The name of the tuning job. This name is the prefix for the names of all training jobs\n that this tuning job launches. The name must be unique within the same AWS account and\n AWS Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9,\n and : + = @ _ % - (hyphen). The name is not case sensitive.

", + "smithy.api#documentation": "

The name of the tuning job. This name is the prefix for the names of all training jobs\n that this tuning job launches. The name must be unique within the same Amazon Web Services account and\n Amazon Web Services Region. The name must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9,\n and : + = @ _ % - (hyphen). The name is not case sensitive.

", "smithy.api#required": {} } }, @@ -5194,7 +5200,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your AWS resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging AWS\n Resources.

\n

Tags that you specify for the tuning job are also added to all training jobs that the\n tuning job launches.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

\n

Tags that you specify for the tuning job are also added to all training jobs that the\n tuning job launches.

" } } } @@ -5315,7 +5321,7 @@ "ClientToken": { "target": "com.amazonaws.sagemaker#ClientToken", "traits": { - "smithy.api#documentation": "

A unique ID. If not specified, the AWS CLI and AWS SDKs, such as the SDK for Python\n (Boto3), add a unique value to the call.

", + "smithy.api#documentation": "

A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python\n (Boto3), add a unique value to the call.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -5357,7 +5363,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a job that uses workers to label the data objects in your input dataset. You\n can use the labeled data to train machine learning models.

\n

You can select your workforce from one of three providers:

\n \n

You can also use automated data labeling to reduce the number of\n data objects that need to be labeled by a human. Automated data labeling uses\n active learning to determine if a data object can be labeled by\n machine or if it needs to be sent to a human worker. For more information, see Using\n Automated Data Labeling.

\n

The data objects to be labeled are contained in an Amazon S3 bucket. You create a\n manifest file that describes the location of each object. For\n more information, see Using Input and Output Data.

\n

The output can be used as the manifest file for another labeling job or as training\n data for your machine learning models.

\n

You can use this operation to create a static labeling job or a streaming labeling\n job. A static labeling job stops if all data objects in the input manifest file\n identified in ManifestS3Uri have been labeled. A streaming labeling job\n runs perpetually until it is manually stopped, or remains idle for 10 days. You can send\n new data objects to an active (InProgress) streaming labeling job in real\n time. To learn how to create a static labeling job, see Create a Labeling Job\n (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming\n labeling job, see Create a Streaming Labeling\n Job.

" + "smithy.api#documentation": "

Creates a job that uses workers to label the data objects in your input dataset. You\n can use the labeled data to train machine learning models.

\n

You can select your workforce from one of three providers:

\n \n

You can also use automated data labeling to reduce the number of\n data objects that need to be labeled by a human. Automated data labeling uses\n active learning to determine if a data object can be labeled by\n machine or if it needs to be sent to a human worker. For more information, see Using\n Automated Data Labeling.

\n

The data objects to be labeled are contained in an Amazon S3 bucket. You create a\n manifest file that describes the location of each object. For\n more information, see Using Input and Output Data.

\n

The output can be used as the manifest file for another labeling job or as training\n data for your machine learning models.

\n

You can use this operation to create a static labeling job or a streaming labeling\n job. A static labeling job stops if all data objects in the input manifest file\n identified in ManifestS3Uri have been labeled. A streaming labeling job\n runs perpetually until it is manually stopped, or remains idle for 10 days. You can send\n new data objects to an active (InProgress) streaming labeling job in real\n time. To learn how to create a static labeling job, see Create a Labeling Job\n (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming\n labeling job, see Create a Streaming Labeling\n Job.

" } }, "com.amazonaws.sagemaker#CreateLabelingJobRequest": { @@ -5366,7 +5372,7 @@ "LabelingJobName": { "target": "com.amazonaws.sagemaker#LabelingJobName", "traits": { - "smithy.api#documentation": "

The name of the labeling job. This name is used to identify the job in a list of\n labeling jobs. Labeling job names must be unique within an AWS account and region.\n LabelingJobName is not case sensitive. For example, Example-job and\n example-job are considered the same labeling job name by Ground Truth.

", + "smithy.api#documentation": "

The name of the labeling job. This name is used to identify the job in a list of\n labeling jobs. Labeling job names must be unique within an Amazon Web Services account and region.\n LabelingJobName is not case sensitive. For example, Example-job and\n example-job are considered the same labeling job name by Ground Truth.

", "smithy.api#required": {} } }, @@ -5387,7 +5393,7 @@ "OutputConfig": { "target": "com.amazonaws.sagemaker#LabelingJobOutputConfig", "traits": { - "smithy.api#documentation": "

The location of the output data and the AWS Key Management Service key ID for the key used to encrypt\n the output data, if any.

", + "smithy.api#documentation": "

The location of the output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt\n the output data, if any.

", "smithy.api#required": {} } }, @@ -5426,7 +5432,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management\n User Guide.

" + "smithy.api#documentation": "

An array of key/value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management\n User Guide.

" } } } @@ -5457,7 +5463,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a model in Amazon SageMaker. In the request, you name the model and describe a primary\n container. For the primary container, you specify the Docker image that\n contains inference code, artifacts (from prior training), and a custom environment map\n that the inference code uses when you deploy the model for predictions.

\n

Use this API to create a model if you want to use Amazon SageMaker hosting services or run a batch\n transform job.

\n

To host your model, you create an endpoint configuration with the\n CreateEndpointConfig API, and then create an endpoint with the\n CreateEndpoint API. Amazon SageMaker then deploys all of the containers that you\n defined for the model in the hosting environment.

\n

For an example that calls this method when deploying a model to Amazon SageMaker hosting services,\n see Deploy the\n Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto\n 3)).\n

\n

To run a batch transform using your model, you start a job with the\n CreateTransformJob API. Amazon SageMaker uses your model and your dataset to get\n inferences which are then saved to a specified S3 location.

\n

In the CreateModel request, you must define a container with the\n PrimaryContainer parameter.

\n

In the request, you also provide an IAM role that Amazon SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute hosting instances or for batch\n transform jobs. In addition, you also use the IAM role to manage permissions the\n inference code needs. For example, if the inference code access any other AWS resources,\n you grant necessary permissions via this role.

" + "smithy.api#documentation": "

Creates a model in Amazon SageMaker. In the request, you name the model and describe a primary\n container. For the primary container, you specify the Docker image that\n contains inference code, artifacts (from prior training), and a custom environment map\n that the inference code uses when you deploy the model for predictions.

\n

Use this API to create a model if you want to use Amazon SageMaker hosting services or run a batch\n transform job.

\n

To host your model, you create an endpoint configuration with the\n CreateEndpointConfig API, and then create an endpoint with the\n CreateEndpoint API. Amazon SageMaker then deploys all of the containers that you\n defined for the model in the hosting environment.

\n

For an example that calls this method when deploying a model to Amazon SageMaker hosting services,\n see Deploy the\n Model to Amazon SageMaker Hosting Services (Amazon Web Services SDK for Python (Boto\n 3)).\n

\n

To run a batch transform using your model, you start a job with the\n CreateTransformJob API. Amazon SageMaker uses your model and your dataset to get\n inferences which are then saved to a specified S3 location.

\n

In the CreateModel request, you must define a container with the\n PrimaryContainer parameter.

\n

In the request, you also provide an IAM role that Amazon SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute hosting instances or for batch\n transform jobs. In addition, you also use the IAM role to manage permissions the\n inference code needs. For example, if the inference code access any other Amazon Web Services resources,\n you grant necessary permissions via this role.

" } }, "com.amazonaws.sagemaker#CreateModelBiasJobDefinition": { @@ -5486,7 +5492,7 @@ "JobDefinitionName": { "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", "traits": { - "smithy.api#documentation": "

The name of the bias job definition. The name must be unique within an AWS Region in the\n AWS account.

", + "smithy.api#documentation": "

The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the\n Amazon Web Services account.

", "smithy.api#required": {} } }, @@ -5541,7 +5547,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management\n User Guide.

" + "smithy.api#documentation": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management\n User Guide.

" } } } @@ -5584,7 +5590,7 @@ "JobDefinitionName": { "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", "traits": { - "smithy.api#documentation": "

The name of the model explainability job definition. The name must be unique within an\n AWS Region in the AWS account.

", + "smithy.api#documentation": "

The name of the model explainability job definition. The name must be unique within an\n Amazon Web Services Region in the Amazon Web Services account.

", "smithy.api#required": {} } }, @@ -5639,7 +5645,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management\n User Guide.

" + "smithy.api#documentation": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management\n User Guide.

" } } } @@ -5694,7 +5700,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your AWS resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging AWS\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" } }, "VpcConfig": { @@ -5740,7 +5746,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a model package that you can use to create Amazon SageMaker models or list on AWS\n Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to\n model packages listed on AWS Marketplace to create models in Amazon SageMaker.

\n

To create a model package by specifying a Docker container that contains your\n inference code and the Amazon S3 location of your model artifacts, provide values for\n InferenceSpecification. To create a model from an algorithm resource\n that you created or subscribed to in AWS Marketplace, provide a value for\n SourceAlgorithmSpecification.

\n \n

There are two types of model packages:

\n \n " + "smithy.api#documentation": "

Creates a model package that you can use to create Amazon SageMaker models or list on Amazon Web Services\n Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to\n model packages listed on Amazon Web Services Marketplace to create models in Amazon SageMaker.

\n

To create a model package by specifying a Docker container that contains your\n inference code and the Amazon S3 location of your model artifacts, provide values for\n InferenceSpecification. To create a model from an algorithm resource\n that you created or subscribed to in Amazon Web Services Marketplace, provide a value for\n SourceAlgorithmSpecification.

\n \n

There are two types of model packages:

\n \n " } }, "com.amazonaws.sagemaker#CreateModelPackageGroup": { @@ -5779,7 +5785,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

A list of key value pairs associated with the model group. For more information, see\n Tagging AWS\n resources in the AWS General Reference Guide.

" + "smithy.api#documentation": "

A list of key value pairs associated with the model group. For more information, see\n Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.

" } } } @@ -5838,13 +5844,13 @@ "CertifyForMarketplace": { "target": "com.amazonaws.sagemaker#CertifyForMarketplace", "traits": { - "smithy.api#documentation": "

Whether to certify the model package for listing on AWS Marketplace.

\n

This parameter is optional for unversioned models, and does not apply to versioned\n models.

" + "smithy.api#documentation": "

Whether to certify the model package for listing on Amazon Web Services Marketplace.

\n

This parameter is optional for unversioned models, and does not apply to versioned\n models.

" } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

A list of key value pairs associated with the model. For more information, see Tagging AWS\n resources in the AWS General Reference Guide.

" + "smithy.api#documentation": "

A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.

" } }, "ModelApprovalStatus": { @@ -5964,7 +5970,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management\n User Guide.

" + "smithy.api#documentation": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management\n User Guide.

" } } } @@ -6007,7 +6013,7 @@ "MonitoringScheduleName": { "target": "com.amazonaws.sagemaker#MonitoringScheduleName", "traits": { - "smithy.api#documentation": "

The name of the monitoring schedule. The name must be unique within an AWS Region within\n an AWS account.

", + "smithy.api#documentation": "

The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within\n an Amazon Web Services account.

", "smithy.api#required": {} } }, @@ -6021,7 +6027,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management\n User Guide.

" + "smithy.api#documentation": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management\n User Guide.

" } } } @@ -6087,20 +6093,20 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

When you send any requests to AWS resources from the notebook instance, Amazon SageMaker\n assumes this role to perform tasks on your behalf. You must grant this role necessary\n permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service\n principal (sagemaker.amazonaws.com) permissions to assume this role. For more\n information, see Amazon SageMaker Roles.

\n \n

To be able to pass this role to Amazon SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n ", + "smithy.api#documentation": "

When you send any requests to Amazon Web Services resources from the notebook instance, Amazon SageMaker\n assumes this role to perform tasks on your behalf. You must grant this role necessary\n permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service\n principal (sagemaker.amazonaws.com) permissions to assume this role. For more\n information, see Amazon SageMaker Roles.

\n \n

To be able to pass this role to Amazon SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n ", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to your notebook instance. The KMS key you provide must be\n enabled. For information, see Enabling and Disabling\n Keys in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to your notebook instance. The KMS key you provide must be\n enabled. For information, see Enabling and Disabling\n Keys in the Amazon Web Services Key Management Service Developer Guide.

" } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your AWS resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging AWS\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" } }, "LifecycleConfigName": { @@ -6130,13 +6136,13 @@ "DefaultCodeRepository": { "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "

A Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in AWS CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

" + "smithy.api#documentation": "

A Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

" } }, "AdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { - "smithy.api#documentation": "

An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in AWS CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

" + "smithy.api#documentation": "

An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in Amazon Web Services CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

" } }, "RootAccess": { @@ -6307,7 +6313,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser,\n the user will be automatically signed in to Amazon SageMaker Studio, and granted access to all of\n the Apps and files associated with the Domain's Amazon Elastic File System (EFS) volume.\n This operation can only be called when the authentication mode equals IAM.\n

\n \n

The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you\n are directed to the AWS console sign-in page.

\n " + "smithy.api#documentation": "

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser,\n the user will be automatically signed in to Amazon SageMaker Studio, and granted access to all of\n the Apps and files associated with the Domain's Amazon Elastic File System (EFS) volume.\n This operation can only be called when the authentication mode equals IAM.\n

\n

The IAM role or user used to call this API defines the permissions to access the app. Once\n the presigned URL is created, no additional permission is required to access this URL. IAM\n authorization policies for this API are also enforced for every HTTP request and WebSocket\n frame that attempts to connect to the app.

\n

You can restrict access to this API and to the\n URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more\n information, see Connect to SageMaker Studio Through an Interface VPC Endpoint\n .

\n \n

The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you\n are directed to the Amazon Web Services console sign-in page.

\n " } }, "com.amazonaws.sagemaker#CreatePresignedDomainUrlRequest": { @@ -6361,7 +6367,7 @@ "target": "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlOutput" }, "traits": { - "smithy.api#documentation": "

Returns a URL that you can use to connect to the Jupyter server from a notebook\n instance. In the Amazon SageMaker console, when you choose Open next to a notebook\n instance, Amazon SageMaker opens a new tab showing the Jupyter server home page from the notebook\n instance. The console uses this API to get the URL and show the page.

\n

The IAM role or user used to call this API defines the permissions to access the\n notebook instance. Once the presigned URL is created, no additional permission is\n required to access this URL. IAM authorization policies for this API are also enforced\n for every HTTP request and WebSocket frame that attempts to connect to the notebook\n instance.

\n

You can restrict access to this API and to the URL that it returns to a list of IP\n addresses that you specify. Use the NotIpAddress condition operator and the\n aws:SourceIP condition context key to specify the list of IP addresses\n that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

\n \n

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If\n you try to use the URL after the 5-minute limit expires, you are directed to the\n AWS console sign-in page.

\n " + "smithy.api#documentation": "

Returns a URL that you can use to connect to the Jupyter server from a notebook\n instance. In the Amazon SageMaker console, when you choose Open next to a notebook\n instance, Amazon SageMaker opens a new tab showing the Jupyter server home page from the notebook\n instance. The console uses this API to get the URL and show the page.

\n

The IAM role or user used to call this API defines the permissions to access the\n notebook instance. Once the presigned URL is created, no additional permission is\n required to access this URL. IAM authorization policies for this API are also enforced\n for every HTTP request and WebSocket frame that attempts to connect to the notebook\n instance.

\n

You can restrict access to this API and to the URL that it returns to a list of IP\n addresses that you specify. Use the NotIpAddress condition operator and the\n aws:SourceIP condition context key to specify the list of IP addresses\n that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

\n \n

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If\n you try to use the URL after the 5-minute limit expires, you are directed to the\n Amazon Web Services console sign-in page.

\n " } }, "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlInput": { @@ -6434,7 +6440,7 @@ "ProcessingJobName": { "target": "com.amazonaws.sagemaker#ProcessingJobName", "traits": { - "smithy.api#documentation": "

The name of the processing job. The name must be unique within an AWS Region in the\n AWS account.

", + "smithy.api#documentation": "

The name of the processing job. The name must be unique within an Amazon Web Services Region in the\n Amazon Web Services account.

", "smithy.api#required": {} } }, @@ -6480,7 +6486,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management\n User Guide.

" + "smithy.api#documentation": "

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management\n User Guide.

" } }, "ExperimentConfig": { @@ -6536,14 +6542,14 @@ "ServiceCatalogProvisioningDetails": { "target": "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails", "traits": { - "smithy.api#documentation": "

The product ID and provisioning artifact ID to provision a service catalog. For\n information, see What is AWS Service\n Catalog.

", + "smithy.api#documentation": "

The product ID and provisioning artifact ID to provision a service catalog. For\n information, see What is Amazon Web Services Service\n Catalog.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs that you want to use to organize and track your AWS\n resource costs. For more information, see Tagging AWS resources in the AWS General Reference Guide.

" + "smithy.api#documentation": "

An array of key-value pairs that you want to use to organize and track your Amazon Web Services\n resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

" } } } @@ -6596,7 +6602,7 @@ "TrainingJobName": { "target": "com.amazonaws.sagemaker#TrainingJobName", "traits": { - "smithy.api#documentation": "

The name of the training job. The name must be unique within an AWS Region in an\n AWS account.

", + "smithy.api#documentation": "

The name of the training job. The name must be unique within an Amazon Web Services Region in an\n Amazon Web Services account.

", "smithy.api#required": {} } }, @@ -6623,7 +6629,7 @@ "InputDataConfig": { "target": "com.amazonaws.sagemaker#InputDataConfig", "traits": { - "smithy.api#documentation": "

An array of Channel objects. Each channel is a named input source.\n InputDataConfig\n \n describes the input data and its location.

\n

Algorithms can accept input data from one or more channels. For example, an\n algorithm might have two channels of input data, training_data and\n validation_data. The configuration for each channel provides the S3,\n EFS, or FSx location where the input data is stored. It also provides information about\n the stored data: the MIME type, compression method, and whether the data is wrapped in\n RecordIO format.

\n

Depending on the input mode that the algorithm supports, Amazon SageMaker either copies input\n data files from an S3 bucket to a local directory in the Docker container, or makes it\n available as input streams. For example, if you specify an EFS location, input data\n files will be made available as input streams. They do not need to be\n downloaded.

" + "smithy.api#documentation": "

An array of Channel objects. Each channel is a named input source.\n InputDataConfig\n describes the input data and its location.

\n

Algorithms can accept input data from one or more channels. For example, an\n algorithm might have two channels of input data, training_data and\n validation_data. The configuration for each channel provides the S3,\n EFS, or FSx location where the input data is stored. It also provides information about\n the stored data: the MIME type, compression method, and whether the data is wrapped in\n RecordIO format.

\n

Depending on the input mode that the algorithm supports, Amazon SageMaker either copies input\n data files from an S3 bucket to a local directory in the Docker container, or makes it\n available as input streams. For example, if you specify an EFS location, input data\n files will be made available as input streams. They do not need to be\n downloaded.

" } }, "OutputDataConfig": { @@ -6656,7 +6662,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your AWS resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging AWS\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" } }, "EnableNetworkIsolation": { @@ -6753,7 +6759,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a transform job. A transform job uses a trained model to get inferences on a\n dataset and saves these results to an Amazon S3 location that you specify.

\n

To perform batch transformations, you create a transform job and use the data that you\n have readily available.

\n

In the request body, you provide the following:

\n \n

For more information about how batch transformation works, see Batch\n Transform.

" + "smithy.api#documentation": "

Starts a transform job. A transform job uses a trained model to get inferences on a\n dataset and saves these results to an Amazon S3 location that you specify.

\n

To perform batch transformations, you create a transform job and use the data that you\n have readily available.

\n

In the request body, you provide the following:

\n \n

For more information about how batch transformation works, see Batch\n Transform.

" } }, "com.amazonaws.sagemaker#CreateTransformJobRequest": { @@ -6762,14 +6768,14 @@ "TransformJobName": { "target": "com.amazonaws.sagemaker#TransformJobName", "traits": { - "smithy.api#documentation": "

The name of the transform job. The name must be unique within an AWS Region in an\n AWS account.

", + "smithy.api#documentation": "

The name of the transform job. The name must be unique within an Amazon Web Services Region in an\n Amazon Web Services account.

", "smithy.api#required": {} } }, "ModelName": { "target": "com.amazonaws.sagemaker#ModelName", "traits": { - "smithy.api#documentation": "

The name of the model that you want to use for the transform job.\n ModelName must be the name of an existing Amazon SageMaker model within an AWS\n Region in an AWS account.

", + "smithy.api#documentation": "

The name of the model that you want to use for the transform job.\n ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services\n Region in an Amazon Web Services account.

", "smithy.api#required": {} } }, @@ -6833,7 +6839,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

(Optional)\n An\n array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide.

" + "smithy.api#documentation": "

(Optional)\n An\n array of key-value pairs. For more information, see Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide.

" } }, "ExperimentConfig": { @@ -6870,7 +6876,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an SageMaker trial. A trial is a set of steps called\n trial components that produce a machine learning model. A trial is part\n of a single SageMaker experiment.

\n

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.

\n

You can add tags to a trial and then use the Search API to search for\n the tags.

\n

To get a list of all your trials, call the ListTrials API. To view a\n trial's properties, call the DescribeTrial API. To create a trial component,\n call the CreateTrialComponent API.

" + "smithy.api#documentation": "

Creates an SageMaker trial. A trial is a set of steps called\n trial components that produce a machine learning model. A trial is part\n of a single SageMaker experiment.

\n

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.

\n

You can add tags to a trial and then use the Search API to search for\n the tags.

\n

To get a list of all your trials, call the ListTrials API. To view a\n trial's properties, call the DescribeTrial API. To create a trial component,\n call the CreateTrialComponent API.

" } }, "com.amazonaws.sagemaker#CreateTrialComponent": { @@ -6887,7 +6893,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a trial component, which is a stage of a machine learning\n trial. A trial is composed of one or more trial components. A trial\n component can be used in multiple trials.

\n

Trial components include pre-processing jobs, training jobs, and batch transform\n jobs.

\n

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.

\n

You can add tags to a trial component and then use the Search API to\n search for the tags.

\n \n

\n CreateTrialComponent can only be invoked from within an SageMaker managed\n environment. This includes SageMaker training jobs, processing jobs, transform jobs, and SageMaker\n notebooks. A call to CreateTrialComponent from outside one of these\n environments results in an error.

\n " + "smithy.api#documentation": "

Creates a trial component, which is a stage of a machine learning\n trial. A trial is composed of one or more trial components. A trial\n component can be used in multiple trials.

\n

Trial components include pre-processing jobs, training jobs, and batch transform\n jobs.

\n

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.

\n

You can add tags to a trial component and then use the Search API to\n search for the tags.

" } }, "com.amazonaws.sagemaker#CreateTrialComponentRequest": { @@ -6896,7 +6902,7 @@ "TrialComponentName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

The name of the component. The name must be unique in your AWS account and is not\n case-sensitive.

", + "smithy.api#documentation": "

The name of the component. The name must be unique in your Amazon Web Services account and is not\n case-sensitive.

", "smithy.api#required": {} } }, @@ -6970,7 +6976,7 @@ "TrialName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

The name of the trial. The name must be unique in your AWS account and is not\n case-sensitive.

", + "smithy.api#documentation": "

The name of the trial. The name must be unique in your Amazon Web Services account and is not\n case-sensitive.

", "smithy.api#required": {} } }, @@ -7055,7 +7061,7 @@ "SingleSignOnUserValue": { "target": "com.amazonaws.sagemaker#String256", "traits": { - "smithy.api#documentation": "

The username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is\n required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.\n

" + "smithy.api#documentation": "

The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is\n required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.\n

" } }, "Tags": { @@ -7092,7 +7098,7 @@ "target": "com.amazonaws.sagemaker#CreateWorkforceResponse" }, "traits": { - "smithy.api#documentation": "

Use this operation to create a workforce. This operation will return an error\n if a workforce already exists in the AWS Region that you specify. You can only\n create one workforce in each AWS Region per AWS account.

\n\n

If you want to create a new workforce in an AWS Region where \n a workforce already exists, use the API\n operation to delete the existing workforce and then use CreateWorkforce \n to create a new workforce.

\n\n

To create a private workforce using Amazon Cognito, you must specify a Cognito user pool\n in CognitoConfig.\n You can also create an Amazon Cognito workforce using the Amazon SageMaker console. \n For more information, see \n \n Create a Private Workforce (Amazon Cognito).

\n\n

To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP\n configuration in OidcConfig. Your OIDC IdP must support groups\n because groups are used by Ground Truth and Amazon A2I to create work teams. \n For more information, see \n Create a Private Workforce (OIDC IdP).

" + "smithy.api#documentation": "

Use this operation to create a workforce. This operation will return an error\n if a workforce already exists in the Amazon Web Services Region that you specify. You can only\n create one workforce in each Amazon Web Services Region per Amazon Web Services account.

\n\n

If you want to create a new workforce in an Amazon Web Services Region where \n a workforce already exists, use the API\n operation to delete the existing workforce and then use CreateWorkforce \n to create a new workforce.

\n\n

To create a private workforce using Amazon Cognito, you must specify a Cognito user pool\n in CognitoConfig.\n You can also create an Amazon Cognito workforce using the Amazon SageMaker console. \n For more information, see \n \n Create a Private Workforce (Amazon Cognito).

\n\n

To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP\n configuration in OidcConfig. Your OIDC IdP must support groups\n because groups are used by Ground Truth and Amazon A2I to create work teams. \n For more information, see \n Create a Private Workforce (OIDC IdP).

" } }, "com.amazonaws.sagemaker#CreateWorkforceRequest": { @@ -7199,7 +7205,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs.

\n

For more information, see Resource\n Tag and Using\n Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide.

" + "smithy.api#documentation": "

An array of key-value pairs.

\n

For more information, see Resource\n Tag and Using\n Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User\n Guide.

" } } } @@ -8241,7 +8247,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delete the FeatureGroup and any data that was written to the\n OnlineStore of the FeatureGroup. Data cannot be accessed from\n the OnlineStore immediately after DeleteFeatureGroup is called.

\n

Data written into the OfflineStore will not be deleted. The AWS Glue\n database and tables that are automatically created for your OfflineStore are\n not deleted.

" + "smithy.api#documentation": "

Delete the FeatureGroup and any data that was written to the\n OnlineStore of the FeatureGroup. Data cannot be accessed from\n the OnlineStore immediately after DeleteFeatureGroup is called.

\n

Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue\n database and tables that are automatically created for your OfflineStore are\n not deleted.

" } }, "com.amazonaws.sagemaker#DeleteFeatureGroupRequest": { @@ -8250,7 +8256,7 @@ "FeatureGroupName": { "target": "com.amazonaws.sagemaker#FeatureGroupName", "traits": { - "smithy.api#documentation": "

The name of the FeatureGroup you want to delete. The name must be unique\n within an AWS Region in an AWS account.

", + "smithy.api#documentation": "

The name of the FeatureGroup you want to delete. The name must be unique\n within an Amazon Web Services Region in an Amazon Web Services account.

", "smithy.api#required": {} } } @@ -8410,7 +8416,7 @@ "target": "com.amazonaws.sagemaker#DeleteModelInput" }, "traits": { - "smithy.api#documentation": "

Deletes a model. The DeleteModel API deletes only the model entry that\n was created in Amazon SageMaker when you called the CreateModel API. It does not\n delete model artifacts, inference code, or the IAM role that you specified when\n creating the model.

" + "smithy.api#documentation": "

Deletes a model. The DeleteModel API deletes only the model entry that\n was created in Amazon SageMaker when you called the CreateModel API. It does not\n delete model artifacts, inference code, or the IAM role that you specified when\n creating the model.

" } }, "com.amazonaws.sagemaker#DeleteModelBiasJobDefinition": { @@ -8488,7 +8494,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a model package.

\n

A model package is used to create Amazon SageMaker models or list on AWS Marketplace. Buyers can\n subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.

" + "smithy.api#documentation": "

Deletes a model package.

\n

A model package is used to create Amazon SageMaker models or list on Amazon Web Services Marketplace. Buyers can\n subscribe to model packages listed on Amazon Web Services Marketplace to create models in Amazon SageMaker.

" } }, "com.amazonaws.sagemaker#DeleteModelPackageGroup": { @@ -8496,6 +8502,11 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteModelPackageGroupInput" }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], "traits": { "smithy.api#documentation": "

Deletes the specified model group.

" } @@ -8692,6 +8703,11 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteProjectInput" }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + } + ], "traits": { "smithy.api#documentation": "

Delete the specified project.

" } @@ -8868,7 +8884,7 @@ "target": "com.amazonaws.sagemaker#DeleteWorkforceResponse" }, "traits": { - "smithy.api#documentation": "

Use this operation to delete a workforce.

\n\n

If you want to create a new workforce in an AWS Region where\n a workforce already exists, use this operation to delete the \n existing workforce and then use \n to create a new workforce.

\n \n

If a private workforce contains one or more work teams, you must use \n the \n operation to delete all work teams before you delete the workforce.\n If you try to delete a workforce that contains one or more work teams,\n you will recieve a ResourceInUse error.

\n " + "smithy.api#documentation": "

Use this operation to delete a workforce.

\n\n

If you want to create a new workforce in an Amazon Web Services Region where\n a workforce already exists, use this operation to delete the \n existing workforce and then use \n to create a new workforce.

\n \n

If a private workforce contains one or more work teams, you must use \n the \n operation to delete all work teams before you delete the workforce.\n If you try to delete a workforce that contains one or more work teams,\n you will recieve a ResourceInUse error.

\n " } }, "com.amazonaws.sagemaker#DeleteWorkforceRequest": { @@ -9202,7 +9218,7 @@ "CertifyForMarketplace": { "target": "com.amazonaws.sagemaker#CertifyForMarketplace", "traits": { - "smithy.api#documentation": "

Whether the algorithm is certified to be listed in AWS Marketplace.

" + "smithy.api#documentation": "

Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.

" } } } @@ -9540,7 +9556,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that has read permission to\n the input data location and write permission to the output data location in Amazon S3.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that has read permission to\n the input data location and write permission to the output data location in Amazon S3.

", "smithy.api#required": {} } }, @@ -9704,7 +9720,7 @@ "GitConfig": { "target": "com.amazonaws.sagemaker#GitConfig", "traits": { - "smithy.api#documentation": "

Configuration details about the repository, including the URL where the repository is\n located, the default branch, and the Amazon Resource Name (ARN) of the AWS Secrets\n Manager secret that contains the credentials used to access the repository.

" + "smithy.api#documentation": "

Configuration details about the repository, including the URL where the repository is\n located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets\n Manager secret that contains the credentials used to access the repository.

" } } } @@ -9781,6 +9797,12 @@ "smithy.api#required": {} } }, + "InferenceImage": { + "target": "com.amazonaws.sagemaker#InferenceImage", + "traits": { + "smithy.api#documentation": "

The inference image to use when compiling a model. \n Specify an image only if the target device is a cloud instance.

" + } + }, "CreationTime": { "target": "com.amazonaws.sagemaker#CreationTime", "traits": { @@ -9835,6 +9857,12 @@ "smithy.api#documentation": "

Information about the output location for the compiled model and the target device\n that the model runs on.

", "smithy.api#required": {} } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#NeoVpcConfig", + "traits": { + "smithy.api#documentation": "

A VpcConfig object that specifies the VPC that you want your\n compilation job to connect to. Control access to your models by\n configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon\n Virtual Private Cloud.

" + } } } }, @@ -10122,13 +10150,13 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

" } }, "IotRoleAlias": { "target": "com.amazonaws.sagemaker#IotRoleAlias", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) alias created in AWS Internet of Things (IoT).

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).

" } } } @@ -10190,7 +10218,7 @@ "IotThingName": { "target": "com.amazonaws.sagemaker#ThingName", "traits": { - "smithy.api#documentation": "

The AWS Internet of Things (IoT) object thing name associated with the device.

" + "smithy.api#documentation": "

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.

" } }, "RegistrationTime": { @@ -10360,7 +10388,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS KMS customer managed CMK used to encrypt\n the EFS volume attached to the domain.

" + "smithy.api#documentation": "

The Amazon Web Services KMS customer managed CMK used to encrypt\n the EFS volume attached to the domain.

" } } } @@ -10501,7 +10529,64 @@ "target": "com.amazonaws.sagemaker#DescribeEndpointOutput" }, "traits": { - "smithy.api#documentation": "

Returns the description of an endpoint.

" + "smithy.api#documentation": "

Returns the description of an endpoint.

", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "EndpointDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "ValidationException" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "EndpointStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + }, + "EndpointInService": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "EndpointStatus", + "expected": "InService", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "EndpointStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 30 + } + } } }, "com.amazonaws.sagemaker#DescribeEndpointConfig": { @@ -10558,7 +10643,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage\n volume attached to the instance.

" + "smithy.api#documentation": "

Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage\n volume attached to the instance.

" } }, "CreationTime": { @@ -10827,7 +10912,7 @@ "OfflineStoreConfig": { "target": "com.amazonaws.sagemaker#OfflineStoreConfig", "traits": { - "smithy.api#documentation": "

The configuration of the OfflineStore, inducing the S3 location of the\n OfflineStore, AWS Glue or AWS Hive data catalogue configurations, and the\n security configuration.

" + "smithy.api#documentation": "

The configuration of the OfflineStore, inducing the S3 location of the\n OfflineStore, Amazon Web Services Glue or Amazon Web Services Hive data catalogue configurations, and the\n security configuration.

" } }, "RoleArn": { @@ -10958,7 +11043,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) execution role for the flow definition.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.

", "smithy.api#required": {} } }, @@ -11453,7 +11538,7 @@ "OutputConfig": { "target": "com.amazonaws.sagemaker#LabelingJobOutputConfig", "traits": { - "smithy.api#documentation": "

The location of the job's output data and the AWS Key Management Service key ID for the key used to\n encrypt the output data, if any.

", + "smithy.api#documentation": "

The location of the job's output data and the Amazon Web Services Key Management Service key ID for the key used to\n encrypt the output data, if any.

", "smithy.api#required": {} } }, @@ -11492,7 +11577,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your AWS resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging AWS\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" } }, "LabelingJobOutput": { @@ -11538,7 +11623,7 @@ "JobDefinitionName": { "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", "traits": { - "smithy.api#documentation": "

The name of the model bias job definition. The name must be unique within an AWS Region\n in the AWS account.

", + "smithy.api#documentation": "

The name of the model bias job definition. The name must be unique within an Amazon Web Services Region\n in the Amazon Web Services account.

", "smithy.api#required": {} } } @@ -11557,7 +11642,7 @@ "JobDefinitionName": { "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", "traits": { - "smithy.api#documentation": "

The name of the bias job definition. The name must be unique within an AWS Region in the\n AWS account.

", + "smithy.api#documentation": "

The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the\n Amazon Web Services account.

", "smithy.api#required": {} } }, @@ -11609,7 +11694,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n has read permission to the input data location and write permission to the output data\n location in Amazon S3.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that\n has read permission to the input data location and write permission to the output data\n location in Amazon S3.

", "smithy.api#required": {} } }, @@ -11641,7 +11726,7 @@ "JobDefinitionName": { "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", "traits": { - "smithy.api#documentation": "

The name of the model explainability job definition. The name must be unique within an\n AWS Region in the AWS account.

", + "smithy.api#documentation": "

The name of the model explainability job definition. The name must be unique within an\n Amazon Web Services Region in the Amazon Web Services account.

", "smithy.api#required": {} } } @@ -11660,7 +11745,7 @@ "JobDefinitionName": { "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", "traits": { - "smithy.api#documentation": "

The name of the explainability job definition. The name must be unique within an AWS\n Region in the AWS account.

", + "smithy.api#documentation": "

The name of the explainability job definition. The name must be unique within an Amazon Web Services\n Region in the Amazon Web Services account.

", "smithy.api#required": {} } }, @@ -11712,7 +11797,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n has read permission to the input data location and write permission to the output data\n location in Amazon S3.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that\n has read permission to the input data location and write permission to the output data\n location in Amazon S3.

", "smithy.api#required": {} } }, @@ -11805,7 +11890,7 @@ "target": "com.amazonaws.sagemaker#DescribeModelPackageOutput" }, "traits": { - "smithy.api#documentation": "

Returns a description of the specified model package, which is used to create Amazon SageMaker\n models or list them on AWS Marketplace.

\n

To create models in Amazon SageMaker, buyers can subscribe to model packages listed on AWS\n Marketplace.

" + "smithy.api#documentation": "

Returns a description of the specified model package, which is used to create Amazon SageMaker\n models or list them on Amazon Web Services Marketplace.

\n

To create models in Amazon SageMaker, buyers can subscribe to model packages listed on Amazon Web Services\n Marketplace.

" } }, "com.amazonaws.sagemaker#DescribeModelPackageGroup": { @@ -11966,7 +12051,7 @@ "CertifyForMarketplace": { "target": "com.amazonaws.sagemaker#CertifyForMarketplace", "traits": { - "smithy.api#documentation": "

Whether the model package is certified for listing on AWS Marketplace.

" + "smithy.api#documentation": "

Whether the model package is certified for listing on Amazon Web Services Marketplace.

" } }, "ModelApprovalStatus": { @@ -12027,7 +12112,7 @@ "JobDefinitionName": { "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", "traits": { - "smithy.api#documentation": "

The name of the model quality job. The name must be unique within an AWS Region in the\n AWS account.

", + "smithy.api#documentation": "

The name of the model quality job. The name must be unique within an Amazon Web Services Region in the\n Amazon Web Services account.

", "smithy.api#required": {} } } @@ -12046,7 +12131,7 @@ "JobDefinitionName": { "target": "com.amazonaws.sagemaker#MonitoringJobDefinitionName", "traits": { - "smithy.api#documentation": "

The name of the quality job definition. The name must be unique within an AWS Region in\n the AWS account.

", + "smithy.api#documentation": "

The name of the quality job definition. The name must be unique within an Amazon Web Services Region in\n the Amazon Web Services account.

", "smithy.api#required": {} } }, @@ -12217,7 +12302,31 @@ }, "traits": { "smithy.api#documentation": "

Returns information about a notebook instance.

", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], "smithy.waiters#waitable": { + "NotebookInstanceDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "ValidationException" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "NotebookInstanceStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + }, "NotebookInstanceInService": { "acceptors": [ { @@ -12408,7 +12517,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage\n volume attached to the instance.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage\n volume attached to the instance.

" } }, "NetworkInterfaceId": { @@ -12456,13 +12565,13 @@ "DefaultCodeRepository": { "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "

The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in AWS CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

" + "smithy.api#documentation": "

The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

" } }, "AdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { - "smithy.api#documentation": "

An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in AWS CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

" + "smithy.api#documentation": "

An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in Amazon Web Services CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

" } }, "RootAccess": { @@ -12724,7 +12833,53 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a description of a processing job.

" + "smithy.api#documentation": "

Returns a description of a processing job.

", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "ProcessingJobCompletedOrStopped": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ProcessingJobStatus", + "expected": "Completed", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "ProcessingJobStatus", + "expected": "Stopped", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ProcessingJobStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 60 + } + } } }, "com.amazonaws.sagemaker#DescribeProcessingJobRequest": { @@ -12733,7 +12888,7 @@ "ProcessingJobName": { "target": "com.amazonaws.sagemaker#ProcessingJobName", "traits": { - "smithy.api#documentation": "

The name of the processing job. The name must be unique within an AWS Region in the\n AWS account.

", + "smithy.api#documentation": "

The name of the processing job. The name must be unique within an Amazon Web Services Region in the\n Amazon Web Services account.

", "smithy.api#required": {} } } @@ -12757,7 +12912,7 @@ "ProcessingJobName": { "target": "com.amazonaws.sagemaker#ProcessingJobName", "traits": { - "smithy.api#documentation": "

The name of the processing job. The name must be unique within an AWS Region in the\n AWS account.

", + "smithy.api#documentation": "

The name of the processing job. The name must be unique within an Amazon Web Services Region in the\n Amazon Web Services account.

", "smithy.api#required": {} } }, @@ -12933,7 +13088,7 @@ "ServiceCatalogProvisioningDetails": { "target": "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails", "traits": { - "smithy.api#documentation": "

Information used to provision a service catalog product. For information, see What is AWS Service\n Catalog.

", + "smithy.api#documentation": "

Information used to provision a service catalog product. For information, see What is Amazon Web Services Service\n Catalog.

", "smithy.api#required": {} } }, @@ -12971,7 +13126,7 @@ "target": "com.amazonaws.sagemaker#DescribeSubscribedWorkteamResponse" }, "traits": { - "smithy.api#documentation": "

Gets information about a work team provided by a vendor. It returns details about the\n subscription with a vendor in the AWS Marketplace.

" + "smithy.api#documentation": "

Gets information about a work team provided by a vendor. It returns details about the\n subscription with a vendor in the Amazon Web Services Marketplace.

" } }, "com.amazonaws.sagemaker#DescribeSubscribedWorkteamRequest": { @@ -13012,7 +13167,53 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about a training job.

\n

Some of the attributes below only appear if the training job successfully starts.\n If the training job fails, TrainingJobStatus is Failed and,\n depending on the FailureReason, attributes like\n TrainingStartTime, TrainingTimeInSeconds,\n TrainingEndTime, and BillableTimeInSeconds may not be\n present in the response.

" + "smithy.api#documentation": "

Returns information about a training job.

\n

Some of the attributes below only appear if the training job successfully starts.\n If the training job fails, TrainingJobStatus is Failed and,\n depending on the FailureReason, attributes like\n TrainingStartTime, TrainingTimeInSeconds,\n TrainingEndTime, and BillableTimeInSeconds may not be\n present in the response.

", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "TrainingJobCompletedOrStopped": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "TrainingJobStatus", + "expected": "Completed", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "TrainingJobStatus", + "expected": "Stopped", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "TrainingJobStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 120 + } + } } }, "com.amazonaws.sagemaker#DescribeTrainingJobRequest": { @@ -13105,7 +13306,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The AWS Identity and Access Management (IAM) role configured for the training job.

" + "smithy.api#documentation": "

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

" } }, "InputDataConfig": { @@ -13280,7 +13481,53 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about a transform job.

" + "smithy.api#documentation": "

Returns information about a transform job.

", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "TransformJobCompletedOrStopped": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "TransformJobStatus", + "expected": "Completed", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "TransformJobStatus", + "expected": "Stopped", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "TransformJobStatus", + "expected": "Failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationException" + } + } + ], + "minDelay": 60 + } + } } }, "com.amazonaws.sagemaker#DescribeTransformJobRequest": { @@ -13776,7 +14023,7 @@ "Workforce": { "target": "com.amazonaws.sagemaker#Workforce", "traits": { - "smithy.api#documentation": "

A single private workforce, which is automatically created when you create your first\n private work team. You can create one private work force in each AWS Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

", + "smithy.api#documentation": "

A single private workforce, which is automatically created when you create your first\n private work team. You can create one private work force in each Amazon Web Services Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

", "smithy.api#required": {} } } @@ -13940,7 +14187,7 @@ "IotThingName": { "target": "com.amazonaws.sagemaker#ThingName", "traits": { - "smithy.api#documentation": "

AWS Internet of Things (IoT) object name.

" + "smithy.api#documentation": "

Amazon Web Services Internet of Things (IoT) object name.

" } } }, @@ -14100,7 +14347,7 @@ "IotThingName": { "target": "com.amazonaws.sagemaker#ThingName", "traits": { - "smithy.api#documentation": "

The AWS Internet of Things (IoT) object thing name associated with the device..

" + "smithy.api#documentation": "

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..

" } }, "RegistrationTime": { @@ -14517,19 +14764,19 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. \n If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

" } }, "PresetDeploymentType": { "target": "com.amazonaws.sagemaker#EdgePresetDeploymentType", "traits": { - "smithy.api#documentation": "

The deployment type SageMaker Edge Manager will create. \n Currently only supports AWS IoT Greengrass Version 2 components.

" + "smithy.api#documentation": "

The deployment type SageMaker Edge Manager will create. \n Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

" } }, "PresetDeploymentConfig": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "

The configuration used to create deployment artifacts. \n Specify configuration options with a JSON string. The available configuration options for each type are:

\n " + "smithy.api#documentation": "

The configuration used to create deployment artifacts. \n Specify configuration options with a JSON string. The available configuration options for each type are:

\n " } } }, @@ -14658,7 +14905,7 @@ "Type": { "target": "com.amazonaws.sagemaker#EdgePresetDeploymentType", "traits": { - "smithy.api#documentation": "

The deployment type created by SageMaker Edge Manager. Currently only \n supports AWS IoT Greengrass Version 2 components.

", + "smithy.api#documentation": "

The deployment type created by SageMaker Edge Manager. Currently only \n supports Amazon Web Services IoT Greengrass Version 2 components.

", "smithy.api#required": {} } }, @@ -14829,7 +15076,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

A list of the tags associated with the endpoint. For more information, see Tagging AWS\n resources in the AWS General Reference Guide.

" + "smithy.api#documentation": "

A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.

" } } }, @@ -15880,7 +16127,7 @@ } }, "traits": { - "smithy.api#documentation": "

A conditional statement for a search expression that includes a resource property, a\n Boolean operator, and a value. Resources that match the statement are returned in the\n results from the Search API.

\n \n

If you specify a Value, but not an Operator, Amazon SageMaker uses the\n equals operator.

\n

In search, there are several property types:

\n
\n
Metrics
\n
\n

To define a metric filter, enter a value using the form\n \"Metrics.\", where is\n a metric name. For example, the following filter searches for training jobs\n with an \"accuracy\" metric greater than\n \"0.9\":

\n

\n {\n

\n

\n \"Name\": \"Metrics.accuracy\",\n

\n

\n \"Operator\": \"GreaterThan\",\n

\n

\n \"Value\": \"0.9\"\n

\n

\n }\n

\n
\n
HyperParameters
\n
\n

To define a hyperparameter filter, enter a value with the form\n \"HyperParameters.\". Decimal hyperparameter\n values are treated as a decimal in a comparison if the specified\n Value is also a decimal value. If the specified\n Value is an integer, the decimal hyperparameter values are\n treated as integers. For example, the following filter is satisfied by\n training jobs with a \"learning_rate\" hyperparameter that is\n less than \"0.5\":

\n

\n {\n

\n

\n \"Name\": \"HyperParameters.learning_rate\",\n

\n

\n \"Operator\": \"LessThan\",\n

\n

\n \"Value\": \"0.5\"\n

\n

\n }\n

\n
\n
Tags
\n
\n

To define a tag filter, enter a value with the form\n Tags..

\n
\n
" + "smithy.api#documentation": "

A conditional statement for a search expression that includes a resource property, a\n Boolean operator, and a value. Resources that match the statement are returned in the\n results from the Search API.

\n \n

If you specify a Value, but not an Operator, Amazon SageMaker uses the\n equals operator.

\n

In search, there are several property types:

\n
\n
Metrics
\n
\n

To define a metric filter, enter a value using the form\n \"Metrics.\", where is\n a metric name. For example, the following filter searches for training jobs\n with an \"accuracy\" metric greater than\n \"0.9\":

\n

\n {\n

\n

\n \"Name\": \"Metrics.accuracy\",\n

\n

\n \"Operator\": \"GreaterThan\",\n

\n

\n \"Value\": \"0.9\"\n

\n

\n }\n

\n
\n
HyperParameters
\n
\n

To define a hyperparameter filter, enter a value with the form\n \"HyperParameters.\". Decimal hyperparameter\n values are treated as a decimal in a comparison if the specified\n Value is also a decimal value. If the specified\n Value is an integer, the decimal hyperparameter values are\n treated as integers. For example, the following filter is satisfied by\n training jobs with a \"learning_rate\" hyperparameter that is\n less than \"0.5\":

\n

\n {\n

\n

\n \"Name\": \"HyperParameters.learning_rate\",\n

\n

\n \"Operator\": \"LessThan\",\n

\n

\n \"Value\": \"0.5\"\n

\n

\n }\n

\n
\n
Tags
\n
\n

To define a tag filter, enter a value with the form\n Tags..

\n
\n
" } }, "com.amazonaws.sagemaker#FilterList": { @@ -16304,7 +16551,7 @@ "target": "com.amazonaws.sagemaker#GetModelPackageGroupPolicyOutput" }, "traits": { - "smithy.api#documentation": "

Gets a resource policy that manages access for a model group. For information about\n resource policies, see Identity-based\n policies and resource-based policies in the AWS Identity and\n Access Management User Guide..

" + "smithy.api#documentation": "

Gets a resource policy that manages access for a model group. For information about\n resource policies, see Identity-based\n policies and resource-based policies in the Amazon Web Services Identity and\n Access Management User Guide..

" } }, "com.amazonaws.sagemaker#GetModelPackageGroupPolicyInput": { @@ -16418,12 +16665,12 @@ "SecretArn": { "target": "com.amazonaws.sagemaker#SecretArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the\n credentials used to access the git repository. The secret must have a staging label of\n AWSCURRENT and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the git repository. The secret must have a staging label of\n AWSCURRENT and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" } } }, "traits": { - "smithy.api#documentation": "

Specifies configuration details for a Git repository in your AWS account.

" + "smithy.api#documentation": "

Specifies configuration details for a Git repository in your Amazon Web Services account.

" } }, "com.amazonaws.sagemaker#GitConfigForUpdate": { @@ -16432,7 +16679,7 @@ "SecretArn": { "target": "com.amazonaws.sagemaker#SecretArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the\n credentials used to access the git repository. The secret must have a staging label of\n AWSCURRENT and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the\n credentials used to access the git repository. The secret must have a staging label of\n AWSCURRENT and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" } } }, @@ -16646,14 +16893,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": { @@ -17856,6 +18103,15 @@ ] } }, + "com.amazonaws.sagemaker#InferenceImage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, "com.amazonaws.sagemaker#InferenceSpecification": { "type": "structure", "members": { @@ -18590,7 +18846,7 @@ "WorkRequesterAccountId": { "target": "com.amazonaws.sagemaker#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID of the account used to start the labeling job.

", + "smithy.api#documentation": "

The Amazon Web Services account ID of the account used to start the labeling job.

", "smithy.api#required": {} } }, @@ -18689,7 +18945,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service ID of the key used to encrypt the output data, if any.

\n

If you provide your own KMS key ID, you must add the required permissions to your KMS\n key described in Encrypt Output Data and Storage Volume with AWS KMS.

\n

If you don't provide a KMS key ID, Amazon SageMaker uses the default AWS KMS key for Amazon S3 for your\n role's account to encrypt your output data.

\n

If you use a bucket policy with an s3:PutObject permission that only\n allows objects with server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer\n Guide.\n

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

\n

If you provide your own KMS key ID, you must add the required permissions to your KMS\n key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

\n

If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your\n role's account to encrypt your output data.

\n

If you use a bucket policy with an s3:PutObject permission that only\n allows objects with server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer\n Guide.\n

" } }, "SnsTopicArn": { @@ -18709,7 +18965,7 @@ "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume\n attached to the ML compute instance(s) that run the training and inference jobs used for\n automated data labeling.

\n

You can only specify a VolumeKmsKeyId when you create a labeling job with\n automated data labeling enabled using the API operation CreateLabelingJob.\n You cannot specify an AWS KMS customer managed CMK to encrypt the storage volume used for\n automated data labeling model training and inference when you create a labeling job\n using the console. To learn more, see Output Data and Storage Volume\n Encryption.

\n

The VolumeKmsKeyId can be any of the following formats:

\n " + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume\n attached to the ML compute instance(s) that run the training and inference jobs used for\n automated data labeling.

\n

You can only specify a VolumeKmsKeyId when you create a labeling job with\n automated data labeling enabled using the API operation CreateLabelingJob.\n You cannot specify an Amazon Web Services KMS customer managed CMK to encrypt the storage volume used for\n automated data labeling model training and inference when you create a labeling job\n using the console. To learn more, see Output Data and Storage Volume\n Encryption.

\n

The VolumeKmsKeyId can be any of the following formats:

\n " } } }, @@ -19736,7 +19992,7 @@ "CodeRepositorySummaryList": { "target": "com.amazonaws.sagemaker#CodeRepositorySummaryList", "traits": { - "smithy.api#documentation": "

Gets a list of summaries of the Git repositories. Each summary specifies the following\n values for the repository:

\n ", + "smithy.api#documentation": "

Gets a list of summaries of the Git repositories. Each summary specifies the following\n values for the repository:

\n ", "smithy.api#required": {} } }, @@ -21603,7 +21859,7 @@ "target": "com.amazonaws.sagemaker#ListModelPackageGroupsOutput" }, "traits": { - "smithy.api#documentation": "

Gets a list of the model groups in your AWS account.

", + "smithy.api#documentation": "

Gets a list of the model groups in your Amazon Web Services account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -21664,7 +21920,7 @@ "ModelPackageGroupSummaryList": { "target": "com.amazonaws.sagemaker#ModelPackageGroupSummaryList", "traits": { - "smithy.api#documentation": "

A list of summaries of the model groups in your AWS account.

", + "smithy.api#documentation": "

A list of summaries of the model groups in your Amazon Web Services account.

", "smithy.api#required": {} } }, @@ -21873,7 +22129,7 @@ "target": "com.amazonaws.sagemaker#ListModelsOutput" }, "traits": { - "smithy.api#documentation": "

Lists models created with the CreateModel API.

", + "smithy.api#documentation": "

Lists models created with the CreateModel API.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -22296,7 +22552,7 @@ "target": "com.amazonaws.sagemaker#ListNotebookInstancesOutput" }, "traits": { - "smithy.api#documentation": "

Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS\n Region.

", + "smithy.api#documentation": "

Returns a list of the Amazon SageMaker notebook instances in the requester's account in an Amazon Web Services\n Region.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -22813,7 +23069,7 @@ "target": "com.amazonaws.sagemaker#ListProjectsOutput" }, "traits": { - "smithy.api#documentation": "

Gets a list of the projects in an AWS account.

", + "smithy.api#documentation": "

Gets a list of the projects in an Amazon Web Services account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -22895,7 +23151,7 @@ "target": "com.amazonaws.sagemaker#ListSubscribedWorkteamsResponse" }, "traits": { - "smithy.api#documentation": "

Gets a list of the work teams that you are subscribed to in the AWS Marketplace. The\n list may be empty if no work team satisfies the filter specified in the\n NameContains parameter.

", + "smithy.api#documentation": "

Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The\n list may be empty if no work team satisfies the filter specified in the\n NameContains parameter.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -23021,7 +23277,7 @@ "target": "com.amazonaws.sagemaker#ListTrainingJobsResponse" }, "traits": { - "smithy.api#documentation": "

Lists training jobs.

\n \n

When StatusEquals and MaxResults are set at the same\n time, the MaxResults number of training jobs are first retrieved\n ignoring the StatusEquals parameter and then they are filtered by the\n StatusEquals parameter, which is returned as a response.

\n

For example, if ListTrainingJobs is invoked with the following\n parameters:

\n

\n { ... MaxResults: 100, StatusEquals: InProgress ... }\n

\n

First, 100 trainings jobs with any status, including those other than\n InProgress, are selected (sorted according to the creation time,\n from the most current to the oldest). Next, those with a status of\n InProgress are returned.

\n

You can quickly test the API using the following AWS CLI code.

\n

\n aws sagemaker list-training-jobs --max-results 100 --status-equals\n InProgress\n

\n ", + "smithy.api#documentation": "

Lists training jobs.

\n \n

When StatusEquals and MaxResults are set at the same\n time, the MaxResults number of training jobs are first retrieved\n ignoring the StatusEquals parameter and then they are filtered by the\n StatusEquals parameter, which is returned as a response.

\n

For example, if ListTrainingJobs is invoked with the following\n parameters:

\n

\n { ... MaxResults: 100, StatusEquals: InProgress ... }\n

\n

First, 100 trainings jobs with any status, including those other than\n InProgress, are selected (sorted according to the creation time,\n from the most current to the oldest). Next, those with a status of\n InProgress are returned.

\n

You can quickly test the API using the following Amazon Web Services CLI code.

\n

\n aws sagemaker list-training-jobs --max-results 100 --status-equals\n InProgress\n

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -23576,7 +23832,7 @@ "target": "com.amazonaws.sagemaker#ListWorkforcesResponse" }, "traits": { - "smithy.api#documentation": "

Use this operation to list all private and vendor workforces in an AWS Region. Note that you can only \n have one private workforce per AWS Region.

", + "smithy.api#documentation": "

Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only \n have one private workforce per Amazon Web Services Region.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -24007,7 +24263,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies a metric that the training algorithm\n writes\n to stderr or stdout\n . Amazon SageMakerhyperparameter\n tuning captures\n all\n defined metrics.\n You\n specify one metric that a hyperparameter tuning job uses as its\n objective metric to choose the best training job.

" + "smithy.api#documentation": "

Specifies a metric that the training algorithm\n writes\n to stderr or stdout. Amazon SageMakerhyperparameter\n tuning captures\n all\n defined metrics.\n You\n specify one metric that a hyperparameter tuning job uses as its\n objective metric to choose the best training job.

" } }, "com.amazonaws.sagemaker#MetricDefinitionList": { @@ -24457,7 +24713,7 @@ "CertifyForMarketplace": { "target": "com.amazonaws.sagemaker#CertifyForMarketplace", "traits": { - "smithy.api#documentation": "

Whether the model package is to be certified to be listed on AWS Marketplace. For\n information about listing model packages on AWS Marketplace, see List Your\n Algorithm or Model Package on AWS Marketplace.

" + "smithy.api#documentation": "

Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For\n information about listing model packages on Amazon Web Services Marketplace, see List Your\n Algorithm or Model Package on Amazon Web Services Marketplace.

" } }, "ModelApprovalStatus": { @@ -24496,7 +24752,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

A list of the tags associated with the model package. For more information, see Tagging AWS\n resources in the AWS General Reference Guide.

" + "smithy.api#documentation": "

A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.

" } } }, @@ -24545,7 +24801,13 @@ "ProductId": { "target": "com.amazonaws.sagemaker#ProductId", "traits": { - "smithy.api#documentation": "

The AWS Marketplace product ID of the model package.

" + "smithy.api#documentation": "

The Amazon Web Services Marketplace product ID of the model package.

" + } + }, + "Environment": { + "target": "com.amazonaws.sagemaker#EnvironmentMap", + "traits": { + "smithy.api#documentation": "

The environment variables to set in the Docker container. Each key and value in the\n Environment string to string map can have length of up to 1024. We\n support up to 16 entries in the map.

" } } }, @@ -24561,7 +24823,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 1 + "max": 5 } } }, @@ -24604,7 +24866,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

A list of the tags associated with the model group. For more information, see Tagging AWS\n resources in the AWS General Reference Guide.

" + "smithy.api#documentation": "

A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.

" } } }, @@ -24917,7 +25179,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains data, such as the inputs and targeted instance types that are used in the\n process of validating the model package.

\n

The data provided in the validation profile is made available to your buyers on AWS\n Marketplace.

" + "smithy.api#documentation": "

Contains data, such as the inputs and targeted instance types that are used in the\n process of validating the model package.

\n

The data provided in the validation profile is made available to your buyers on Amazon Web Services\n Marketplace.

" } }, "com.amazonaws.sagemaker#ModelPackageValidationProfiles": { @@ -25228,7 +25490,7 @@ "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data\n on the storage volume attached to the ML compute instance(s) that run the model monitoring\n job.

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data\n on the storage volume attached to the ML compute instance(s) that run the model monitoring\n job.

" } } }, @@ -25620,7 +25882,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model\n artifacts at rest using Amazon S3 server-side encryption.

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model\n artifacts at rest using Amazon S3 server-side encryption.

" } } }, @@ -25772,7 +26034,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

A list of the tags associated with the monitoring schedlue. For more information, see Tagging AWS\n resources in the AWS General Reference Guide.

" + "smithy.api#documentation": "

A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.

" } } }, @@ -26020,6 +26282,72 @@ "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" } }, + "com.amazonaws.sagemaker#NeoVpcConfig": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#NeoVpcSecurityGroupIds", + "traits": { + "smithy.api#documentation": "

The VPC security group IDs. IDs have the form of sg-xxxxxxxx. \n Specify the security groups for the VPC that is specified in the Subnets field.

", + "smithy.api#required": {} + } + }, + "Subnets": { + "target": "com.amazonaws.sagemaker#NeoVpcSubnets", + "traits": { + "smithy.api#documentation": "

The ID of the subnets in the VPC that you want to connect the \n compilation job to for accessing the model in Amazon S3.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The VpcConfig configuration object that specifies the VPC that you \n want the compilation jobs to connect to. For more information on \n controlling access to your Amazon S3 buckets used for compilation job, see \n Give Amazon SageMaker Compilation Jobs Access to Resources in Your Amazon VPC.

" + } + }, + "com.amazonaws.sagemaker#NeoVpcSecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#NeoVpcSecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NeoVpcSecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#NeoVpcSubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#NeoVpcSubnets": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NeoVpcSubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, "com.amazonaws.sagemaker#NestedFilters": { "type": "structure", "members": { @@ -26420,13 +26748,13 @@ "DefaultCodeRepository": { "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "

The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in AWS CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

" + "smithy.api#documentation": "

The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

" } }, "AdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { - "smithy.api#documentation": "

An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in AWS CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

" + "smithy.api#documentation": "

An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in Amazon Web Services CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

" } } }, @@ -26564,7 +26892,7 @@ "DisableGlueTableCreation": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

Set to True to disable the automatic creation of an AWS Glue table when\n configuring an OfflineStore.

" + "smithy.api#documentation": "

Set to True to disable the automatic creation of an Amazon Web Services Glue table when\n configuring an OfflineStore.

" } }, "DataCatalogConfig": { @@ -26575,7 +26903,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration of an OfflineStore.

\n

Provide an OfflineStoreConfig in a request to\n CreateFeatureGroup to create an OfflineStore.

\n

To encrypt an OfflineStore using at rest data encryption, specify AWS Key\n Management Service (KMS) key ID, or KMSKeyId, in\n S3StorageConfig.

" + "smithy.api#documentation": "

The configuration of an OfflineStore.

\n

Provide an OfflineStoreConfig in a request to\n CreateFeatureGroup to create an OfflineStore.

\n

To encrypt an OfflineStore using at rest data encryption, specify Amazon Web Services Key\n Management Service (KMS) key ID, or KMSKeyId, in\n S3StorageConfig.

" } }, "com.amazonaws.sagemaker#OfflineStoreStatus": { @@ -26774,7 +27102,7 @@ } }, "traits": { - "smithy.api#documentation": "

Use this to specify the AWS Key Management Service (KMS) Key ID, or\n KMSKeyId, for at rest data encryption. You can turn\n OnlineStore on or off by specifying the EnableOnlineStore flag\n at General Assembly; the default value is False.

" + "smithy.api#documentation": "

Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or\n KMSKeyId, for at rest data encryption. You can turn\n OnlineStore on or off by specifying the EnableOnlineStore flag\n at General Assembly; the default value is False.

" } }, "com.amazonaws.sagemaker#OnlineStoreSecurityConfig": { @@ -26783,7 +27111,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The ID of the AWS Key Management Service (AWS KMS) key that SageMaker Feature Store uses\n to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

\n

The caller (either IAM user or IAM role) of CreateFeatureGroup must have\n below permissions to the OnlineStore\n KmsKeyId:

\n \n

The caller (either IAM user or IAM role) to all DataPlane operations\n (PutRecord, GetRecord, DeleteRecord) must have\n the following permissions to the KmsKeyId:

\n " + "smithy.api#documentation": "

The ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker Feature Store uses\n to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

\n

The caller (either IAM user or IAM role) of CreateFeatureGroup must have\n below permissions to the OnlineStore\n KmsKeyId:

\n \n

The caller (either IAM user or IAM role) to all DataPlane operations\n (PutRecord, GetRecord, DeleteRecord) must have\n the following permissions to the KmsKeyId:

\n " } } }, @@ -26904,7 +27232,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume\n after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account

\n

The KmsKeyId can be any of the following formats:

\n " + "smithy.api#documentation": "

The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker uses to encrypt your output models with Amazon S3 server-side encryption\n after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.\n For more information, see\n KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n\t

The KmsKeyId can be any of the following formats:

\n " } } }, @@ -26918,7 +27246,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

\n \n \n

If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateTrainingJob, CreateTransformJob, or\n CreateHyperParameterTuningJob requests. For more information, see\n Using\n Key Policies in AWS KMS in the AWS Key Management Service Developer\n Guide.

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

\n \n \n

If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateTrainingJob, CreateTransformJob, or\n CreateHyperParameterTuningJob requests. For more information, see\n Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.

" } }, "S3OutputPath": { @@ -27758,14 +28086,14 @@ "VolumeSizeInGB": { "target": "com.amazonaws.sagemaker#ProcessingVolumeSizeInGB", "traits": { - "smithy.api#documentation": "

The size of the ML storage volume in gigabytes that you want to provision. You must\n specify sufficient ML storage for your scenario.

", + "smithy.api#documentation": "

The size of the ML storage volume in gigabytes that you want to provision. You must\n specify sufficient ML storage for your scenario.

\n \n

Certain Nitro-based instances include local storage with a fixed total size,\n dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts\n the local instance storage instead of Amazon EBS gp2 storage. You can't request a\n VolumeSizeInGB greater than the total size of the local instance\n storage.

\n

For a list of instance types that support local instance storage, including the\n total size per instance type, see Instance Store Volumes.

\n ", "smithy.api#required": {} } }, "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the\n storage volume attached to the ML compute instance(s) that run the processing job.\n

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the\n storage volume attached to the ML compute instance(s) that run the processing job.\n

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n " } } }, @@ -28033,6 +28361,30 @@ { "value": "ml.r5.24xlarge", "name": "ML_R5_24XLARGE" + }, + { + "value": "ml.g4dn.xlarge", + "name": "ML_G4DN_XLARGE" + }, + { + "value": "ml.g4dn.2xlarge", + "name": "ML_G4DN_2XLARGE" + }, + { + "value": "ml.g4dn.4xlarge", + "name": "ML_G4DN_4XLARGE" + }, + { + "value": "ml.g4dn.8xlarge", + "name": "ML_G4DN_8XLARGE" + }, + { + "value": "ml.g4dn.12xlarge", + "name": "ML_G4DN_12XLARGE" + }, + { + "value": "ml.g4dn.16xlarge", + "name": "ML_G4DN_16XLARGE" } ] } @@ -28151,7 +28503,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management\n User Guide.

" + "smithy.api#documentation": "

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management\n User Guide.

" } } }, @@ -28351,7 +28703,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the processing\n job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of\n a KMS key, or alias of a KMS key. The KmsKeyId is applied to all\n outputs.

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing\n job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of\n a KMS key, or alias of a KMS key. The KmsKeyId is applied to all\n outputs.

" } } }, @@ -28675,7 +29027,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the core dump data at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

\n \n \n

If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint and UpdateEndpoint requests. For more\n information, see Using Key Policies in AWS\n KMS in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the core dump data at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

\n \n \n

If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint and UpdateEndpoint requests. For more\n information, see Using Key Policies in Amazon Web Services\n KMS in the Amazon Web Services Key Management Service Developer Guide.

" } } }, @@ -29449,7 +29801,7 @@ } }, "traits": { - "smithy.api#documentation": "

A key value pair used when you provision a project as a service catalog product. For\n information, see What is AWS Service\n Catalog.

" + "smithy.api#documentation": "

A key value pair used when you provision a project as a service catalog product. For\n information, see What is Amazon Web Services Service\n Catalog.

" } }, "com.amazonaws.sagemaker#ProvisioningParameterKey": { @@ -29501,7 +29853,7 @@ "target": "com.amazonaws.sagemaker#PutModelPackageGroupPolicyOutput" }, "traits": { - "smithy.api#documentation": "

Adds a resouce policy to control access to a model group. For information about\n resoure policies, see Identity-based\n policies and resource-based policies in the AWS Identity and Access Management User Guide..

" + "smithy.api#documentation": "

Adds a resouce policy to control access to a model group. For information about\n resoure policies, see Identity-based\n policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..

" } }, "com.amazonaws.sagemaker#PutModelPackageGroupPolicyInput": { @@ -29622,7 +29974,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data from a\n Redshift execution.

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a\n Redshift execution.

" } }, "OutputFormat": { @@ -29889,7 +30241,7 @@ "RepositoryCredentialsProviderArn": { "target": "com.amazonaws.sagemaker#RepositoryCredentialsProviderArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Lambda function that provides credentials to\n authenticate to the private Docker registry where your model image is hosted. For\n information about how to create an AWS Lambda function, see Create a Lambda function\n with the console in the AWS Lambda Developer\n Guide.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function that provides credentials to\n authenticate to the private Docker registry where your model image is hosted. For\n information about how to create an Amazon Web Services Lambda function, see Create a Lambda function\n with the console in the Amazon Web Services Lambda Developer\n Guide.

", "smithy.api#required": {} } } @@ -29965,7 +30317,7 @@ "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML\n compute instance(s) that run the training job.

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n \n

The VolumeKmsKeyId can be in any of the following formats:

\n " + "smithy.api#documentation": "

The Amazon Web Services KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML\n compute instance(s) that run the training job.

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n \n

The VolumeKmsKeyId can be in any of the following formats:

\n " } } }, @@ -30345,7 +30697,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (KMS) key ID of the key used to encrypt any objects\n written into the OfflineStore S3 location.

\n

The IAM roleARN that is passed as a parameter to\n CreateFeatureGroup must have below permissions to the\n KmsKeyId:

\n " + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (KMS) key ID of the key used to encrypt any objects\n written into the OfflineStore S3 location.

\n

The IAM roleARN that is passed as a parameter to\n CreateFeatureGroup must have below permissions to the\n KmsKeyId:

\n " } }, "ResolvedOutputS3Uri": { @@ -31647,7 +31999,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details of a provisioned service catalog product. For information about service catalog,\n see What is AWS Service\n Catalog.

" + "smithy.api#documentation": "

Details of a provisioned service catalog product. For information about service catalog,\n see What is Amazon Web Services Service\n Catalog.

" } }, "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails": { @@ -31681,7 +32033,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details that you specify to provision a service catalog product. For information about\n service catalog, see .What is AWS Service\n Catalog.

" + "smithy.api#documentation": "

Details that you specify to provision a service catalog product. For information about\n service catalog, see .What is Amazon Web Services Service\n Catalog.

" } }, "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds": { @@ -31712,7 +32064,7 @@ "S3KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS)\n encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

" + "smithy.api#documentation": "

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS)\n encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

" } } }, @@ -31940,13 +32292,13 @@ "AlgorithmName": { "target": "com.amazonaws.sagemaker#ArnOrName", "traits": { - "smithy.api#documentation": "

The name of an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you\n are subscribed to.

", + "smithy.api#documentation": "

The name of an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your Amazon SageMaker account or an algorithm in Amazon Web Services Marketplace that you\n are subscribed to.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Specifies an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you\n are subscribed to.

" + "smithy.api#documentation": "

Specifies an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your Amazon SageMaker account or an algorithm in Amazon Web Services Marketplace that you\n are subscribed to.

" } }, "com.amazonaws.sagemaker#SourceAlgorithmList": { @@ -32394,7 +32746,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops a pipeline execution.

" + "smithy.api#documentation": "

Stops a pipeline execution.

\n

A pipeline execution won't stop while a callback step is running.\n When you call StopPipelineExecution\n on a pipeline execution with a running callback step, SageMaker Pipelines sends an\n additional Amazon SQS message to the specified SQS queue. The body of the SQS message\n contains a \"Status\" field which is set to \"Stopping\".

\n

You should add logic to your Amazon SQS message consumer to take any needed action (for\n example, resource cleanup) upon receipt of the message followed by a call to\n SendPipelineExecutionStepSuccess or\n SendPipelineExecutionStepFailure.

\n

Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

" } }, "com.amazonaws.sagemaker#StopPipelineExecutionRequest": { @@ -32708,7 +33060,7 @@ } }, "traits": { - "smithy.api#documentation": "

A tag object that consists of a key and an optional value, used to manage metadata\n for Amazon SageMaker AWS resources.

\n

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs,\n batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints. For more information on adding tags to Amazon SageMaker resources, see AddTags.

\n

For more information on adding metadata to your AWS resources with tagging, see\n Tagging AWS\n resources. For advice on best practices for managing AWS resources with\n tagging, see Tagging\n Best Practices: Implement an Effective AWS Resource Tagging Strategy.

" + "smithy.api#documentation": "

A tag object that consists of a key and an optional value, used to manage metadata\n for Amazon SageMaker Amazon Web Services resources.

\n

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs,\n batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints. For more information on adding tags to Amazon SageMaker resources, see AddTags.

\n

For more information on adding metadata to your Amazon Web Services resources with tagging, see\n Tagging Amazon Web Services\n resources. For advice on best practices for managing Amazon Web Services resources with\n tagging, see Tagging\n Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

" } }, "com.amazonaws.sagemaker#TagKey": { @@ -32867,6 +33219,10 @@ "value": "amba_cv22", "name": "AMBA_CV22" }, + { + "value": "amba_cv25", + "name": "AMBA_CV25" + }, { "value": "x86_win32", "name": "X86_WIN32" @@ -33497,7 +33853,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The AWS Identity and Access Management (IAM) role configured for the training job.

" + "smithy.api#documentation": "

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

" } }, "InputDataConfig": { @@ -33635,7 +33991,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your AWS resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging AWS\n Resources.

" + "smithy.api#documentation": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in\n different ways, for example, by purpose, owner, or environment. For more information,\n see Tagging Amazon Web Services\n Resources.

" } } }, @@ -34158,6 +34514,30 @@ { "value": "ml.m5.24xlarge", "name": "ML_M5_24XLARGE" + }, + { + "value": "ml.g4dn.xlarge", + "name": "ML_G4DN_XLARGE" + }, + { + "value": "ml.g4dn.2xlarge", + "name": "ML_G4DN_2XLARGE" + }, + { + "value": "ml.g4dn.4xlarge", + "name": "ML_G4DN_4XLARGE" + }, + { + "value": "ml.g4dn.8xlarge", + "name": "ML_G4DN_8XLARGE" + }, + { + "value": "ml.g4dn.12xlarge", + "name": "ML_G4DN_12XLARGE" + }, + { + "value": "ml.g4dn.16xlarge", + "name": "ML_G4DN_16XLARGE" } ] } @@ -34488,7 +34868,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

\n \n \n \n

If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your\n role's account. For more information, see KMS-Managed Encryption Keys in the\n Amazon Simple Storage Service\n Developer Guide.\n \n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateModel request. For more information, see Using\n Key Policies in AWS KMS in the AWS Key Management Service Developer\n Guide.

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

\n \n \n \n

If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your\n role's account. For more information, see KMS-Managed Encryption Keys in the\n Amazon Simple Storage Service\n Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateModel request. For more information, see Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.

" } } }, @@ -34502,7 +34882,7 @@ "InstanceType": { "target": "com.amazonaws.sagemaker#TransformInstanceType", "traits": { - "smithy.api#documentation": "

The ML compute instance type for the transform job. If you are using built-in\n algorithms to\n transform\n moderately sized datasets, we recommend using ml.m4.xlarge or\n ml.m5.large\n instance types.

", + "smithy.api#documentation": "

The ML compute instance type for the transform job. If you are using built-in\n algorithms to\n transform\n moderately sized datasets, we recommend using ml.m4.xlarge or\n ml.m5.largeinstance types.

", "smithy.api#required": {} } }, @@ -34516,7 +34896,7 @@ "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume\n attached to the ML compute instance(s) that run the batch transform job. The\n VolumeKmsKeyId can be any of the following formats:

\n " + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume\n attached to the ML compute instance(s) that run the batch transform job.

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n \n

\n The VolumeKmsKeyId can be any of the following formats:

\n " } } }, @@ -35279,7 +35659,7 @@ "HumanTaskUiArn": { "target": "com.amazonaws.sagemaker#HumanTaskUiArn", "traits": { - "smithy.api#documentation": "

The ARN of the worker task template used to render the worker UI and tools for\n labeling job tasks.

\n

Use this parameter when you are creating a labeling job for 3D point cloud and video\n fram labeling jobs. Use your labeling job task type to select one of the following ARNs\n and use it with this parameter when you create a labeling job. Replace\n aws-region with the AWS region you are creating your labeling job\n in.

\n\n

\n 3D Point Cloud HumanTaskUiArns\n

\n\n

Use this HumanTaskUiArn for 3D point cloud object detection and 3D point\n cloud object detection adjustment labeling jobs.

\n \n\n

Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point\n cloud object tracking adjustment labeling jobs.

\n \n\n

Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D\n point cloud semantic segmentation adjustment labeling jobs.

\n \n\n

\n Video Frame HumanTaskUiArns\n

\n\n

Use this HumanTaskUiArn for video frame object detection and video frame\n object detection adjustment labeling jobs.

\n \n\n

Use this HumanTaskUiArn for video frame object tracking and video frame\n object tracking adjustment labeling jobs.

\n " + "smithy.api#documentation": "

The ARN of the worker task template used to render the worker UI and tools for\n labeling job tasks.

\n

Use this parameter when you are creating a labeling job for 3D point cloud and video\n fram labeling jobs. Use your labeling job task type to select one of the following ARNs\n and use it with this parameter when you create a labeling job. Replace\n aws-region with the Amazon Web Services region you are creating your labeling job\n in.

\n\n

\n 3D Point Cloud HumanTaskUiArns\n

\n\n

Use this HumanTaskUiArn for 3D point cloud object detection and 3D point\n cloud object detection adjustment labeling jobs.

\n \n\n

Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point\n cloud object tracking adjustment labeling jobs.

\n \n\n

Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D\n point cloud semantic segmentation adjustment labeling jobs.

\n \n\n

\n Video Frame HumanTaskUiArns\n

\n\n

Use this HumanTaskUiArn for video frame object detection and video frame\n object detection adjustment labeling jobs.

\n \n\n

Use this HumanTaskUiArn for video frame object tracking and video frame\n object tracking adjustment labeling jobs.

\n " } } }, @@ -35521,7 +35901,7 @@ "GitConfig": { "target": "com.amazonaws.sagemaker#GitConfigForUpdate", "traits": { - "smithy.api#documentation": "

The configuration of the git repository, including the URL and the Amazon Resource\n Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to\n access the repository. The secret must have a staging label of AWSCURRENT\n and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" + "smithy.api#documentation": "

The configuration of the git repository, including the URL and the Amazon Resource\n Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to\n access the repository. The secret must have a staging label of AWSCURRENT\n and must be in the following format:

\n

\n {\"username\": UserName, \"password\":\n Password}\n

" } } } @@ -35645,7 +36025,7 @@ "EnableIotRoleAlias": { "target": "com.amazonaws.sagemaker#EnableIotRoleAlias", "traits": { - "smithy.api#documentation": "

Whether to create an AWS IoT Role Alias during device fleet creation. \n The name of the role alias generated will match this pattern: \n \"SageMakerEdge-{DeviceFleetName}\".

\n

For example, if your device fleet is called \"demo-fleet\", the name of \n the role alias will be \"SageMakerEdge-demo-fleet\".

" + "smithy.api#documentation": "

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. \n The name of the role alias generated will match this pattern: \n \"SageMakerEdge-{DeviceFleetName}\".

\n

For example, if your device fleet is called \"demo-fleet\", the name of \n the role alias will be \"SageMakerEdge-demo-fleet\".

" } } } @@ -36041,7 +36421,7 @@ "MonitoringScheduleName": { "target": "com.amazonaws.sagemaker#MonitoringScheduleName", "traits": { - "smithy.api#documentation": "

The name of the monitoring schedule. The name must be unique within an AWS Region within\n an AWS account.

", + "smithy.api#documentation": "

The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within\n an Amazon Web Services account.

", "smithy.api#required": {} } }, @@ -36126,13 +36506,13 @@ "DefaultCodeRepository": { "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "

The Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in AWS CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

" + "smithy.api#documentation": "

The Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

" } }, "AdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { - "smithy.api#documentation": "

An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in AWS CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

" + "smithy.api#documentation": "

An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in Amazon Web Services CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

" } }, "AcceleratorTypes": { @@ -36638,7 +37018,7 @@ "Workforce": { "target": "com.amazonaws.sagemaker#Workforce", "traits": { - "smithy.api#documentation": "

A single private workforce. You can create one private work force in each AWS Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

", + "smithy.api#documentation": "

A single private workforce. You can create one private work force in each Amazon Web Services Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

", "smithy.api#required": {} } } @@ -37089,7 +37469,7 @@ } }, "traits": { - "smithy.api#documentation": "

A single private workforce, which is automatically created when you create your first\n private work team. You can create one private work force in each AWS Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

" + "smithy.api#documentation": "

A single private workforce, which is automatically created when you create your first\n private work team. You can create one private work force in each Amazon Web Services Region. By default,\n any workforce-related API operation used in a specific region will apply to the\n workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

" } }, "com.amazonaws.sagemaker#WorkforceArn": { diff --git a/aws/sdk/aws-models/securityhub.json b/aws/sdk/aws-models/securityhub.json index 3849a3032..7f77eaa0c 100644 --- a/aws/sdk/aws-models/securityhub.json +++ b/aws/sdk/aws-models/securityhub.json @@ -942,6 +942,12 @@ "com.amazonaws.securityhub#AwsApiGatewayV2StageDetails": { "type": "structure", "members": { + "ClientCertificateId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of a client certificate for a stage. Supported only for WebSocket API calls.

" + } + }, "CreatedDate": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { @@ -1769,7 +1775,7 @@ "EncryptionKey": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) used to encrypt the\n build output artifacts.

\n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the\n CMK alias (using the format alias/alias-name).

" + "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) used to encrypt the\n build output artifacts.

\n

You can specify either the ARN of the CMK or, if available, the\n CMK alias (using the format alias/alias-name).

" } }, "Environment": { @@ -1845,7 +1851,7 @@ "Credential": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets\n Manager.

\n \n

The credential can use the name of the credentials only if they exist in your current\n AWS Region.

\n " + "smithy.api#documentation": "

The ARN or name of credentials created using AWS Secrets\n Manager.

\n \n

The credential can use the name of the credentials only if they exist in your current\n AWS Region.

\n " } }, "CredentialProvider": { @@ -2617,10 +2623,36 @@ "traits": { "smithy.api#documentation": "

Indicates when the instance was launched.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

" } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.securityhub#AwsEc2InstanceNetworkInterfacesList", + "traits": { + "smithy.api#documentation": "

The identifiers of the network interfaces for the EC2 instance. The details for each network interface are in a corresponding AwsEc2NetworkInterfacesDetails object.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of an EC2 instance.

" + } + }, + "com.amazonaws.securityhub#AwsEc2InstanceNetworkInterfacesDetails": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the network interface. The details are in a corresponding AwsEc2NetworkInterfacesDetails object.

" + } } }, "traits": { - "smithy.api#documentation": "

The details of an Amazon EC2 instance.

" + "smithy.api#documentation": "

Identifies a network interface for the EC2 instance.

" + } + }, + "com.amazonaws.securityhub#AwsEc2InstanceNetworkInterfacesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEc2InstanceNetworkInterfacesDetails" } }, "com.amazonaws.securityhub#AwsEc2NetworkAclAssociation": { @@ -3123,7 +3155,7 @@ "UserId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID of an AWS account.

\n

For a referenced security group in another VPC, the account ID of the referenced\n security group is returned in the response. If the referenced security group is deleted,\n this value is not returned.

\n

[EC2-Classic] Required when adding or removing rules that reference a security group in\n another AWS.

" + "smithy.api#documentation": "

The ID of an AWS account.

\n

For a referenced security group in another VPC, the account ID of the referenced\n security group is returned in the response. If the referenced security group is deleted,\n this value is not returned.

\n

[EC2-Classic] Required when adding or removing rules that reference a security group in\n another VPC.

" } }, "VpcId": { @@ -3355,320 +3387,1744 @@ "smithy.api#documentation": "

Details about an EC2 VPC.

" } }, - "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentDetails": { + "com.amazonaws.securityhub#AwsEcsClusterClusterSettingsDetails": { "type": "structure", "members": { - "ApplicationName": { + "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the application that is associated with the environment.

" + "smithy.api#documentation": "

The name of the setting.

" } }, - "Cname": { + "Value": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The URL to the CNAME for this environment.

" + "smithy.api#documentation": "

The value of the setting.

" } - }, - "DateCreated": { - "target": "com.amazonaws.securityhub#NonEmptyString", + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether to enable CloudWatch Container Insights for the ECS cluster.

" + } + }, + "com.amazonaws.securityhub#AwsEcsClusterClusterSettingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsClusterClusterSettingsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsClusterConfigurationDetails": { + "type": "structure", + "members": { + "ExecuteCommandConfiguration": { + "target": "com.amazonaws.securityhub#AwsEcsClusterConfigurationExecuteCommandConfigurationDetails", "traits": { - "smithy.api#documentation": "

The creation date for this environment.

" + "smithy.api#documentation": "

Contains the run command configuration for the cluster.

" } - }, - "DateUpdated": { + } + }, + "traits": { + "smithy.api#documentation": "

The run command configuration for the cluster.

" + } + }, + "com.amazonaws.securityhub#AwsEcsClusterConfigurationExecuteCommandConfigurationDetails": { + "type": "structure", + "members": { + "KmsKeyId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The date when this environment was last modified.

" + "smithy.api#documentation": "

The identifier of the KMS key that is used to encrypt the data between the local client and the container.

" } }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "LogConfiguration": { + "target": "com.amazonaws.securityhub#AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails", "traits": { - "smithy.api#documentation": "

A description of the environment.

" + "smithy.api#documentation": "

The log configuration for the results of the run command actions. Required if Logging is NONE.

" } }, - "EndpointUrl": { + "Logging": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance.

" + "smithy.api#documentation": "

The log setting to use for redirecting logs for run command results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the run command configuration for the cluster.

" + } + }, + "com.amazonaws.securityhub#AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails": { + "type": "structure", + "members": { + "CloudWatchEncryptionEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to enable encryption on the CloudWatch logs.

" } }, - "EnvironmentArn": { + "CloudWatchLogGroupName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ARN of the environment.

" + "smithy.api#documentation": "

The name of the CloudWatch log group to send the logs to.

" } }, - "EnvironmentId": { + "S3BucketName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The identifier of the environment.

" + "smithy.api#documentation": "

The name of the S3 bucket to send logs to.

" } }, - "EnvironmentLinks": { - "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentEnvironmentLinks", + "S3EncryptionEnabled": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

Links to other environments in the same group.

" + "smithy.api#documentation": "

Whether to encrypt the logs that are sent to the S3 bucket.

" } }, - "EnvironmentName": { + "S3KeyPrefix": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the environment.

" + "smithy.api#documentation": "

Identifies the folder in the S3 bucket to send the logs to.

" } - }, - "OptionSettings": { - "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentOptionSettings", + } + }, + "traits": { + "smithy.api#documentation": "

The log configuration for the results of the run command actions.

" + } + }, + "com.amazonaws.securityhub#AwsEcsClusterDefaultCapacityProviderStrategyDetails": { + "type": "structure", + "members": { + "Base": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

The configuration setting for the environment.

" + "smithy.api#documentation": "

The minimum number of tasks to run on the specified capacity provider.

" } }, - "PlatformArn": { + "CapacityProvider": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ARN of the platform version for the environment.

" + "smithy.api#documentation": "

The name of the capacity provider.

" } }, - "SolutionStackName": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Weight": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

The name of the solution stack that is deployed with the environment.

" + "smithy.api#documentation": "

The relative percentage of the total number of tasks launched that should use the capacity provider.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.

" + } + }, + "com.amazonaws.securityhub#AwsEcsClusterDefaultCapacityProviderStrategyList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsClusterDefaultCapacityProviderStrategyDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsClusterDetails": { + "type": "structure", + "members": { + "CapacityProviders": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The short name of one or more capacity providers to associate with the cluster.

" } }, - "Status": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "ClusterSettings": { + "target": "com.amazonaws.securityhub#AwsEcsClusterClusterSettingsList", "traits": { - "smithy.api#documentation": "

The current operational status of the environment.

" + "smithy.api#documentation": "

The setting to use to create the cluster. Specifically used to configure whether to enable CloudWatch Container Insights for the cluster.

" } }, - "Tier": { - "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentTier", + "Configuration": { + "target": "com.amazonaws.securityhub#AwsEcsClusterConfigurationDetails", "traits": { - "smithy.api#documentation": "

The tier of the environment.

" + "smithy.api#documentation": "

The run command configuration for the cluster.

" } }, - "VersionLabel": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "DefaultCapacityProviderStrategy": { + "target": "com.amazonaws.securityhub#AwsEcsClusterDefaultCapacityProviderStrategyList", "traits": { - "smithy.api#documentation": "

The application version of the environment.

" + "smithy.api#documentation": "

The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.

" } } }, "traits": { - "smithy.api#documentation": "

Contains details about an Elastic Beanstalk environment.

" + "smithy.api#documentation": "

provides details about an ECS cluster.

" } }, - "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentEnvironmentLink": { + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails": { "type": "structure", "members": { - "EnvironmentName": { + "Condition": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the linked environment.

" + "smithy.api#documentation": "

The dependency condition of the dependent container. Indicates the required status of the dependent container before the current container can start.

" } }, - "LinkName": { + "ContainerName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the environment link.

" + "smithy.api#documentation": "

The name of the dependent container.

" } } }, "traits": { - "smithy.api#documentation": "

Contains information about a link to another environment that is in the same group.

" + "smithy.api#documentation": "

A dependency that is defined for container startup and shutdown.

" } }, - "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentEnvironmentLinks": { + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsDependsOnList": { "type": "list", "member": { - "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentEnvironmentLink" + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails" } }, - "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentOptionSetting": { + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsDetails": { "type": "structure", "members": { - "Namespace": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Command": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", "traits": { - "smithy.api#documentation": "

The type of resource that the configuration option is associated with.

" + "smithy.api#documentation": "

The command that is passed to the container.

" } }, - "OptionName": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Cpu": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

The name of the option.

" + "smithy.api#documentation": "

The number of CPU units reserved for the container.

" } }, - "ResourceName": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "DependsOn": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsDependsOnList", "traits": { - "smithy.api#documentation": "

The name of the resource.

" + "smithy.api#documentation": "

The dependencies that are defined for container startup and shutdown.

" } }, - "Value": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "DisableNetworking": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

The value of the configuration setting.

" + "smithy.api#documentation": "

Whether to disable networking within the container.

" } - } - }, - "traits": { - "smithy.api#documentation": "

A configuration option setting for the environment.

" - } - }, - "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentOptionSettings": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentOptionSetting" - } - }, - "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentTier": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.securityhub#NonEmptyString", + }, + "DnsSearchDomains": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", "traits": { - "smithy.api#documentation": "

The name of the environment tier.

" + "smithy.api#documentation": "

A list of DNS search domains that are presented to the container.

" } }, - "Type": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "DnsServers": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", "traits": { - "smithy.api#documentation": "

The type of environment tier.

" + "smithy.api#documentation": "

A list of DNS servers that are presented to the container.

" } }, - "Version": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "DockerLabels": { + "target": "com.amazonaws.securityhub#FieldMap", "traits": { - "smithy.api#documentation": "

The version of the environment tier.

" + "smithy.api#documentation": "

A key-value map of labels to add to the container.

" } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the tier of the environment.

" - } - }, - "com.amazonaws.securityhub#AwsElasticsearchDomainDetails": { - "type": "structure", - "members": { - "AccessPolicies": { - "target": "com.amazonaws.securityhub#NonEmptyString", + }, + "DockerSecurityOptions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", "traits": { - "smithy.api#documentation": "

IAM policy document specifying the access policies for the new Amazon ES domain.

" + "smithy.api#documentation": "

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.

" } }, - "DomainEndpointOptions": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainDomainEndpointOptions", + "EntryPoint": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", "traits": { - "smithy.api#documentation": "

Additional options for the domain endpoint.

" + "smithy.api#documentation": "

The entry point that is passed to the container.

" } }, - "DomainId": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Environment": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentList", "traits": { - "smithy.api#documentation": "

Unique identifier for an Amazon ES domain.

" + "smithy.api#documentation": "

The environment variables to pass to a container.

" } }, - "DomainName": { + "EnvironmentFiles": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesList", + "traits": { + "smithy.api#documentation": "

A list of files containing the environment variables to pass to a container.

" + } + }, + "Essential": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the container is essential. All tasks must have at least one essential container.

" + } + }, + "ExtraHosts": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsExtraHostsList", + "traits": { + "smithy.api#documentation": "

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.

" + } + }, + "FirelensConfiguration": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails", + "traits": { + "smithy.api#documentation": "

The FireLens configuration for the container. Specifies and configures a log router for container logs.

" + } + }, + "HealthCheck": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails", + "traits": { + "smithy.api#documentation": "

The container health check command and associated configuration parameters for the container.

" + } + }, + "Hostname": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Name of an Amazon ES domain.

\n

Domain names are unique across all domains owned by the same account within an AWS\n Region.

\n

Domain names must start with a lowercase letter and must be between 3 and 28\n characters.

\n

Valid characters are a-z (lowercase only), 0-9, and – (hyphen).

" + "smithy.api#documentation": "

The hostname to use for the container.

" } }, - "Endpoint": { + "Image": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Domain-specific endpoint used to submit index, search, and data upload requests to an\n Amazon ES domain.

\n

The endpoint is a service URL.

" + "smithy.api#documentation": "

The image used to start the container.

" } }, - "Endpoints": { - "target": "com.amazonaws.securityhub#FieldMap", + "Interactive": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

The key-value pair that exists if the Amazon ES domain uses VPC endpoints.

" + "smithy.api#documentation": "

If set to true, then containerized applications can be deployed that require stdin or a tty to be allocated.

" } }, - "ElasticsearchVersion": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Links": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", "traits": { - "smithy.api#documentation": "

Elasticsearch version.

" + "smithy.api#documentation": "

A list of links for the container in the form \n container_name:alias\n . Allows containers to communicate with each other without the need for port mappings.

" } }, - "EncryptionAtRestOptions": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainEncryptionAtRestOptions", + "LinuxParameters": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails", "traits": { - "smithy.api#documentation": "

Details about the configuration for encryption at rest.

" + "smithy.api#documentation": "

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.

" } }, - "NodeToNodeEncryptionOptions": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainNodeToNodeEncryptionOptions", + "LogConfiguration": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails", "traits": { - "smithy.api#documentation": "

Details about the configuration for node-to-node encryption.

" + "smithy.api#documentation": "

The log configuration specification for the container.

" } }, - "VPCOptions": { - "target": "com.amazonaws.securityhub#AwsElasticsearchDomainVPCOptions", + "Memory": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

Information that Amazon ES derives based on VPCOptions for the\n domain.

" + "smithy.api#documentation": "

The amount (in MiB) of memory to present to the container. If the container attempts to exceed the memory specified here, the container is shut down. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified.

" } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an Elasticsearch domain.

" - } - }, - "com.amazonaws.securityhub#AwsElasticsearchDomainDomainEndpointOptions": { - "type": "structure", - "members": { - "EnforceHTTPS": { - "target": "com.amazonaws.securityhub#Boolean", + }, + "MemoryReservation": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

Whether to require that all traffic to the domain arrive over HTTPS.

" + "smithy.api#documentation": "

The soft limit (in MiB) of memory to reserve for the container.

" + } + }, + "MountPoints": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsMountPointsList", + "traits": { + "smithy.api#documentation": "

The mount points for the data volumes in the container.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the container.

" + } + }, + "PortMappings": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsPortMappingsList", + "traits": { + "smithy.api#documentation": "

The list of port mappings for the container.

" + } + }, + "Privileged": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the container is given elevated privileges on the host container instance. The elevated privileges are similar to the root user.

" + } + }, + "PseudoTerminal": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to allocate a TTY to the container.

" + } + }, + "ReadonlyRootFilesystem": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the container is given read-only access to its root file system.

" + } + }, + "RepositoryCredentials": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails", + "traits": { + "smithy.api#documentation": "

The private repository authentication credentials to use.

" + } + }, + "ResourceRequirements": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsList", + "traits": { + "smithy.api#documentation": "

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

" + } + }, + "Secrets": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSecretsList", + "traits": { + "smithy.api#documentation": "

The secrets to pass to the container.

" + } + }, + "StartTimeout": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The number of seconds to wait before giving up on resolving dependencies for a container.

" + } + }, + "StopTimeout": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The number of seconds to wait before the container is stopped if it doesn't shut down normally on its own.

" + } + }, + "SystemControls": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSystemControlsList", + "traits": { + "smithy.api#documentation": "

A list of namespaced kernel parameters to set in the container.

" + } + }, + "Ulimits": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsUlimitsList", + "traits": { + "smithy.api#documentation": "

A list of ulimits to set in the container.

" + } + }, + "User": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The user to use inside the container.

\n

The value can use one of the following formats.

\n " + } + }, + "VolumesFrom": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsVolumesFromList", + "traits": { + "smithy.api#documentation": "

Data volumes to mount from another container.

" + } + }, + "WorkingDirectory": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The working directory in which to run commands inside the container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A container definition that describes a container in the task.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the environment variable.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value of the environment variable.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An environment variable to pass to the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of environment file.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the S3 object that contains the environment variable file.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A file that contain environment variables to pass to a container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails": { + "type": "structure", + "members": { + "Hostname": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The hostname to use in the /etc/hosts entry.

" + } + }, + "IpAddress": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IP address to use in the /etc/hosts entry.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A hostname and IP address mapping to append to the /etc/hosts file on the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsExtraHostsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails": { + "type": "structure", + "members": { + "Options": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

The options to use to configure the log router.

\n

The valid option keys are as follows:

\n " + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The log router to use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The FireLens configuration for the container. The configuration specifies and configures a log router for container logs.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails": { + "type": "structure", + "members": { + "Command": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The command that the container runs to determine whether it is healthy.

" + } + }, + "Interval": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The time period in seconds between each health check execution. The default value is 30 seconds.

" + } + }, + "Retries": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The number of times to retry a failed health check before the container is considered unhealthy. The default value is 3.

" + } + }, + "StartPeriod": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The optional grace period in seconds that allows containers time to bootstrap before failed health checks count towards the maximum number of retries.

" + } + }, + "Timeout": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The time period in seconds to wait for a health check to succeed before it is considered a failure. The default value is 5.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The container health check command and associated configuration parameters for the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails": { + "type": "structure", + "members": { + "Add": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The Linux capabilities for the container that are added to the default configuration provided by Docker.

" + } + }, + "Drop": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The Linux capabilities for the container that are dropped from the default configuration provided by Docker.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails": { + "type": "structure", + "members": { + "Capabilities": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails", + "traits": { + "smithy.api#documentation": "

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

" + } + }, + "Devices": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesList", + "traits": { + "smithy.api#documentation": "

The host devices to expose to the container.

" + } + }, + "InitProcessEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to run an init process inside the container that forwards signals and reaps processes.

" + } + }, + "MaxSwap": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The total amount of swap memory (in MiB) that a container can use.

" + } + }, + "SharedMemorySize": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The value for the size (in MiB) of the /dev/shm volume.

" + } + }, + "Swappiness": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

Configures the container's memory swappiness behavior. Determines how aggressively pages are swapped. The higher the value, the more aggressive the swappiness. The default is 60.

" + } + }, + "Tmpfs": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsList", + "traits": { + "smithy.api#documentation": "

The container path, mount options, and size (in MiB) of the tmpfs mount.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

>Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails": { + "type": "structure", + "members": { + "ContainerPath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path inside the container at which to expose the host device.

" + } + }, + "HostPath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path for the device on the host container instance.

" + } + }, + "Permissions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A host device to expose to the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails": { + "type": "structure", + "members": { + "ContainerPath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The absolute file path where the tmpfs volume is to be mounted.

" + } + }, + "MountOptions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The list of tmpfs volume mount options.

" + } + }, + "Size": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The maximum size (in MiB) of the tmpfs volume.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The container path, mount options, and size (in MiB) of a tmpfs mount.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails": { + "type": "structure", + "members": { + "LogDriver": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The log driver to use for the container.

" + } + }, + "Options": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

The configuration options to send to the log driver. Requires version 1.19 of the Docker Remote API or greater on your container instance.

" + } + }, + "SecretOptions": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsList", + "traits": { + "smithy.api#documentation": "

The secrets to pass to the log configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The log configuration specification for the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the secret.

" + } + }, + "ValueFrom": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The secret to expose to the container.

\n

The value is either the full ARN of the Secrets Manager secret or the full ARN of the\n parameter in the Systems Manager Parameter Store.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A secret to pass to the log configuration.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails": { + "type": "structure", + "members": { + "ContainerPath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path on the container to mount the host volume at.

" + } + }, + "ReadOnly": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the container has read-only access to the volume.

" + } + }, + "SourceVolume": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the volume to mount. Must match the name of a volume listed in VolumeDetails for the task definition.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A mount point for the data volumes in the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsMountPointsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails": { + "type": "structure", + "members": { + "ContainerPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The port number on the container that is bound to the user-specified or automatically assigned host port.

" + } + }, + "HostPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The port number on the container instance to reserve for the container.

" + } + }, + "Protocol": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The protocol used for the port mapping. The default is tcp.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A port mapping for the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsPortMappingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails": { + "type": "structure", + "members": { + "CredentialsParameter": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the secret that contains the private repository credentials.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The private repository authentication credentials to use.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of resource to assign to a container.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value for the specified resource type.

\n

For GPU, the value is the number of physical GPUs the Amazon ECS container agent\n reserves for the container.

\n

For InferenceAccelerator, the value should match the DeviceName\n attribute of an entry in InferenceAccelerators.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A resource to assign to a container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the secret.

" + } + }, + "ValueFrom": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The secret to expose to the container. The value is either the full ARN of the Secrets Manager\n secret or the full ARN of the parameter in the Systems Manager Parameter Store.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A secret to pass to the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSecretsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails": { + "type": "structure", + "members": { + "Namespace": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The namespaced kernel parameter for which to set a value.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value of the parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A namespaced kernel parameter to set in the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSystemControlsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails": { + "type": "structure", + "members": { + "HardLimit": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The hard limit for the ulimit type.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of the ulimit.

" + } + }, + "SoftLimit": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The soft limit for the ulimit type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A ulimit to set in the container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsUlimitsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails": { + "type": "structure", + "members": { + "ReadOnly": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the container has read-only access to the volume.

" + } + }, + "SourceContainer": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of another container within the same task definition from which to mount volumes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A data volume to mount from another container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsVolumesFromList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionDetails": { + "type": "structure", + "members": { + "ContainerDefinitions": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionContainerDefinitionsList", + "traits": { + "smithy.api#documentation": "

The container definitions that describe the containers that make up the task.

" + } + }, + "Cpu": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The number of CPU units used by the task.

" + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the container user.

" + } + }, + "Family": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of a family that this task definition is registered to.

" + } + }, + "InferenceAccelerators": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionInferenceAcceleratorsList", + "traits": { + "smithy.api#documentation": "

The Elastic Inference accelerators to use for the containers in the task.

" + } + }, + "IpcMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IPC resource namespace to use for the containers in the task.

" + } + }, + "Memory": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The amount (in MiB) of memory used by the task.

" + } + }, + "NetworkMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Docker networking mode to use for the containers in the task.

" + } + }, + "PidMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The process namespace to use for the containers in the task.

" + } + }, + "PlacementConstraints": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionPlacementConstraintsList", + "traits": { + "smithy.api#documentation": "

The placement constraint objects to use for tasks.

" + } + }, + "ProxyConfiguration": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionProxyConfigurationDetails", + "traits": { + "smithy.api#documentation": "

The configuration details for the App Mesh proxy.

" + } + }, + "RequiresCompatibilities": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The task launch types that the task definition was validated against.

" + } + }, + "TaskRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The short name or ARN of the IAM role that grants containers in the task permission to call AWS API operations on your behalf.

" + } + }, + "Volumes": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesList", + "traits": { + "smithy.api#documentation": "

The data volume definitions for the task.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

details about a task definition. A task definition describes the container and volume definitions of an Amazon Elastic Container Service task.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionInferenceAcceleratorsDetails": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Elastic Inference accelerator device name.

" + } + }, + "DeviceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Elastic Inference accelerator type to use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Elastic Inference accelerator to use\n for the containers in the task.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionInferenceAcceleratorsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionInferenceAcceleratorsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionPlacementConstraintsDetails": { + "type": "structure", + "members": { + "Expression": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A cluster query language expression to apply to the constraint.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of constraint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A placement constraint object to use for tasks.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionPlacementConstraintsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionPlacementConstraintsDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionProxyConfigurationDetails": { + "type": "structure", + "members": { + "ContainerName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the container that will serve as the App Mesh proxy.

" + } + }, + "ProxyConfigurationProperties": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesList", + "traits": { + "smithy.api#documentation": "

The set of network configuration parameters to provide to the Container Network Interface (CNI) plugin, specified as key-value pairs.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The proxy type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration details for the App Mesh\n proxy.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the property.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value of the property.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A network configuration parameter to provide to the Container Network Interface (CNI) plugin.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesDetails": { + "type": "structure", + "members": { + "DockerVolumeConfiguration": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails", + "traits": { + "smithy.api#documentation": "

Information about a Docker volume.

" + } + }, + "EfsVolumeConfiguration": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails", + "traits": { + "smithy.api#documentation": "

Information about the Amazon Elastic File System file system that is used for task storage.

" + } + }, + "Host": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesHostDetails", + "traits": { + "smithy.api#documentation": "

Information about a bind mount host volume.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the data volume.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A data volume to mount from another container.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails": { + "type": "structure", + "members": { + "Autoprovision": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to create the Docker volume automatically if it does not already exist.

" + } + }, + "Driver": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Docker volume driver to use.

" + } + }, + "DriverOpts": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

A map of Docker driver-specific options that are passed through.

" + } + }, + "Labels": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

Custom metadata to add to the Docker volume.

" + } + }, + "Scope": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are provisioned automatically when the task starts and destroyed when the task stops. Docker volumes that are shared persist after the task stops.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a Docker volume.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails": { + "type": "structure", + "members": { + "AccessPointId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon EFS access point identifier to use.

" + } + }, + "Iam": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Whether to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails": { + "type": "structure", + "members": { + "AuthorizationConfig": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails", + "traits": { + "smithy.api#documentation": "

The authorization configuration details for the Amazon EFS file system.

" + } + }, + "FilesystemId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon EFS file system identifier to use.

" + } + }, + "RootDirectory": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The directory within the Amazon EFS file system to mount as the root directory inside the host.

" + } + }, + "TransitEncryption": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.

" + } + }, + "TransitEncryptionPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Amazon Elastic File System file system that is used for task storage.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesHostDetails": { + "type": "structure", + "members": { + "SourcePath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path on the host container instance that is presented to the container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a bind mount host volume.

" + } + }, + "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesDetails" + } + }, + "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentDetails": { + "type": "structure", + "members": { + "ApplicationName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the application that is associated with the environment.

" + } + }, + "Cname": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The URL to the CNAME for this environment.

" + } + }, + "DateCreated": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The creation date for this environment.

" + } + }, + "DateUpdated": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The date when this environment was last modified.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the environment.

" + } + }, + "EndpointUrl": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance.

" + } + }, + "EnvironmentArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the environment.

" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the environment.

" + } + }, + "EnvironmentLinks": { + "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentEnvironmentLinks", + "traits": { + "smithy.api#documentation": "

Links to other environments in the same group.

" + } + }, + "EnvironmentName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the environment.

" + } + }, + "OptionSettings": { + "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentOptionSettings", + "traits": { + "smithy.api#documentation": "

The configuration setting for the environment.

" + } + }, + "PlatformArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the platform version for the environment.

" + } + }, + "SolutionStackName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the solution stack that is deployed with the environment.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current operational status of the environment.

" + } + }, + "Tier": { + "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentTier", + "traits": { + "smithy.api#documentation": "

The tier of the environment.

" + } + }, + "VersionLabel": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The application version of the environment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about an Elastic Beanstalk environment.

" + } + }, + "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentEnvironmentLink": { + "type": "structure", + "members": { + "EnvironmentName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the linked environment.

" + } + }, + "LinkName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the environment link.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a link to another environment that is in the same group.

" + } + }, + "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentEnvironmentLinks": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentEnvironmentLink" + } + }, + "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentOptionSetting": { + "type": "structure", + "members": { + "Namespace": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of resource that the configuration option is associated with.

" + } + }, + "OptionName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the option.

" + } + }, + "ResourceName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the resource.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value of the configuration setting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A configuration option setting for the environment.

" + } + }, + "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentOptionSettings": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentOptionSetting" + } + }, + "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentTier": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the environment tier.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of environment tier.

" + } + }, + "Version": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of the environment tier.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the tier of the environment.

" + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainDetails": { + "type": "structure", + "members": { + "AccessPolicies": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

IAM policy document specifying the access policies for the new Amazon ES domain.

" + } + }, + "DomainEndpointOptions": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainDomainEndpointOptions", + "traits": { + "smithy.api#documentation": "

Additional options for the domain endpoint.

" + } + }, + "DomainId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Unique identifier for an Amazon ES domain.

" + } + }, + "DomainName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Name of an Amazon ES domain.

\n

Domain names are unique across all domains owned by the same account within an AWS\n Region.

\n

Domain names must start with a lowercase letter and must be between 3 and 28\n characters.

\n

Valid characters are a-z (lowercase only), 0-9, and – (hyphen).

" + } + }, + "Endpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Domain-specific endpoint used to submit index, search, and data upload requests to an\n Amazon ES domain.

\n

The endpoint is a service URL.

" + } + }, + "Endpoints": { + "target": "com.amazonaws.securityhub#FieldMap", + "traits": { + "smithy.api#documentation": "

The key-value pair that exists if the Amazon ES domain uses VPC endpoints.

" + } + }, + "ElasticsearchVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Elasticsearch version.

" + } + }, + "EncryptionAtRestOptions": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainEncryptionAtRestOptions", + "traits": { + "smithy.api#documentation": "

Details about the configuration for encryption at rest.

" + } + }, + "LogPublishingOptions": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainLogPublishingOptions", + "traits": { + "smithy.api#documentation": "

Configures the CloudWatch Logs to publish for the Elasticsearch domain.

" + } + }, + "NodeToNodeEncryptionOptions": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainNodeToNodeEncryptionOptions", + "traits": { + "smithy.api#documentation": "

Details about the configuration for node-to-node encryption.

" + } + }, + "ServiceSoftwareOptions": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainServiceSoftwareOptions", + "traits": { + "smithy.api#documentation": "

Information about the status of a domain relative to the latest service software.

" + } + }, + "VPCOptions": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainVPCOptions", + "traits": { + "smithy.api#documentation": "

Information that Amazon ES derives based on VPCOptions for the\n domain.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an Elasticsearch domain.

" + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainDomainEndpointOptions": { + "type": "structure", + "members": { + "EnforceHTTPS": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to require that all traffic to the domain arrive over HTTPS.

" + } + }, + "TLSSecurityPolicy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The TLS security policy to apply to the HTTPS endpoint of the Elasticsearch\n domain.

\n

Valid values:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Additional options for the domain endpoint, such as whether to require HTTPS for all\n traffic.

" + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainEncryptionAtRestOptions": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether encryption at rest is enabled.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the configuration for encryption at rest.

" + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainLogPublishingOptions": { + "type": "structure", + "members": { + "IndexSlowLogs": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainLogPublishingOptionsLogConfig", + "traits": { + "smithy.api#documentation": "

Configures the Elasticsearch index logs\n publishing.

" + } + }, + "SearchSlowLogs": { + "target": "com.amazonaws.securityhub#AwsElasticsearchDomainLogPublishingOptionsLogConfig", + "traits": { + "smithy.api#documentation": "

Configures the Elasticsearch search slow log\n publishing.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

configures the CloudWatch Logs to publish for the\n Elasticsearch domain.

" + } + }, + "com.amazonaws.securityhub#AwsElasticsearchDomainLogPublishingOptionsLogConfig": { + "type": "structure", + "members": { + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the CloudWatch Logs group to publish the logs to.

" } }, - "TLSSecurityPolicy": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

The TLS security policy to apply to the HTTPS endpoint of the Elasticsearch\n domain.

\n

Valid values:

\n " + "smithy.api#documentation": "

Whether the log publishing is enabled.

" } } }, "traits": { - "smithy.api#documentation": "

Additional options for the domain endpoint, such as whether to require HTTPS for all\n traffic.

" + "smithy.api#documentation": "

The log configuration.

" } }, - "com.amazonaws.securityhub#AwsElasticsearchDomainEncryptionAtRestOptions": { + "com.amazonaws.securityhub#AwsElasticsearchDomainNodeToNodeEncryptionOptions": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

Whether encryption at rest is enabled.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

" + "smithy.api#documentation": "

Whether node-to-node encryption is enabled.

" } } }, "traits": { - "smithy.api#documentation": "

Details about the configuration for encryption at rest.

" + "smithy.api#documentation": "

Details about the configuration for node-to-node encryption.

" } }, - "com.amazonaws.securityhub#AwsElasticsearchDomainNodeToNodeEncryptionOptions": { + "com.amazonaws.securityhub#AwsElasticsearchDomainServiceSoftwareOptions": { "type": "structure", "members": { - "Enabled": { + "AutomatedUpdateDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The epoch time when the deployment window closes for required updates. After this time,\n Amazon Elasticsearch Service schedules the software upgrade automatically.

" + } + }, + "Cancellable": { "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

Whether node-to-node encryption is enabled.

" + "smithy.api#documentation": "

Whether a request to update the domain can be canceled.

" + } + }, + "CurrentVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of the service software that is currently installed on the domain.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A more detailed description of the service software status.

" + } + }, + "NewVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The most recent version of the service software.

" + } + }, + "UpdateAvailable": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether a service software update is available for the domain.

" + } + }, + "UpdateStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the service software update.

" } } }, "traits": { - "smithy.api#documentation": "

Details about the configuration for node-to-node encryption.

" + "smithy.api#documentation": "

Information about the state of the domain relative to the latest service software.

" } }, "com.amazonaws.securityhub#AwsElasticsearchDomainVPCOptions": { @@ -4246,7 +5702,7 @@ "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { "smithy.api#deprecated": { - "message": "This field is deprecated, use PrincipalName instead." + "message": "This filter is deprecated. Instead, use PrincipalName." }, "smithy.api#documentation": "

The user associated with the IAM access key related to a finding.

\n

The UserName parameter has been replaced with the\n PrincipalName parameter because access keys can also be assigned to\n principals that are not IAM users.

" } @@ -4720,7 +6176,7 @@ "min": 1, "max": 131072 }, - "smithy.api#pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+" + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+$" } }, "com.amazonaws.securityhub#AwsIamRoleDetails": { @@ -4972,7 +6428,7 @@ "TargetArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

" + "smithy.api#documentation": "

The ARN of an Amazon SQS queue or Amazon SNS topic.

" } } }, @@ -5046,7 +6502,7 @@ "MemorySize": { "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

The memory that's allocated to the function.

" + "smithy.api#documentation": "

The memory that is allocated to the function.

" } }, "RevisionId": { @@ -5133,7 +6589,7 @@ } }, "traits": { - "smithy.api#documentation": "

Error messages for environment variables that couldn't be applied.

" + "smithy.api#documentation": "

Error messages for environment variables that could not be applied.

" } }, "com.amazonaws.securityhub#AwsLambdaFunctionLayer": { @@ -5142,7 +6598,7 @@ "Arn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function layer.

" + "smithy.api#documentation": "

The ARN of the function layer.

" } }, "CodeSize": { @@ -5199,7 +6655,7 @@ } }, "traits": { - "smithy.api#documentation": "

The VPC security groups and subnets that are attached to a Lambda function. For more information, see VPC Settings.

" + "smithy.api#documentation": "

The VPC security groups and subnets that are attached to a Lambda function.

" } }, "com.amazonaws.securityhub#AwsLambdaLayerVersionDetails": { @@ -5711,7 +7167,7 @@ "RoleArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB\n instance.

" + "smithy.api#documentation": "

The ARN of the IAM role that is associated with the DB\n instance.

" } }, "FeatureName": { @@ -7370,6 +8826,290 @@ "smithy.api#documentation": "

provides information about the Amazon S3 Public Access Block configuration for accounts.

" } }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationDetails": { + "type": "structure", + "members": { + "Rules": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesList", + "traits": { + "smithy.api#documentation": "

The lifecycle rules.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The lifecycle configuration for the objects in the S3 bucket.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails": { + "type": "structure", + "members": { + "DaysAfterInitiation": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The number of days after which Amazon S3 cancels an incomplete multipart upload.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about what Amazon S3\n does when a multipart upload is incomplete.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesDetails": { + "type": "structure", + "members": { + "AbortIncompleteMultipartUpload": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails", + "traits": { + "smithy.api#documentation": "

How Amazon S3 responds when a multipart upload is incomplete. Specifically, provides a number\n of days before Amazon S3 cancels the entire upload.

" + } + }, + "ExpirationDate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The date when objects are moved or deleted.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "ExpirationInDays": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The length in days of the lifetime for objects that are subject to the rule.

" + } + }, + "ExpiredObjectDeleteMarker": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether Amazon S3 removes a delete marker that has no noncurrent versions. If set to\n true, the delete marker is expired. If set to false, the policy\n takes no action.

\n

If you provide ExpiredObjectDeleteMarker, you cannot provide\n ExpirationInDays or ExpirationDate.

" + } + }, + "Filter": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails", + "traits": { + "smithy.api#documentation": "

Identifies the objects that a rule applies to.

" + } + }, + "ID": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unique identifier of the rule.

" + } + }, + "NoncurrentVersionExpirationInDays": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The number of days that an object is noncurrent before Amazon S3 can perform the associated action.

" + } + }, + "NoncurrentVersionTransitions": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsList", + "traits": { + "smithy.api#documentation": "

Transition rules that describe when noncurrent objects transition to a specified storage class.

" + } + }, + "Prefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A prefix that identifies one or more objects that the rule applies to.

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The current status of the rule. Indicates whether the rule is currently being applied.

" + } + }, + "Transitions": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesTransitionsList", + "traits": { + "smithy.api#documentation": "

Transition rules that indicate when objects transition to a specified storage class.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for a lifecycle rule.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails": { + "type": "structure", + "members": { + "Predicate": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails", + "traits": { + "smithy.api#documentation": "

The configuration for the filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifies the objects that a rule applies to.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails": { + "type": "structure", + "members": { + "Operands": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsList", + "traits": { + "smithy.api#documentation": "

The values to use for the filter.

" + } + }, + "Prefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A prefix filter.

" + } + }, + "Tag": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails", + "traits": { + "smithy.api#documentation": "

A tag filter.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Whether to use AND or OR to join the operands.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for the filter.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Prefix text for matching objects.

" + } + }, + "Tag": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails", + "traits": { + "smithy.api#documentation": "

A tag that is assigned to matching objects.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of filter value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A value to use for the filter.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tag key.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tag value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A tag that is assigned to matching objects.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tag key.

" + } + }, + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tag value

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A tag filter.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesDetails" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails": { + "type": "structure", + "members": { + "Days": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The number of days that an object is noncurrent before Amazon S3 can perform the associated action.

" + } + }, + "StorageClass": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The class of storage to change the object to after the object is noncurrent for the specified number of days.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A transition rule that describes when noncurrent objects transition to a specified storage class.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails": { + "type": "structure", + "members": { + "Date": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A date on which to transition objects to the specified storage class. If you provide Date, you cannot provide Days.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

" + } + }, + "Days": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The number of days after which to transition the object to the specified storage class. If you provide Days, you cannot provide Date.

" + } + }, + "StorageClass": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The storage class to transition the object to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule for when objects transition to specific storage classes.

" + } + }, + "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesTransitionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails" + } + }, "com.amazonaws.securityhub#AwsS3BucketDetails": { "type": "structure", "members": { @@ -7397,6 +9137,12 @@ "smithy.api#documentation": "

The encryption rules that are applied to the S3 bucket.

" } }, + "BucketLifecycleConfiguration": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationDetails", + "traits": { + "smithy.api#documentation": "

The lifecycle configuration for objects in the S3 bucket.

" + } + }, "PublicAccessBlockConfiguration": { "target": "com.amazonaws.securityhub#AwsS3AccountPublicAccessBlockDetails", "traits": { @@ -8320,6 +10066,9 @@ "Keyword": { "target": "com.amazonaws.securityhub#KeywordFilterList", "traits": { + "smithy.api#deprecated": { + "message": "The Keyword property is deprecated." + }, "smithy.api#documentation": "

A keyword for a finding.

" } }, @@ -8433,7 +10182,7 @@ } }, "traits": { - "smithy.api#documentation": "

A wrapper type for the topic's Amazon Resource Name (ARN).

" + "smithy.api#documentation": "

A wrapper type for the topic's ARN.

" } }, "com.amazonaws.securityhub#AwsSnsTopicSubscription": { @@ -8486,7 +10235,7 @@ "DeadLetterTargetArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves\n messages after the value of maxReceiveCount is exceeded.

" + "smithy.api#documentation": "

The ARN of the dead-letter queue to which Amazon SQS moves\n messages after the value of maxReceiveCount is exceeded.

" } } }, @@ -9369,7 +11118,7 @@ "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the custom action target.

", + "smithy.api#documentation": "

The name of the custom action target. Can contain up to 20 characters.

", "smithy.api#required": {} } }, @@ -9383,7 +11132,7 @@ "Id": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ID for the custom action target.

", + "smithy.api#documentation": "

The ID for the custom action target. Can contain up to 20 alphanumeric characters.

", "smithy.api#required": {} } } @@ -12757,7 +14506,7 @@ "com.amazonaws.securityhub#NonEmptyString": { "type": "string", "traits": { - "smithy.api#pattern": ".*\\S.*" + "smithy.api#pattern": "\\S" } }, "com.amazonaws.securityhub#NonEmptyStringList": { @@ -13441,7 +15190,7 @@ "com.amazonaws.securityhub#ResourceArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws:securityhub:.*" + "smithy.api#pattern": "^arn:aws:securityhub:" } }, "com.amazonaws.securityhub#ResourceConflictException": { @@ -13484,7 +15233,7 @@ "AwsEc2Instance": { "target": "com.amazonaws.securityhub#AwsEc2InstanceDetails", "traits": { - "smithy.api#documentation": "

Details about an Amazon EC2 instance related to a finding.

" + "smithy.api#documentation": "

Details about an EC2 instance related to a finding.

" } }, "AwsEc2NetworkInterface": { @@ -13721,6 +15470,18 @@ "smithy.api#documentation": "

Details about an Amazon RDS database cluster.

" } }, + "AwsEcsCluster": { + "target": "com.amazonaws.securityhub#AwsEcsClusterDetails", + "traits": { + "smithy.api#documentation": "

Details about an ECS cluster.

" + } + }, + "AwsEcsTaskDefinition": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionDetails", + "traits": { + "smithy.api#documentation": "

Details about a task definition. A task definition describes the container and volume definitions of an Amazon Elastic Container Service task.

" + } + }, "Container": { "target": "com.amazonaws.securityhub#ContainerDetails", "traits": { @@ -15364,7 +17125,7 @@ "type": "string", "traits": { "smithy.api#deprecated": { - "message": "This field is deprecated, use Workflow.Status instead." + "message": "This filter is deprecated. Instead, use SeverityLabel or FindingProviderFieldsSeverityLabel." }, "smithy.api#enum": [ { diff --git a/aws/sdk/aws-models/servicediscovery.json b/aws/sdk/aws-models/servicediscovery.json index 7d9cba9e4..e30f6882b 100644 --- a/aws/sdk/aws-models/servicediscovery.json +++ b/aws/sdk/aws-models/servicediscovery.json @@ -105,7 +105,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a\n DiscoverInstances request but can't be discovered using DNS.

\n

For the current quota on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map quotas in the\n AWS Cloud Map Developer Guide.

" + "smithy.api#documentation": "

Creates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a\n DiscoverInstances request but can't be discovered using DNS.

\n

For the current quota on the number of namespaces that you can create using the same account,\n see Cloud Map quotas in the\n Cloud Map Developer Guide.

" } }, "com.amazonaws.servicediscovery#CreateHttpNamespaceRequest": { @@ -134,7 +134,7 @@ "Tags": { "target": "com.amazonaws.servicediscovery#TagList", "traits": { - "smithy.api#documentation": "

The tags to add to the namespace. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in\n length.

" + "smithy.api#documentation": "

The tags to add to the namespace. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.

" } } } @@ -145,7 +145,7 @@ "OperationId": { "target": "com.amazonaws.servicediscovery#OperationId", "traits": { - "smithy.api#documentation": "

A value that you can use to determine whether the request completed successfully. To get the status of the\n operation, see GetOperation.

" + "smithy.api#documentation": "

A value that you can use to determine whether the request completed successfully.\n To get the status of the operation, see GetOperation.

" } } } @@ -176,7 +176,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The namespace\n defines your service naming scheme. For example, if you name your namespace example.com and name your\n service backend, the resulting DNS name for the service is backend.example.com. Service\n instances that are registered using a private DNS namespace can be discovered using either a\n DiscoverInstances request or using DNS. For the current quota on the number of namespaces that you can\n create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

" + "smithy.api#documentation": "

Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The namespace\n defines your service naming scheme. For example, if you name your namespace example.com and name your\n service backend, the resulting DNS name for the service is backend.example.com. Service\n instances that are registered using a private DNS namespace can be discovered using either a\n DiscoverInstances request or using DNS. For the current quota on the number of namespaces that you can\n create using the same account, see Cloud Map quotas in the\n Cloud Map Developer Guide.

" } }, "com.amazonaws.servicediscovery#CreatePrivateDnsNamespaceRequest": { @@ -185,7 +185,7 @@ "Name": { "target": "com.amazonaws.servicediscovery#NamespaceNamePrivate", "traits": { - "smithy.api#documentation": "

The name that you want to assign to this namespace. When you create a private DNS namespace, AWS Cloud Map\n automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.

", + "smithy.api#documentation": "

The name that you want to assign to this namespace. When you create a private DNS namespace, Cloud Map\n automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.

", "smithy.api#required": {} } }, @@ -212,7 +212,13 @@ "Tags": { "target": "com.amazonaws.servicediscovery#TagList", "traits": { - "smithy.api#documentation": "

The tags to add to the namespace. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in\n length.

" + "smithy.api#documentation": "

The tags to add to the namespace. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.

" + } + }, + "Properties": { + "target": "com.amazonaws.servicediscovery#PrivateDnsNamespaceProperties", + "traits": { + "smithy.api#documentation": "

Properties for the private DNS\n namespace.

" } } } @@ -223,7 +229,7 @@ "OperationId": { "target": "com.amazonaws.servicediscovery#OperationId", "traits": { - "smithy.api#documentation": "

A value that you can use to determine whether the request completed successfully. To get the status of the\n operation, see GetOperation.

" + "smithy.api#documentation": "

A value that you can use to determine whether the request completed successfully.\n To get the status of the operation, see GetOperation.

" } } } @@ -254,7 +260,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your service\n naming scheme. For example, if you name your namespace example.com and name your service\n backend, the resulting DNS name for the service is backend.example.com. You can discover\n instances that were registered with a public DNS namespace by using either a DiscoverInstances request\n or using DNS. For the current quota on the number of namespaces that you can create using the same AWS account, see\n AWS Cloud Map Quotasin the\n AWS Cloud Map Developer Guide.

" + "smithy.api#documentation": "

Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your service\n naming scheme. For example, if you name your namespace example.com and name your service\n backend, the resulting DNS name for the service is backend.example.com. You can discover\n instances that were registered with a public DNS namespace by using either a DiscoverInstances request\n or using DNS. For the current quota on the number of namespaces that you can create using the same account, see Cloud Map\n quotas in the Cloud Map Developer Guide.

" } }, "com.amazonaws.servicediscovery#CreatePublicDnsNamespaceRequest": { @@ -283,7 +289,13 @@ "Tags": { "target": "com.amazonaws.servicediscovery#TagList", "traits": { - "smithy.api#documentation": "

The tags to add to the namespace. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in\n length.

" + "smithy.api#documentation": "

The tags to add to the namespace. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.

" + } + }, + "Properties": { + "target": "com.amazonaws.servicediscovery#PublicDnsNamespaceProperties", + "traits": { + "smithy.api#documentation": "

Properties for the public DNS\n namespace.

" } } } @@ -325,7 +337,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a service. This action defines the configuration for the following entities:

\n \n

After you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the\n values in the configuration to create the specified entities.

\n

For the current quota on the number of instances that you can register using the same namespace and using the\n same service, see AWS Cloud Map\n Limits in the AWS Cloud Map Developer Guide.

" + "smithy.api#documentation": "

Creates a service. This action defines the configuration for the following entities:

\n \n

After you create the service, you can submit a RegisterInstance request, and Cloud Map uses the\n values in the configuration to create the specified entities.

\n

For the current quota on the number of instances that you can register using the same namespace and using the\n same service, see Cloud Map\n quotas in the Cloud Map Developer Guide.

" } }, "com.amazonaws.servicediscovery#CreateServiceRequest": { @@ -334,7 +346,7 @@ "Name": { "target": "com.amazonaws.servicediscovery#ServiceName", "traits": { - "smithy.api#documentation": "

The name that you want to assign to the service.

\n

If you want AWS Cloud Map to create an SRV record when you register an instance and you're using a\n system that requires a specific SRV format, such as HAProxy, specify the following for Name:

\n \n

When you register an instance, AWS Cloud Map creates an SRV record and assigns a name to the record by\n concatenating the service name and the namespace name (for example,

\n

\n _exampleservice._tcp.example.com).

\n \n

For services that are accessible by DNS queries, you can't create multiple services with names that differ only\n by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished.\n However, if you use a namespace that's only accessible by API calls, then you can create services that with names\n that differ only by case.

\n ", + "smithy.api#documentation": "

The name that you want to assign to the service.

\n

If you want Cloud Map to create an SRV record when you register an instance and you're using a\n system that requires a specific SRV format, such as HAProxy, specify the following for Name:

\n \n

When you register an instance, Cloud Map creates an SRV record and assigns a name to the record by\n concatenating the service name and the namespace name (for example,

\n

\n _exampleservice._tcp.example.com).

\n \n

For services that are accessible by DNS queries, you can't create multiple services with names that differ only\n by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished.\n However, if you use a namespace that's only accessible by API calls, then you can create services that with names\n that differ only by case.

\n ", "smithy.api#required": {} } }, @@ -360,13 +372,13 @@ "DnsConfig": { "target": "com.amazonaws.servicediscovery#DnsConfig", "traits": { - "smithy.api#documentation": "

A complex type that contains information about the Amazon Route 53 records that you want AWS Cloud Map to create when you\n register an instance.

" + "smithy.api#documentation": "

A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when you\n register an instance.

" } }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { - "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. A complex type that contains settings for an optional\n Route 53 health check. If you specify settings for a health check, AWS Cloud Map associates the health check with all the\n Route 53 DNS records that you specify in DnsConfig.

\n \n

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.

\n \n

For information about the charges for health checks, see AWS Cloud Map Pricing.

" + "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. A complex type that contains settings for an optional\n Route 53 health check. If you specify settings for a health check, Cloud Map associates the health check with all the\n Route 53 DNS records that you specify in DnsConfig.

\n \n

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.

\n \n

For information about the charges for health checks, see Cloud Map Pricing.

" } }, "HealthCheckCustomConfig": { @@ -378,7 +390,7 @@ "Tags": { "target": "com.amazonaws.servicediscovery#TagList", "traits": { - "smithy.api#documentation": "

The tags to add to the service. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in\n length.

" + "smithy.api#documentation": "

The tags to add to the service. Each tag consists of a key and an optional value that you define.\n Tags keys can be up to 128 characters in length, and tag values can be up to 256\n characters in length.

" } }, "Type": { @@ -472,7 +484,7 @@ "OperationId": { "target": "com.amazonaws.servicediscovery#OperationId", "traits": { - "smithy.api#documentation": "

A value that you can use to determine whether the request completed successfully. To get the status of the\n operation, see GetOperation.

" + "smithy.api#documentation": "

A value that you can use to determine whether the request completed successfully.\n To get the status of the operation, see GetOperation.

" } } } @@ -542,7 +554,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified\n instance.

" + "smithy.api#documentation": "

Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified\n instance.

" } }, "com.amazonaws.servicediscovery#DeregisterInstanceRequest": { @@ -570,7 +582,7 @@ "OperationId": { "target": "com.amazonaws.servicediscovery#OperationId", "traits": { - "smithy.api#documentation": "

A value that you can use to determine whether the request completed successfully. For more information, see\n GetOperation.

" + "smithy.api#documentation": "

A value that you can use to determine whether the request completed successfully.\n To get the status of the operation, see GetOperation.

" } } } @@ -624,7 +636,7 @@ "MaxResults": { "target": "com.amazonaws.servicediscovery#DiscoverMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of instances that you want AWS Cloud Map to return in the response to a\n DiscoverInstances request. If you don't specify a value for MaxResults, AWS Cloud Map returns up\n to 100 instances.

" + "smithy.api#documentation": "

The maximum number of instances that you want Cloud Map to return in the response to a\n DiscoverInstances request. If you don't specify a value for MaxResults, Cloud Map returns up\n to 100 instances.

" } }, "QueryParameters": { @@ -683,19 +695,19 @@ "RoutingPolicy": { "target": "com.amazonaws.servicediscovery#RoutingPolicy", "traits": { - "smithy.api#documentation": "

The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an\n instance and specify this service.

\n \n

If you want to use this service to register instances that create alias records, specify WEIGHTED\n for the routing policy.

\n \n

You can specify the following values:

\n
\n
MULTIVALUE
\n
\n

If you define a health check for the service and the health check is healthy, Route 53 returns the applicable\n value for up to eight instances.

\n

For example, suppose that the service includes configurations for one A record and a health\n check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to\n eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP\n addresses for all of the healthy instances.

\n

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns\n the values for up to eight instances.

\n

For more information about the multivalue routing policy, see Multivalue Answer\n Routing in the Route 53 Developer Guide.

\n
\n
WEIGHTED
\n
\n

Route 53 returns the applicable value from one randomly selected instance from among the instances that you\n registered using the same service. Currently, all records have the same weight, so you can't route more or less\n traffic to any instances.

\n

For example, suppose that the service includes configurations for one A record and a health\n check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one\n randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS\n queries as if all of the instances were healthy.

\n

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns\n the applicable value for one randomly selected instance.

\n

For more information about the weighted routing policy, see Weighted Routing in the\n Route 53 Developer Guide.

\n
\n
" + "smithy.api#documentation": "

The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you register an\n instance and specify this service.

\n \n

If you want to use this service to register instances that create alias records, specify WEIGHTED\n for the routing policy.

\n \n

You can specify the following values:

\n
\n
MULTIVALUE
\n
\n

If you define a health check for the service and the health check is healthy, Route 53 returns the applicable\n value for up to eight instances.

\n

For example, suppose that the service includes configurations for one A record and a health\n check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to\n eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP\n addresses for all of the healthy instances.

\n

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns\n the values for up to eight instances.

\n

For more information about the multivalue routing policy, see Multivalue Answer\n Routing in the Route 53 Developer Guide.

\n
\n
WEIGHTED
\n
\n

Route 53 returns the applicable value from one randomly selected instance from among the instances that you\n registered using the same service. Currently, all records have the same weight, so you can't route more or less\n traffic to any instances.

\n

For example, suppose that the service includes configurations for one A record and a health\n check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one\n randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS\n queries as if all of the instances were healthy.

\n

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns\n the applicable value for one randomly selected instance.

\n

For more information about the weighted routing policy, see Weighted Routing in the\n Route 53 Developer Guide.

\n
\n
" } }, "DnsRecords": { "target": "com.amazonaws.servicediscovery#DnsRecordList", "traits": { - "smithy.api#documentation": "

An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to\n create when you register an instance.

", + "smithy.api#documentation": "

An array that contains one DnsRecord object for each Route 53 DNS record that you want Cloud Map to\n create when you register an instance.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about the Amazon Route 53 DNS records that you want AWS Cloud Map to create when\n you register an instance.

" + "smithy.api#documentation": "

A complex type that contains information about the Amazon Route 53 DNS records that you want Cloud Map to create when\n you register an instance.

" } }, "com.amazonaws.servicediscovery#DnsConfigChange": { @@ -704,13 +716,13 @@ "DnsRecords": { "target": "com.amazonaws.servicediscovery#DnsRecordList", "traits": { - "smithy.api#documentation": "

An array that contains one DnsRecord object for each Route 53 record that you want AWS Cloud Map to\n create when you register an instance.

", + "smithy.api#documentation": "

An array that contains one DnsRecord object for each Route 53 record that you want Cloud Map to\n create when you register an instance.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about changes to the Route 53 DNS records that AWS Cloud Map creates when you\n register an instance.

" + "smithy.api#documentation": "

A complex type that contains information about changes to the Route 53 DNS records that Cloud Map creates when you\n register an instance.

" } }, "com.amazonaws.servicediscovery#DnsProperties": { @@ -719,12 +731,18 @@ "HostedZoneId": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.

" + "smithy.api#documentation": "

The ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.

" + } + }, + "SOA": { + "target": "com.amazonaws.servicediscovery#SOA", + "traits": { + "smithy.api#documentation": "

Start of Authority (SOA) record for the hosted zone.

" } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a\n namespace.

" + "smithy.api#documentation": "

A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a\n namespace.

" } }, "com.amazonaws.servicediscovery#DnsRecord": { @@ -733,20 +751,20 @@ "Type": { "target": "com.amazonaws.servicediscovery#RecordType", "traits": { - "smithy.api#documentation": "

The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You\n can specify values for Type in the following combinations:

\n \n

If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or\n AAAA for Type.

\n

You specify other settings, such as the IP address for A and AAAA records, when you\n register an instance. For more information, see RegisterInstance.

\n

The following values are supported:

\n
\n
A
\n
\n

Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.

\n
\n
AAAA
\n
\n

Route 53 returns the IP address of the resource in IPv6 format, such as\n 2001:0db8:85a3:0000:0000:abcd:0001:2345.

\n
\n
CNAME
\n
\n

Route 53 returns the domain name of the resource, such as www.example.com. Note the following:

\n
    \n
  • \n

    You specify the domain name that you want to route traffic to when you register an instance. For more\n information, see Attributes in the topic RegisterInstance.

    \n
    • \n
  • \n

    You must specify WEIGHTED for the value of RoutingPolicy.

    \n
    • \n
  • \n

    You can't specify both CNAME for Type and settings for\n HealthCheckConfig. If you do, the request will fail with an InvalidInput\n error.

    \n
    • \n
\n
\n
SRV
\n
\n

Route 53 returns the value for an SRV record. The value for an SRV record uses the\n following values:

\n

\n priority weight port service-hostname\n

\n

Note the following about the values:

\n
    \n
  • \n

    The values of priority and weight are both set to 1 and can't be\n changed.

    \n
    • \n
  • \n

    The value of port comes from the value that you specify for the AWS_INSTANCE_PORT\n attribute when you submit a RegisterInstance request.

    \n
    • \n
  • \n

    The value of service-hostname is a concatenation of the following values:

    \n
      \n
    • \n

      The value that you specify for InstanceId when you register an instance.

      \n
      • \n
    • \n

      The name of the service.

      \n
      • \n
    • \n

      The name of the namespace.

      \n
      • \n
    \n

    For example, if the value of InstanceId is test, the name of the service is\n backend, and the name of the namespace is example.com, the value of\n service-hostname is the following:

    \n

    \n test.backend.example.com\n

    \n
    • \n
\n

If you specify settings for an SRV record, note the following:

\n
    \n
  • \n

    If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the\n RegisterInstance request, AWS Cloud Map automatically creates A and/or AAAA\n records that have the same name as the value of service-hostname in the SRV record.\n You can ignore these records.

    \n
    • \n
  • \n

    If you're using a system that requires a specific SRV format, such as HAProxy, see the Name element in the documentation about CreateService for information about how to\n specify the correct name format.

    \n
    • \n
\n
\n
", + "smithy.api#documentation": "

The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You\n can specify values for Type in the following combinations:

\n \n

If you want Cloud Map to create a Route 53 alias record when you register an instance, specify A or\n AAAA for Type.

\n

You specify other settings, such as the IP address for A and AAAA records, when you\n register an instance. For more information, see RegisterInstance.

\n

The following values are supported:

\n
\n
A
\n
\n

Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.

\n
\n
AAAA
\n
\n

Route 53 returns the IP address of the resource in IPv6 format, such as\n 2001:0db8:85a3:0000:0000:abcd:0001:2345.

\n
\n
CNAME
\n
\n

Route 53 returns the domain name of the resource, such as www.example.com. Note the following:

\n
    \n
  • \n

    You specify the domain name that you want to route traffic to when you register an instance. For more\n information, see Attributes in the topic RegisterInstance.

    \n
    • \n
  • \n

    You must specify WEIGHTED for the value of RoutingPolicy.

    \n
    • \n
  • \n

    You can't specify both CNAME for Type and settings for\n HealthCheckConfig. If you do, the request will fail with an InvalidInput\n error.

    \n
    • \n
\n
\n
SRV
\n
\n

Route 53 returns the value for an SRV record. The value for an SRV record uses the\n following values:

\n

\n priority weight port service-hostname\n

\n

Note the following about the values:

\n
    \n
  • \n

    The values of priority and weight are both set to 1 and can't be\n changed.

    \n
    • \n
  • \n

    The value of port comes from the value that you specify for the AWS_INSTANCE_PORT\n attribute when you submit a RegisterInstance request.

    \n
    • \n
  • \n

    The value of service-hostname is a concatenation of the following values:

    \n
      \n
    • \n

      The value that you specify for InstanceId when you register an instance.

      \n
      • \n
    • \n

      The name of the service.

      \n
      • \n
    • \n

      The name of the namespace.

      \n
      • \n
    \n

    For example, if the value of InstanceId is test, the name of the service is\n backend, and the name of the namespace is example.com, the value of\n service-hostname is the following:

    \n

    \n test.backend.example.com\n

    \n
    • \n
\n

If you specify settings for an SRV record, note the following:

\n
    \n
  • \n

    If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the\n RegisterInstance request, Cloud Map automatically creates A and/or AAAA\n records that have the same name as the value of service-hostname in the SRV record.\n You can ignore these records.

    \n
    • \n
  • \n

    If you're using a system that requires a specific SRV format, such as HAProxy, see the Name element in the documentation about CreateService for information about how to\n specify the correct name format.

    \n
    • \n
\n
\n
", "smithy.api#required": {} } }, "TTL": { "target": "com.amazonaws.servicediscovery#RecordTTL", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.

\n \n

Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes\n traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the\n TTL value is ignored. Always specify a TTL for the service; you can use a service to register\n instances that create either alias or non-alias records.

\n ", + "smithy.api#documentation": "

The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.

\n \n

Alias records don't include a TTL because Route 53 uses the TTL for the Amazon Web Services resource that an alias record routes\n traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the\n TTL value is ignored. Always specify a TTL for the service; you can use a service to register\n instances that create either alias or non-alias records.

\n ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you\n register an instance.

" + "smithy.api#documentation": "

A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you\n register an instance.

" } }, "com.amazonaws.servicediscovery#DnsRecordList": { @@ -918,13 +936,13 @@ "Instances": { "target": "com.amazonaws.servicediscovery#InstanceIdList", "traits": { - "smithy.api#documentation": "

An array that contains the IDs of all the instances that you want to get the health status for.

\n

If you omit Instances, AWS Cloud Map returns the health status for all the instances that are\n associated with the specified service.

\n \n

To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.

\n " + "smithy.api#documentation": "

An array that contains the IDs of all the instances that you want to get the health status for.

\n

If you omit Instances, Cloud Map returns the health status for all the instances that are\n associated with the specified service.

\n \n

To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.

\n " } }, "MaxResults": { "target": "com.amazonaws.servicediscovery#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of instances that you want AWS Cloud Map to return in the response to a\n GetInstancesHealthStatus request. If you don't specify a value for MaxResults, AWS Cloud Map\n returns up to 100 instances.

" + "smithy.api#documentation": "

The maximum number of instances that you want Cloud Map to return in the response to a\n GetInstancesHealthStatus request. If you don't specify a value for MaxResults, Cloud Map\n returns up to 100 instances.

" } }, "NextToken": { @@ -1087,25 +1105,25 @@ "Type": { "target": "com.amazonaws.servicediscovery#HealthCheckType", "traits": { - "smithy.api#documentation": "

The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is\n healthy.

\n \n

You can't change the value of Type after you create a health check.

\n \n

You can create the following types of health checks:

\n \n

For more information, see How Route 53 Determines Whether\n an Endpoint Is Healthy in the Route 53 Developer Guide.

", + "smithy.api#documentation": "

The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is\n healthy.

\n \n

You can't change the value of Type after you create a health check.

\n \n

You can create the following types of health checks:

\n \n

For more information, see How Route 53 Determines Whether\n an Endpoint Is Healthy in the Route 53 Developer Guide.

", "smithy.api#required": {} } }, "ResourcePath": { "target": "com.amazonaws.servicediscovery#ResourcePath", "traits": { - "smithy.api#documentation": "

The path that you want Route 53 to request when performing health checks. The path can be any value that your\n endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is\n /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't\n specify a value for ResourcePath, the default value is /.

\n

If you specify TCP for Type, you must not specify a value for\n ResourcePath.

" + "smithy.api#documentation": "

The path that you want Route 53 to request when performing health checks. The path can be any value that your\n endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is\n /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't\n specify a value for ResourcePath, the default value is /.

\n

If you specify TCP for Type, you must not specify a value for\n ResourcePath.

" } }, "FailureThreshold": { "target": "com.amazonaws.servicediscovery#FailureThreshold", "traits": { - "smithy.api#documentation": "

The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current\n status of the endpoint from unhealthy to healthy or the other way around. For more information, see How Route 53\n Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

" + "smithy.api#documentation": "

The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current\n status of the endpoint from unhealthy to healthy or the other way around. For more information, see How Route 53\n Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

" } } }, "traits": { - "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. A complex type that contains settings for an optional\n health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records\n that you specify in DnsConfig.

\n \n

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.

\n \n

Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for\n health checks, see Amazon Route 53 Pricing.

\n

Note the following about configuring health checks.

\n
\n
A and AAAA records
\n
\n

If DnsConfig includes configurations for both A and AAAA records,\n AWS Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint\n tthat's specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA\n records to be unhealthy.

\n
\n
CNAME records
\n
\n

You can't specify settings for HealthCheckConfig when the DNSConfig includes\n CNAME for the value of Type. If you do, the CreateService request will\n fail with an InvalidInput error.

\n
\n
Request interval
\n
\n

A Route 53 health checker in each health-checking AWS Region sends a health check request to an endpoint every\n 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health\n checkers don't coordinate with one another. Therefore, you might sometimes see several requests in one second\n that's followed by a few seconds with no health checks at all.

\n
\n
Health checking regions
\n
\n

Health checkers perform checks from all Route 53 health-checking Regions. For a list of the current Regions, see\n Regions.

\n
\n
Alias records
\n
\n

When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, AWS Cloud Map\n creates a Route 53 alias record. Note the following:

\n
    \n
  • \n

    Route 53 automatically sets EvaluateTargetHealth to true for alias records. When\n EvaluateTargetHealth is true, the alias record inherits the health of the referenced AWS\n resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth.

    \n
    • \n
  • \n

    If you include HealthCheckConfig and then use the service to register an instance that creates\n an alias record, Route 53 doesn't create the health check.

    \n
    • \n
\n
\n
Charges for health checks
\n
\n

Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for\n health checks, see Amazon Route 53 Pricing.

\n
\n
" + "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. A complex type that contains settings for an optional\n health check. If you specify settings for a health check, Cloud Map associates the health check with the records\n that you specify in DnsConfig.

\n \n

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.

\n \n

Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information about\n pricing for health checks, see Amazon Route 53 Pricing.

\n

Note the following about configuring health checks.

\n
\n
A and AAAA records
\n
\n

If DnsConfig includes configurations for both A and AAAA records,\n Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint\n tthat's specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA\n records to be unhealthy.

\n
\n
CNAME records
\n
\n

You can't specify settings for HealthCheckConfig when the DNSConfig includes\n CNAME for the value of Type. If you do, the CreateService request will\n fail with an InvalidInput error.

\n
\n
Request interval
\n
\n

A Route 53 health checker in each health-checking Amazon Web Services Region sends a health check request to an endpoint every\n 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health\n checkers don't coordinate with one another. Therefore, you might sometimes see several requests in one second\n that's followed by a few seconds with no health checks at all.

\n
\n
Health checking regions
\n
\n

Health checkers perform checks from all Route 53 health-checking Regions. For a list of the current Regions, see\n Regions.

\n
\n
Alias records
\n
\n

When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, Cloud Map\n creates a Route 53 alias record. Note the following:

\n
    \n
  • \n

    Route 53 automatically sets EvaluateTargetHealth to true for alias records. When\n EvaluateTargetHealth is true, the alias record inherits the health of the referenced Amazon Web Services\n resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth.

    \n
    • \n
  • \n

    If you include HealthCheckConfig and then use the service to register an instance that creates\n an alias record, Route 53 doesn't create the health check.

    \n
    • \n
\n
\n
Charges for health checks
\n
\n

Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information about pricing for\n health checks, see Amazon Route 53 Pricing.

\n
\n
" } }, "com.amazonaws.servicediscovery#HealthCheckCustomConfig": { @@ -1117,12 +1135,12 @@ "smithy.api#deprecated": { "message": "Configurable FailureThreshold of HealthCheckCustomConfig is deprecated. It will always have value 1." }, - "smithy.api#documentation": "\n

This parameter is no longer supported and is always set to 1. AWS Cloud Map waits for approximately 30 seconds after\n receiving an UpdateInstanceCustomHealthStatus request before changing the status of the service\n instance.

\n \n

The number of 30-second intervals that you want AWS Cloud Map to wait after receiving an\n UpdateInstanceCustomHealthStatus request before it changes the health status of a service\n instance.

\n

Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before\n 30 seconds has passed doesn't accelerate the change. AWS Cloud Map still waits 30 seconds after the first\n request to make the change.

" + "smithy.api#documentation": "\n

This parameter is no longer supported and is always set to 1. Cloud Map waits for approximately 30 seconds after\n receiving an UpdateInstanceCustomHealthStatus request before changing the status of the service\n instance.

\n \n

The number of 30-second intervals that you want Cloud Map to wait after receiving an\n UpdateInstanceCustomHealthStatus request before it changes the health status of a service\n instance.

\n

Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before\n 30 seconds has passed doesn't accelerate the change. Cloud Map still waits 30 seconds after the first\n request to make the change.

" } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about an optional custom health check. A custom health check, which\n requires that you use a third-party health checker to evaluate the health of your resources, is useful in the\n following circumstances:

\n \n \n

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.

\n \n

To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus request.\n AWS Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in the most recent\n UpdateInstanceCustomHealthStatus request.

\n

Here's how custom health checks work:

\n
    \n
  1. \n

    You create a service.

    \n
    2. \n
  2. \n

    You register an instance.

    \n
    3. \n
  3. \n

    You configure a third-party health checker to monitor the resource that's associated with the new instance.

    \n \n

    AWS Cloud Map doesn't check the health of the resource directly.

    \n     \n
    4. \n
  4. \n

    The third-party health-checker determines that the resource is unhealthy and notifies your application.

    \n
    5. \n
  5. \n

    Your application submits an UpdateInstanceCustomHealthStatus request.

    \n
    6. \n
  6. \n

    AWS Cloud Map waits for 30 seconds.

    \n
    7. \n
  7. \n

    If another UpdateInstanceCustomHealthStatus request doesn't arrive during that time to change the\n status back to healthy, AWS Cloud Map stops routing traffic to the resource.

    \n
    8. \n
" + "smithy.api#documentation": "

A complex type that contains information about an optional custom health check. A custom health check, which\n requires that you use a third-party health checker to evaluate the health of your resources, is useful in the\n following circumstances:

\n \n \n

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or\n HealthCheckConfig but not both.

\n \n

To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus request.\n Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in the most recent\n UpdateInstanceCustomHealthStatus request.

\n

Here's how custom health checks work:

\n
    \n
  1. \n

    You create a service.

    \n
    2. \n
  2. \n

    You register an instance.

    \n
    3. \n
  3. \n

    You configure a third-party health checker to monitor the resource that's associated with the new instance.

    \n \n

    Cloud Map doesn't check the health of the resource directly.

    \n     \n
    4. \n
  4. \n

    The third-party health-checker determines that the resource is unhealthy and notifies your application.

    \n
    5. \n
  5. \n

    Your application submits an UpdateInstanceCustomHealthStatus request.

    \n
    6. \n
  6. \n

    Cloud Map waits for 30 seconds.

    \n
    7. \n
  7. \n

    If another UpdateInstanceCustomHealthStatus request doesn't arrive during that time to change the\n status back to healthy, Cloud Map stops routing traffic to the resource.

    \n
    8. \n
" } }, "com.amazonaws.servicediscovery#HealthCheckType": { @@ -1230,6 +1248,21 @@ "target": "com.amazonaws.servicediscovery#HttpInstanceSummary" } }, + "com.amazonaws.servicediscovery#HttpNamespaceChange": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.servicediscovery#ResourceDescription", + "traits": { + "smithy.api#documentation": "

An updated description for the HTTP\n namespace.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Updated properties for the HTTP\n namespace.

" + } + }, "com.amazonaws.servicediscovery#HttpProperties": { "type": "structure", "members": { @@ -1250,7 +1283,7 @@ "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

An identifier that you want to associate with the instance. Note the following:

\n ", + "smithy.api#documentation": "

An identifier that you want to associate with the instance. Note the following:

\n ", "smithy.api#required": {} } }, @@ -1263,12 +1296,12 @@ "Attributes": { "target": "com.amazonaws.servicediscovery#Attributes", "traits": { - "smithy.api#documentation": "

A string map that contains the following information for the service that you specify in\n ServiceId:

\n \n

Supported attribute keys include the following:

\n
\n
AWS_ALIAS_DNS_NAME
\n
\n

If you want AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify\n the DNS name that's associated with the load balancer. For information about how to get the DNS name, see AliasTarget->DNSName in the Route 53 API Reference.

\n

Note the following:

\n
    \n
  • \n

    The configuration for the service that's specified by ServiceId must include settings for an\n A record, an AAAA record, or both.

    \n
    • \n
  • \n

    In the service that's specified by ServiceId, the value of RoutingPolicy must be\n WEIGHTED.

    \n
    • \n
  • \n

    If the service that's specified by ServiceId includes HealthCheckConfig settings,\n AWS Cloud Map creates the health check, but it won't associate the health check with the alias record.

    \n
    • \n
  • \n

    Auto naming currently doesn't support creating alias records that route traffic to AWS resources other\n than ELB load balancers.

    \n
    • \n
  • \n

    If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the\n AWS_INSTANCE attributes.

    \n
    • \n
\n
\n
AWS_EC2_INSTANCE_ID
\n
\n

\n HTTP namespaces only. The Amazon EC2 instance ID for the instance. The\n AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.

\n
\n
AWS_INIT_HEALTH_STATUS
\n
\n

If the service configuration includes HealthCheckCustomConfig, you can optionally use\n AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,\n HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

\n
\n
AWS_INSTANCE_CNAME
\n
\n

If the service configuration includes a CNAME record, the domain name that you want Route 53 to\n return in response to DNS queries (for example, example.com).

\n

This value is required if the service specified by ServiceId includes settings for an\n CNAME record.

\n
\n
AWS_INSTANCE_IPV4
\n
\n

If the service configuration includes an A record, the IPv4 address that you want Route 53 to\n return in response to DNS queries (for example, 192.0.2.44).

\n

This value is required if the service specified by ServiceId includes settings for an\n A record. If the service includes settings for an SRV record, you must specify a value\n for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

\n
\n
AWS_INSTANCE_IPV6
\n
\n

If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to\n return in response to DNS queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).

\n

This value is required if the service specified by ServiceId includes settings for an\n AAAA record. If the service includes settings for an SRV record, you must specify a\n value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

\n
\n
AWS_INSTANCE_PORT
\n
\n

If the service includes an SRV record, the value that you want Route 53 to return for the\n port.

\n

If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send\n requests to.

\n

This value is required if you specified settings for an SRV record or a Route 53 health check when\n you created the service.

\n
\n
" + "smithy.api#documentation": "

A string map that contains the following information for the service that you specify in\n ServiceId:

\n \n

Supported attribute keys include the following:

\n
\n
AWS_ALIAS_DNS_NAME
\n
\n

If you want Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify\n the DNS name that's associated with the load balancer. For information about how to get the DNS name, see AliasTarget->DNSName in the Route 53 API Reference.

\n

Note the following:

\n
    \n
  • \n

    The configuration for the service that's specified by ServiceId must include settings for an\n A record, an AAAA record, or both.

    \n
    • \n
  • \n

    In the service that's specified by ServiceId, the value of RoutingPolicy must be\n WEIGHTED.

    \n
    • \n
  • \n

    If the service that's specified by ServiceId includes HealthCheckConfig settings,\n Cloud Map creates the health check, but it won't associate the health check with the alias record.

    \n
    • \n
  • \n

    Auto naming currently doesn't support creating alias records that route traffic to Amazon Web Services resources other\n than ELB load balancers.

    \n
    • \n
  • \n

    If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the\n AWS_INSTANCE attributes.

    \n
    • \n
\n
\n
AWS_EC2_INSTANCE_ID
\n
\n

\n HTTP namespaces only. The Amazon EC2 instance ID for the instance. The\n AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.

\n
\n
AWS_INIT_HEALTH_STATUS
\n
\n

If the service configuration includes HealthCheckCustomConfig, you can optionally use\n AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,\n HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

\n
\n
AWS_INSTANCE_CNAME
\n
\n

If the service configuration includes a CNAME record, the domain name that you want Route 53 to\n return in response to DNS queries (for example, example.com).

\n

This value is required if the service specified by ServiceId includes settings for an\n CNAME record.

\n
\n
AWS_INSTANCE_IPV4
\n
\n

If the service configuration includes an A record, the IPv4 address that you want Route 53 to\n return in response to DNS queries (for example, 192.0.2.44).

\n

This value is required if the service specified by ServiceId includes settings for an\n A record. If the service includes settings for an SRV record, you must specify a value\n for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

\n
\n
AWS_INSTANCE_IPV6
\n
\n

If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to\n return in response to DNS queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).

\n

This value is required if the service specified by ServiceId includes settings for an\n AAAA record. If the service includes settings for an SRV record, you must specify a\n value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

\n
\n
AWS_INSTANCE_PORT
\n
\n

If the service includes an SRV record, the value that you want Route 53 to return for the\n port.

\n

If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send\n requests to.

\n

This value is required if you specified settings for an SRV record or a Route 53 health check when\n you created the service.

\n
\n
" } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about an instance that AWS Cloud Map creates when you submit a\n RegisterInstance request.

" + "smithy.api#documentation": "

A complex type that contains information about an instance that Cloud Map creates when you submit a\n RegisterInstance request.

" } }, "com.amazonaws.servicediscovery#InstanceHealthStatusMap": { @@ -1329,7 +1362,7 @@ "Attributes": { "target": "com.amazonaws.servicediscovery#Attributes", "traits": { - "smithy.api#documentation": "

A string map that contains the following information:

\n \n

Supported attribute keys include the following:

\n
\n
AWS_ALIAS_DNS_NAME
\n
\n

For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's associated with the\n load balancer.

\n
\n
AWS_EC2_INSTANCE_ID (HTTP namespaces only)
\n
\n

The Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is specified,\n then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.

\n
\n
AWS_INIT_HEALTH_STATUS
\n
\n

If the service configuration includes HealthCheckCustomConfig, you can optionally use\n AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,\n HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

\n
\n
AWS_INSTANCE_CNAME
\n
\n

For a CNAME record, the domain name that Route 53 returns in response to DNS queries (for example,\n example.com).

\n
\n
AWS_INSTANCE_IPV4
\n
\n

For an A record, the IPv4 address that Route 53 returns in response to DNS queries (for example,\n 192.0.2.44).

\n
\n
AWS_INSTANCE_IPV6
\n
\n

For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries (for example,\n 2001:0db8:85a3:0000:0000:abcd:0001:2345).

\n
\n
AWS_INSTANCE_PORT
\n
\n

For an SRV record, the value that Route 53 returns for the port. In addition, if the service\n includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.

\n
\n
" + "smithy.api#documentation": "

A string map that contains the following information:

\n \n

Supported attribute keys include the following:

\n
\n
AWS_ALIAS_DNS_NAME
\n
\n

For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's associated with the\n load balancer.

\n
\n
AWS_EC2_INSTANCE_ID (HTTP namespaces only)
\n
\n

The Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is specified,\n then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.

\n
\n
AWS_INIT_HEALTH_STATUS
\n
\n

If the service configuration includes HealthCheckCustomConfig, you can optionally use\n AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,\n HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

\n
\n
AWS_INSTANCE_CNAME
\n
\n

For a CNAME record, the domain name that Route 53 returns in response to DNS queries (for example,\n example.com).

\n
\n
AWS_INSTANCE_IPV4
\n
\n

For an A record, the IPv4 address that Route 53 returns in response to DNS queries (for example,\n 192.0.2.44).

\n
\n
AWS_INSTANCE_IPV6
\n
\n

For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries (for example,\n 2001:0db8:85a3:0000:0000:abcd:0001:2345).

\n
\n
AWS_INSTANCE_PORT
\n
\n

For an SRV record, the value that Route 53 returns for the port. In addition, if the service\n includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.

\n
\n
" } } }, @@ -1403,7 +1436,7 @@ "MaxResults": { "target": "com.amazonaws.servicediscovery#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of instances that you want AWS Cloud Map to return in the response to a\n ListInstances request. If you don't specify a value for MaxResults, AWS Cloud Map returns up\n to 100 instances.

" + "smithy.api#documentation": "

The maximum number of instances that you want Cloud Map to return in the response to a\n ListInstances request. If you don't specify a value for MaxResults, Cloud Map returns up\n to 100 instances.

" } } } @@ -1439,7 +1472,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists summary information about the namespaces that were created by the current AWS account.

", + "smithy.api#documentation": "

Lists summary information about the namespaces that were created by the current account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1453,13 +1486,13 @@ "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "

For the first ListNamespaces request, omit this value.

\n

If the response contains NextToken, submit another ListNamespaces request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

\n \n

AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's\n possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that\n subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.

\n " + "smithy.api#documentation": "

For the first ListNamespaces request, omit this value.

\n

If the response contains NextToken, submit another ListNamespaces request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

\n \n

Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's\n possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that\n subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.

\n " } }, "MaxResults": { "target": "com.amazonaws.servicediscovery#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of namespaces that you want AWS Cloud Map to return in the response to a\n ListNamespaces request. If you don't specify a value for MaxResults, AWS Cloud Map returns up\n to 100 namespaces.

" + "smithy.api#documentation": "

The maximum number of namespaces that you want Cloud Map to return in the response to a\n ListNamespaces request. If you don't specify a value for MaxResults, Cloud Map returns up\n to 100 namespaces.

" } }, "Filters": { @@ -1482,7 +1515,7 @@ "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "

If the response contains NextToken, submit another ListNamespaces request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

\n \n

AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's\n possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that\n subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.

\n " + "smithy.api#documentation": "

If the response contains NextToken, submit another ListNamespaces request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

\n \n

Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's\n possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that\n subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.

\n " } } } @@ -1515,13 +1548,13 @@ "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "

For the first ListOperations request, omit this value.

\n

If the response contains NextToken, submit another ListOperations request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

\n \n

AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's\n possible that no operations in the first MaxResults operations matched the specified criteria but that\n subsequent groups of MaxResults operations do contain operations that match the criteria.

\n " + "smithy.api#documentation": "

For the first ListOperations request, omit this value.

\n

If the response contains NextToken, submit another ListOperations request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

\n \n

Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's\n possible that no operations in the first MaxResults operations matched the specified criteria but that\n subsequent groups of MaxResults operations do contain operations that match the criteria.

\n " } }, "MaxResults": { "target": "com.amazonaws.servicediscovery#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of items that you want AWS Cloud Map to return in the response to a ListOperations\n request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 operations.

" + "smithy.api#documentation": "

The maximum number of items that you want Cloud Map to return in the response to a ListOperations\n request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 operations.

" } }, "Filters": { @@ -1544,7 +1577,7 @@ "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "

If the response contains NextToken, submit another ListOperations request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

\n \n

AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's\n possible that no operations in the first MaxResults operations matched the specified criteria but that\n subsequent groups of MaxResults operations do contain operations that match the criteria.

\n " + "smithy.api#documentation": "

If the response contains NextToken, submit another ListOperations request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

\n \n

Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's\n possible that no operations in the first MaxResults operations matched the specified criteria but that\n subsequent groups of MaxResults operations do contain operations that match the criteria.

\n " } } } @@ -1577,13 +1610,13 @@ "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "

For the first ListServices request, omit this value.

\n

If the response contains NextToken, submit another ListServices request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

\n \n

AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's\n possible that no services in the first MaxResults services matched the specified criteria but that\n subsequent groups of MaxResults services do contain services that match the criteria.

\n " + "smithy.api#documentation": "

For the first ListServices request, omit this value.

\n

If the response contains NextToken, submit another ListServices request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

\n \n

Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's\n possible that no services in the first MaxResults services matched the specified criteria but that\n subsequent groups of MaxResults services do contain services that match the criteria.

\n " } }, "MaxResults": { "target": "com.amazonaws.servicediscovery#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of services that you want AWS Cloud Map to return in the response to a ListServices\n request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 services.

" + "smithy.api#documentation": "

The maximum number of services that you want Cloud Map to return in the response to a ListServices\n request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 services.

" } }, "Filters": { @@ -1606,7 +1639,7 @@ "NextToken": { "target": "com.amazonaws.servicediscovery#NextToken", "traits": { - "smithy.api#documentation": "

If the response contains NextToken, submit another ListServices request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

\n \n

AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's\n possible that no services in the first MaxResults services matched the specified criteria but that\n subsequent groups of MaxResults services do contain services that match the criteria.

\n " + "smithy.api#documentation": "

If the response contains NextToken, submit another ListServices request to get the\n next group of results. Specify the value of NextToken from the previous response in the next\n request.

\n \n

Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's\n possible that no services in the first MaxResults services matched the specified criteria but that\n subsequent groups of MaxResults services do contain services that match the criteria.

\n " } } } @@ -1679,7 +1712,7 @@ "Arn": { "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.

" } }, "Name": { @@ -1691,7 +1724,7 @@ "Type": { "target": "com.amazonaws.servicediscovery#NamespaceType", "traits": { - "smithy.api#documentation": "

The type of the namespace. The methods for discovering instances depends on the value that you specify:

\n
\n
HTTP
\n
\n

Instances can be discovered only programmatically, using the AWS Cloud Map DiscoverInstances\n API.

\n
\n
DNS_PUBLIC
\n
\n

Instances can be discovered using public DNS queries and using the DiscoverInstances API.

\n
\n
DNS_PRIVATE
\n
\n

Instances can be discovered using DNS queries in VPCs and using the DiscoverInstances\n API.

\n
\n
" + "smithy.api#documentation": "

The type of the namespace. The methods for discovering instances depends on the value that you specify:

\n
\n
HTTP
\n
\n

Instances can be discovered only programmatically, using the Cloud Map DiscoverInstances\n API.

\n
\n
DNS_PUBLIC
\n
\n

Instances can be discovered using public DNS queries and using the DiscoverInstances API.

\n
\n
DNS_PRIVATE
\n
\n

Instances can be discovered using DNS queries in VPCs and using the DiscoverInstances\n API.

\n
\n
" } }, "Description": { @@ -1860,7 +1893,7 @@ "DnsProperties": { "target": "com.amazonaws.servicediscovery#DnsProperties", "traits": { - "smithy.api#documentation": "

A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a\n namespace.

" + "smithy.api#documentation": "

A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a\n namespace.

" } }, "HttpProperties": { @@ -1892,13 +1925,13 @@ "Arn": { "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.

" } }, "Name": { "target": "com.amazonaws.servicediscovery#NamespaceName", "traits": { - "smithy.api#documentation": "

The name of the namespace. When you create a namespace, AWS Cloud Map automatically creates a Route 53 hosted zone\n that has the same name as the namespace.

" + "smithy.api#documentation": "

The name of the namespace. When you create a namespace, Cloud Map automatically creates a Route 53 hosted zone\n that has the same name as the namespace.

" } }, "Type": { @@ -1982,7 +2015,7 @@ "Status": { "target": "com.amazonaws.servicediscovery#OperationStatus", "traits": { - "smithy.api#documentation": "

The status of the operation. Values include the following:

\n
\n
SUBMITTED
\n
\n

This is the initial state that occurs immediately after you submit a request.

\n
\n
PENDING
\n
\n

AWS Cloud Map is performing the operation.

\n
\n
SUCCESS
\n
\n

The operation succeeded.

\n
\n
FAIL
\n
\n

The operation failed. For the failure reason, see ErrorMessage.

\n
\n
" + "smithy.api#documentation": "

The status of the operation. Values include the following:

\n
\n
SUBMITTED
\n
\n

This is the initial state that occurs immediately after you submit a request.

\n
\n
PENDING
\n
\n

Cloud Map is performing the operation.

\n
\n
SUCCESS
\n
\n

The operation succeeded.

\n
\n
FAIL
\n
\n

The operation failed. For the failure reason, see ErrorMessage.

\n
\n
" } }, "ErrorMessage": { @@ -2141,7 +2174,7 @@ "Status": { "target": "com.amazonaws.servicediscovery#OperationStatus", "traits": { - "smithy.api#documentation": "

The status of the operation. Values include the following:

\n " + "smithy.api#documentation": "

The status of the operation. Values include the following:

\n " } } }, @@ -2198,6 +2231,10 @@ "value": "DELETE_NAMESPACE", "name": "DELETE_NAMESPACE" }, + { + "value": "UPDATE_NAMESPACE", + "name": "UPDATE_NAMESPACE" + }, { "value": "UPDATE_SERVICE", "name": "UPDATE_SERVICE" @@ -2213,6 +2250,166 @@ ] } }, + "com.amazonaws.servicediscovery#PrivateDnsNamespaceChange": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.servicediscovery#ResourceDescription", + "traits": { + "smithy.api#documentation": "

An updated description for the private\n DNS namespace.

" + } + }, + "Properties": { + "target": "com.amazonaws.servicediscovery#PrivateDnsNamespacePropertiesChange", + "traits": { + "smithy.api#documentation": "

Properties to be updated in the private\n DNS namespace.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updated properties for the private DNS\n namespace.

" + } + }, + "com.amazonaws.servicediscovery#PrivateDnsNamespaceProperties": { + "type": "structure", + "members": { + "DnsProperties": { + "target": "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutable", + "traits": { + "smithy.api#documentation": "

DNS properties for the private DNS\n namespace.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

DNS properties for the private DNS\n namespace.

" + } + }, + "com.amazonaws.servicediscovery#PrivateDnsNamespacePropertiesChange": { + "type": "structure", + "members": { + "DnsProperties": { + "target": "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutableChange", + "traits": { + "smithy.api#documentation": "

Updated DNS properties for the private\n DNS namespace.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Updated properties for the private DNS\n namespace.

" + } + }, + "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutable": { + "type": "structure", + "members": { + "SOA": { + "target": "com.amazonaws.servicediscovery#SOA", + "traits": { + "smithy.api#documentation": "

Fields for the Start of Authority (SOA)\n record for the hosted zone for the private DNS namespace.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

DNS properties for the private DNS\n namespace.

" + } + }, + "com.amazonaws.servicediscovery#PrivateDnsPropertiesMutableChange": { + "type": "structure", + "members": { + "SOA": { + "target": "com.amazonaws.servicediscovery#SOAChange", + "traits": { + "smithy.api#documentation": "

Updated fields for the Start of Authority\n (SOA) record for the hosted zone for the private DNS namespace.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Updated DNS properties for the private\n DNS namespace.

" + } + }, + "com.amazonaws.servicediscovery#PublicDnsNamespaceChange": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.servicediscovery#ResourceDescription", + "traits": { + "smithy.api#documentation": "

An updated description for the public DNS\n namespace.

" + } + }, + "Properties": { + "target": "com.amazonaws.servicediscovery#PublicDnsNamespacePropertiesChange", + "traits": { + "smithy.api#documentation": "

Properties to be updated in the public\n DNS namespace.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updated properties for the public DNS\n namespace.

" + } + }, + "com.amazonaws.servicediscovery#PublicDnsNamespaceProperties": { + "type": "structure", + "members": { + "DnsProperties": { + "target": "com.amazonaws.servicediscovery#PublicDnsPropertiesMutable", + "traits": { + "smithy.api#documentation": "

DNS properties for the public DNS\n namespace.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

DNS properties for the public DNS\n namespace.

" + } + }, + "com.amazonaws.servicediscovery#PublicDnsNamespacePropertiesChange": { + "type": "structure", + "members": { + "DnsProperties": { + "target": "com.amazonaws.servicediscovery#PublicDnsPropertiesMutableChange", + "traits": { + "smithy.api#documentation": "

Updated DNS properties for the hosted\n zone for the public DNS namespace.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Updated properties for the public DNS\n namespace.

" + } + }, + "com.amazonaws.servicediscovery#PublicDnsPropertiesMutable": { + "type": "structure", + "members": { + "SOA": { + "target": "com.amazonaws.servicediscovery#SOA", + "traits": { + "smithy.api#documentation": "

Start of Authority (SOA) record for the\n hosted zone for the public DNS namespace.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

DNS properties for the public DNS\n namespace.

" + } + }, + "com.amazonaws.servicediscovery#PublicDnsPropertiesMutableChange": { + "type": "structure", + "members": { + "SOA": { + "target": "com.amazonaws.servicediscovery#SOAChange", + "traits": { + "smithy.api#documentation": "

Updated fields for the Start of Authority\n (SOA) record for the hosted zone for the public DNS namespace.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Updated DNS properties for the public DNS\n namespace.

" + } + }, "com.amazonaws.servicediscovery#RecordTTL": { "type": "long", "traits": { @@ -2272,7 +2469,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates one or more records and, optionally, creates a health check based on the settings in a\n specified service. When you submit a RegisterInstance request, the following occurs:

\n \n \n

One RegisterInstance request must complete before you can submit another request and specify the\n same service ID and instance ID.

\n \n

For more information, see CreateService.

\n

When AWS Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:

\n \n

For the current quota on the number of instances that you can register using the same namespace and using the\n same service, see AWS Cloud Map\n Limits in the AWS Cloud Map Developer Guide.

" + "smithy.api#documentation": "

Creates or updates one or more records and, optionally, creates a health check based on the settings in a\n specified service. When you submit a RegisterInstance request, the following occurs:

\n \n \n

One RegisterInstance request must complete before you can submit another request and specify the\n same service ID and instance ID.

\n \n

For more information, see CreateService.

\n

When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:

\n \n

For the current quota on the number of instances that you can register using the same namespace and using the\n same service, see Cloud Map\n quotas in the Cloud Map Developer Guide.

" } }, "com.amazonaws.servicediscovery#RegisterInstanceRequest": { @@ -2288,7 +2485,7 @@ "InstanceId": { "target": "com.amazonaws.servicediscovery#InstanceId", "traits": { - "smithy.api#documentation": "

An identifier that you want to associate with the instance. Note the following:

\n ", + "smithy.api#documentation": "

An identifier that you want to associate with the instance. Note the following:

\n ", "smithy.api#required": {} } }, @@ -2302,7 +2499,7 @@ "Attributes": { "target": "com.amazonaws.servicediscovery#Attributes", "traits": { - "smithy.api#documentation": "

A string map that contains the following information for the service that you specify in\n ServiceId:

\n \n

Supported attribute keys include the following:

\n
\n
AWS_ALIAS_DNS_NAME
\n
\n

If you want AWS Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer,\n specify the DNS name that's associated with the load balancer. For information about how to get the DNS name, see\n \"DNSName\" in the topic AliasTarget in the Route 53 API Reference.

\n

Note the following:

\n
    \n
  • \n

    The configuration for the service that's specified by ServiceId must include settings for an\n A record, an AAAA record, or both.

    \n
    • \n
  • \n

    In the service that's specified by ServiceId, the value of RoutingPolicy must be\n WEIGHTED.

    \n
    • \n
  • \n

    If the service that's specified by ServiceId includes HealthCheckConfig settings,\n AWS Cloud Map will create the Route 53 health check, but it doesn't associate the health check with the alias\n record.

    \n
    • \n
  • \n

    Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than\n Elastic Load Balancing load balancers.

    \n
    • \n
  • \n

    If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the\n AWS_INSTANCE attributes.

    \n
    • \n
\n
\n
AWS_EC2_INSTANCE_ID
\n
\n

\n HTTP namespaces only. The Amazon EC2 instance ID for the instance. If the\n AWS_EC2_INSTANCE_ID attribute is specified, then the only other attribute that can be specified is\n AWS_INIT_HEALTH_STATUS. When the AWS_EC2_INSTANCE_ID attribute is specified, then the\n AWS_INSTANCE_IPV4 attribute will be filled out with the primary private IPv4 address.

\n
\n
AWS_INIT_HEALTH_STATUS
\n
\n

If the service configuration includes HealthCheckCustomConfig, you can optionally use\n AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,\n HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

\n
\n
AWS_INSTANCE_CNAME
\n
\n

If the service configuration includes a CNAME record, the domain name that you want Route 53 to\n return in response to DNS queries (for example, example.com).

\n

This value is required if the service specified by ServiceId includes settings for an\n CNAME record.

\n
\n
AWS_INSTANCE_IPV4
\n
\n

If the service configuration includes an A record, the IPv4 address that you want Route 53 to\n return in response to DNS queries (for example, 192.0.2.44).

\n

This value is required if the service specified by ServiceId includes settings for an\n A record. If the service includes settings for an SRV record, you must specify a value\n for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

\n
\n
AWS_INSTANCE_IPV6
\n
\n

If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to\n return in response to DNS queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).

\n

This value is required if the service specified by ServiceId includes settings for an\n AAAA record. If the service includes settings for an SRV record, you must specify a\n value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

\n
\n
AWS_INSTANCE_PORT
\n
\n

If the service includes an SRV record, the value that you want Route 53 to return for the\n port.

\n

If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send\n requests to.

\n

This value is required if you specified settings for an SRV record or a Route 53 health check when\n you created the service.

\n
\n
Custom attributes
\n
\n

You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute name is\n 255 characters, and the maximum length of the attribute value is 1,024 characters. The total size of all provided\n attributes (sum of all keys and values) must not exceed 5,000 characters.

\n
\n
", + "smithy.api#documentation": "

A string map that contains the following information for the service that you specify in\n ServiceId:

\n \n

Supported attribute keys include the following:

\n
\n
AWS_ALIAS_DNS_NAME
\n
\n

If you want Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer,\n specify the DNS name that's associated with the load balancer. For information about how to get the DNS name, see\n \"DNSName\" in the topic AliasTarget in the Route 53 API Reference.

\n

Note the following:

\n
    \n
  • \n

    The configuration for the service that's specified by ServiceId must include settings for an\n A record, an AAAA record, or both.

    \n
    • \n
  • \n

    In the service that's specified by ServiceId, the value of RoutingPolicy must be\n WEIGHTED.

    \n
    • \n
  • \n

    If the service that's specified by ServiceId includes HealthCheckConfig settings,\n Cloud Map will create the Route 53 health check, but it doesn't associate the health check with the alias\n record.

    \n
    • \n
  • \n

    Auto naming currently doesn't support creating alias records that route traffic to Amazon Web Services\n resources other than Elastic Load Balancing load balancers.

    \n
    • \n
  • \n

    If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the\n AWS_INSTANCE attributes.

    \n
    • \n
\n
\n
AWS_EC2_INSTANCE_ID
\n
\n

\n HTTP namespaces only. The Amazon EC2 instance ID for the instance. If the\n AWS_EC2_INSTANCE_ID attribute is specified, then the only other attribute that can be specified is\n AWS_INIT_HEALTH_STATUS. When the AWS_EC2_INSTANCE_ID attribute is specified, then the\n AWS_INSTANCE_IPV4 attribute will be filled out with the primary private IPv4 address.

\n
\n
AWS_INIT_HEALTH_STATUS
\n
\n

If the service configuration includes HealthCheckCustomConfig, you can optionally use\n AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,\n HEALTHY or UNHEALTHY. If you don't specify a value for\n AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

\n
\n
AWS_INSTANCE_CNAME
\n
\n

If the service configuration includes a CNAME record, the domain name that you want Route 53 to\n return in response to DNS queries (for example, example.com).

\n

This value is required if the service specified by ServiceId includes settings for an\n CNAME record.

\n
\n
AWS_INSTANCE_IPV4
\n
\n

If the service configuration includes an A record, the IPv4 address that you want Route 53 to\n return in response to DNS queries (for example, 192.0.2.44).

\n

This value is required if the service specified by ServiceId includes settings for an\n A record. If the service includes settings for an SRV record, you must specify a value\n for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

\n
\n
AWS_INSTANCE_IPV6
\n
\n

If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to\n return in response to DNS queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).

\n

This value is required if the service specified by ServiceId includes settings for an\n AAAA record. If the service includes settings for an SRV record, you must specify a\n value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

\n
\n
AWS_INSTANCE_PORT
\n
\n

If the service includes an SRV record, the value that you want Route 53 to return for the\n port.

\n

If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send\n requests to.

\n

This value is required if you specified settings for an SRV record or a Route 53 health check when\n you created the service.

\n
\n
Custom attributes
\n
\n

You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute name is\n 255 characters, and the maximum length of the attribute value is 1,024 characters. The total size of all provided\n attributes (sum of all keys and values) must not exceed 5,000 characters.

\n
\n
", "smithy.api#required": {} } } @@ -2314,7 +2511,7 @@ "OperationId": { "target": "com.amazonaws.servicediscovery#OperationId", "traits": { - "smithy.api#documentation": "

A value that you can use to determine whether the request completed successfully. To get the status of the\n operation, see GetOperation.

" + "smithy.api#documentation": "

A value that you can use to determine whether the request completed successfully.\n To get the status of the operation, see GetOperation.

" } } } @@ -2327,7 +2524,7 @@ } }, "traits": { - "smithy.api#documentation": "

The operation can't be completed because you've reached the quota for the number of requests. For more\n information, see AWS Cloud Map API request throttling\n quota in the AWS Cloud Map Developer Guide.

", + "smithy.api#documentation": "

The operation can't be completed because you've reached the quota for the number of requests. For more\n information, see Cloud Map API request throttling\n quota in the Cloud Map Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -2471,9 +2668,18 @@ { "target": "com.amazonaws.servicediscovery#UntagResource" }, + { + "target": "com.amazonaws.servicediscovery#UpdateHttpNamespace" + }, { "target": "com.amazonaws.servicediscovery#UpdateInstanceCustomHealthStatus" }, + { + "target": "com.amazonaws.servicediscovery#UpdatePrivateDnsNamespace" + }, + { + "target": "com.amazonaws.servicediscovery#UpdatePublicDnsNamespace" + }, { "target": "com.amazonaws.servicediscovery#UpdateService" } @@ -2490,7 +2696,7 @@ "name": "servicediscovery" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

With AWS Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice\n applications run in. When an instance becomes available, you can call the AWS Cloud Map API to register the instance\n with AWS Cloud Map. For public or private DNS namespaces, AWS Cloud Map automatically creates DNS records and an optional\n health check. Clients that submit public or private DNS queries, or HTTP requests, for the service receive an answer\n that contains up to eight healthy records.

", + "smithy.api#documentation": "Cloud Map\n

With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice\n applications run in. When an instance becomes available, you can call the Cloud Map API to register the instance\n with Cloud Map. For public or private DNS namespaces, Cloud Map automatically creates DNS records and an optional\n health check. Clients that submit public or private DNS queries, or HTTP requests, for the service receive an answer\n that contains up to eight healthy records.

", "smithy.api#title": "AWS Cloud Map" } }, @@ -2509,19 +2715,49 @@ ] } }, + "com.amazonaws.servicediscovery#SOA": { + "type": "structure", + "members": { + "TTL": { + "target": "com.amazonaws.servicediscovery#RecordTTL", + "traits": { + "smithy.api#documentation": "

The time to live (TTL) for purposes of\n negative caching.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Start of Authority (SOA) properties for a\n public or private DNS namespace.

" + } + }, + "com.amazonaws.servicediscovery#SOAChange": { + "type": "structure", + "members": { + "TTL": { + "target": "com.amazonaws.servicediscovery#RecordTTL", + "traits": { + "smithy.api#documentation": "

The updated time to live (TTL) for\n purposes of negative caching.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Updated Start of Authority (SOA)\n properties for a public or private DNS namespace.

" + } + }, "com.amazonaws.servicediscovery#Service": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

The ID that AWS Cloud Map assigned to the service when you created it.

" + "smithy.api#documentation": "

The ID that Cloud Map assigned to the service when you created it.

" } }, "Arn": { "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.

" } }, "Name": { @@ -2551,7 +2787,7 @@ "DnsConfig": { "target": "com.amazonaws.servicediscovery#DnsConfig", "traits": { - "smithy.api#documentation": "

A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you\n register an instance.

" + "smithy.api#documentation": "

A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you\n register an instance.

" } }, "Type": { @@ -2563,7 +2799,7 @@ "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { - "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. A complex type that contains settings for an optional\n health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records\n that you specify in DnsConfig.

\n

For information about the charges for health checks, see Amazon Route 53 Pricing.

" + "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. A complex type that contains settings for an optional\n health check. If you specify settings for a health check, Cloud Map associates the health check with the records\n that you specify in DnsConfig.

\n

For information about the charges for health checks, see Amazon Route 53 Pricing.

" } }, "HealthCheckCustomConfig": { @@ -2626,13 +2862,13 @@ "DnsConfig": { "target": "com.amazonaws.servicediscovery#DnsConfigChange", "traits": { - "smithy.api#documentation": "

Information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

" + "smithy.api#documentation": "

Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

" } }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { - "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify\n settings for a health check, AWS Cloud Map associates the health check with the records that you specify in\n DnsConfig.

" + "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify\n settings for a health check, Cloud Map associates the health check with the records that you specify in\n DnsConfig.

" } } }, @@ -2719,13 +2955,13 @@ "Id": { "target": "com.amazonaws.servicediscovery#ResourceId", "traits": { - "smithy.api#documentation": "

The ID that AWS Cloud Map assigned to the service when you created it.

" + "smithy.api#documentation": "

The ID that Cloud Map assigned to the service when you created it.

" } }, "Arn": { "target": "com.amazonaws.servicediscovery#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.

" } }, "Name": { @@ -2755,13 +2991,13 @@ "DnsConfig": { "target": "com.amazonaws.servicediscovery#DnsConfig", "traits": { - "smithy.api#documentation": "

Information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

" + "smithy.api#documentation": "

Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

" } }, "HealthCheckConfig": { "target": "com.amazonaws.servicediscovery#HealthCheckConfig", "traits": { - "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify\n settings for a health check, AWS Cloud Map associates the health check with the records that you specify in\n DnsConfig.

" + "smithy.api#documentation": "

\n Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify\n settings for a health check, Cloud Map associates the health check with the records that you specify in\n DnsConfig.

" } }, "HealthCheckCustomConfig": { @@ -2986,6 +3222,69 @@ "type": "structure", "members": {} }, + "com.amazonaws.servicediscovery#UpdateHttpNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.servicediscovery#UpdateHttpNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.servicediscovery#UpdateHttpNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.servicediscovery#DuplicateRequest" + }, + { + "target": "com.amazonaws.servicediscovery#InvalidInput" + }, + { + "target": "com.amazonaws.servicediscovery#NamespaceNotFound" + }, + { + "target": "com.amazonaws.servicediscovery#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an HTTP\n namespace.

" + } + }, + "com.amazonaws.servicediscovery#UpdateHttpNamespaceRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.servicediscovery#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the namespace that you want to\n update.

", + "smithy.api#required": {} + } + }, + "UpdaterRequestId": { + "target": "com.amazonaws.servicediscovery#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string that identifies the\n request and that allows failed UpdateHttpNamespace requests to be retried without the risk of running\n the operation twice. UpdaterRequestId can be any unique string (for example, a\n date/timestamp).

", + "smithy.api#idempotencyToken": {} + } + }, + "Namespace": { + "target": "com.amazonaws.servicediscovery#HttpNamespaceChange", + "traits": { + "smithy.api#documentation": "

Updated properties for the the HTTP\n namespace.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.servicediscovery#UpdateHttpNamespaceResponse": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.servicediscovery#OperationId", + "traits": { + "smithy.api#documentation": "

A value that you can use to determine whether the request completed successfully.\n To get the status of the operation, see GetOperation.

" + } + } + } + }, "com.amazonaws.servicediscovery#UpdateInstanceCustomHealthStatus": { "type": "operation", "input": { @@ -3006,7 +3305,7 @@ } ], "traits": { - "smithy.api#documentation": "

Submits a request to change the health status of a custom health check to healthy or unhealthy.

\n

You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks,\n which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the\n status for Route 53 health checks, which you define using HealthCheckConfig.

\n

For more information, see HealthCheckCustomConfig.

" + "smithy.api#documentation": "

Submits a request to change the health status of a custom health check to healthy or unhealthy.

\n

You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks,\n which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the\n status for Route 53 health checks, which you define using HealthCheckConfig.

\n

For more information, see HealthCheckCustomConfig.

" } }, "com.amazonaws.servicediscovery#UpdateInstanceCustomHealthStatusRequest": { @@ -3035,6 +3334,132 @@ } } }, + "com.amazonaws.servicediscovery#UpdatePrivateDnsNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.servicediscovery#UpdatePrivateDnsNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.servicediscovery#UpdatePrivateDnsNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.servicediscovery#DuplicateRequest" + }, + { + "target": "com.amazonaws.servicediscovery#InvalidInput" + }, + { + "target": "com.amazonaws.servicediscovery#NamespaceNotFound" + }, + { + "target": "com.amazonaws.servicediscovery#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a private DNS\n namespace.

" + } + }, + "com.amazonaws.servicediscovery#UpdatePrivateDnsNamespaceRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.servicediscovery#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the namespace that you want to\n update.

", + "smithy.api#required": {} + } + }, + "UpdaterRequestId": { + "target": "com.amazonaws.servicediscovery#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string that identifies the\n request and that allows failed UpdatePrivateDnsNamespace requests to be retried without the risk of\n running the operation twice. UpdaterRequestId can be any unique string (for example, a\n date/timestamp).

", + "smithy.api#idempotencyToken": {} + } + }, + "Namespace": { + "target": "com.amazonaws.servicediscovery#PrivateDnsNamespaceChange", + "traits": { + "smithy.api#documentation": "

Updated properties for the private DNS\n namespace.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.servicediscovery#UpdatePrivateDnsNamespaceResponse": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.servicediscovery#OperationId", + "traits": { + "smithy.api#documentation": "

A value that you can use to determine whether the request completed successfully.\n To get the status of the operation, see GetOperation.

" + } + } + } + }, + "com.amazonaws.servicediscovery#UpdatePublicDnsNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.servicediscovery#UpdatePublicDnsNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.servicediscovery#UpdatePublicDnsNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.servicediscovery#DuplicateRequest" + }, + { + "target": "com.amazonaws.servicediscovery#InvalidInput" + }, + { + "target": "com.amazonaws.servicediscovery#NamespaceNotFound" + }, + { + "target": "com.amazonaws.servicediscovery#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a public DNS\n namespace.

" + } + }, + "com.amazonaws.servicediscovery#UpdatePublicDnsNamespaceRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.servicediscovery#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the namespace being\n updated.

", + "smithy.api#required": {} + } + }, + "UpdaterRequestId": { + "target": "com.amazonaws.servicediscovery#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string that identifies the\n request and that allows failed UpdatePublicDnsNamespace requests to be retried without the risk of\n running the operation twice. UpdaterRequestId can be any unique string (for example, a\n date/timestamp).

", + "smithy.api#idempotencyToken": {} + } + }, + "Namespace": { + "target": "com.amazonaws.servicediscovery#PublicDnsNamespaceChange", + "traits": { + "smithy.api#documentation": "

Updated properties for the public DNS\n namespace.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.servicediscovery#UpdatePublicDnsNamespaceResponse": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.servicediscovery#OperationId", + "traits": { + "smithy.api#documentation": "

A value that you can use to determine whether the request completed successfully.\n To get the status of the operation, see GetOperation.

" + } + } + } + }, "com.amazonaws.servicediscovery#UpdateService": { "type": "operation", "input": { @@ -3055,7 +3480,7 @@ } ], "traits": { - "smithy.api#documentation": "

Submits a request to perform the following operations:

\n \n

For public and private DNS namespaces, note the following:

\n \n

When you update settings for a service, AWS Cloud Map also updates the corresponding settings in all the records\n and health checks that were created by using the specified service.

" + "smithy.api#documentation": "

Submits a request to perform the following operations:

\n \n

For public and private DNS namespaces, note the following:

\n \n

When you update settings for a service, Cloud Map also updates the corresponding settings in all the records\n and health checks that were created by using the specified service.

" } }, "com.amazonaws.servicediscovery#UpdateServiceRequest": { @@ -3083,7 +3508,7 @@ "OperationId": { "target": "com.amazonaws.servicediscovery#OperationId", "traits": { - "smithy.api#documentation": "

A value that you can use to determine whether the request completed successfully. To get the status of the\n operation, see GetOperation.

" + "smithy.api#documentation": "

A value that you can use to determine whether the request completed successfully.\n To get the status of the operation, see GetOperation.

" } } } diff --git a/aws/sdk/aws-models/snowball.json b/aws/sdk/aws-models/snowball.json index 6f49b6024..652e54f1d 100644 --- a/aws/sdk/aws-models/snowball.json +++ b/aws/sdk/aws-models/snowball.json @@ -224,7 +224,7 @@ "min": 40, "max": 40 }, - "smithy.api#pattern": "ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + "smithy.api#pattern": "^ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "com.amazonaws.snowball#AddressList": { @@ -240,7 +240,7 @@ "min": 12, "max": 21 }, - "smithy.api#pattern": "(ami-[0-9a-f]{8})|(ami-[0-9a-f]{17})" + "smithy.api#pattern": "^(ami-[0-9a-f]{8})|(ami-[0-9a-f]{17})$" } }, "com.amazonaws.snowball#Boolean": { @@ -331,7 +331,7 @@ "min": 39, "max": 39 }, - "smithy.api#pattern": "CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + "smithy.api#pattern": "^CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "com.amazonaws.snowball#ClusterLimitExceededException": { @@ -342,7 +342,7 @@ } }, "traits": { - "smithy.api#documentation": "

Job creation failed. Currently, clusters support five nodes. If you have less than five\n nodes for your cluster and you have more nodes to create for this cluster, try again and\n create jobs until your cluster has exactly five notes.

", + "smithy.api#documentation": "

Job creation failed. Currently, clusters support five nodes. If you have fewer than\n five nodes for your cluster and you have more nodes to create for this cluster, try again and\n create jobs until your cluster has exactly five nodes.

", "smithy.api#error": "client" } }, @@ -470,6 +470,12 @@ "traits": { "smithy.api#documentation": "

The tax documents required in your AWS Region.

" } + }, + "OnDeviceServiceConfiguration": { + "target": "com.amazonaws.snowball#OnDeviceServiceConfiguration", + "traits": { + "smithy.api#documentation": "

Represents metadata and configuration settings for services on an AWS Snow Family device.

" + } } }, "traits": { @@ -630,6 +636,12 @@ "smithy.api#required": {} } }, + "OnDeviceServiceConfiguration": { + "target": "com.amazonaws.snowball#OnDeviceServiceConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies the service or services on the Snow Family device that your\n transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).

" + } + }, "Description": { "target": "com.amazonaws.snowball#String", "traits": { @@ -666,7 +678,7 @@ "ShippingOption": { "target": "com.amazonaws.snowball#ShippingOption", "traits": { - "smithy.api#documentation": "

The shipping speed for each node in this cluster. This speed doesn't dictate how soon\n you'll get each Snowball Edge device, rather it represents how quickly each device moves to\n its destination while in transit. Regional shipping speeds are as follows:\n

\n \n\n ", + "smithy.api#documentation": "

The shipping speed for each node in this cluster. This speed doesn't dictate how soon\n you'll get each Snowball Edge device, rather it represents how quickly each device moves to\n its destination while in transit. Regional shipping speeds are as follows:\n

\n \n\n ", "smithy.api#required": {} } }, @@ -687,6 +699,12 @@ "traits": { "smithy.api#documentation": "

The tax documents required in your AWS Region.

" } + }, + "RemoteManagement": { + "target": "com.amazonaws.snowball#RemoteManagement", + "traits": { + "smithy.api#documentation": "

Allows you to securely operate and manage Snow devices in a cluster remotely from outside\n of your internal network. When set to INSTALLED_AUTOSTART, remote management will\n automatically be available when the device arrives at your location. Otherwise, you need to\n use the Snowball Client to manage the device.

" + } } } }, @@ -727,7 +745,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a job to import or export data between Amazon S3 and your on-premises data\n center. Your AWS account must have the right trust policies and permissions in place to create\n a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide\n the clusterId value; the other job attributes are inherited from the cluster.\n

\n \n

Only the Snowball; Edge device type is supported when ordering clustered jobs.

\n

The device capacity is optional.

\n

Availability of device types differ by AWS Region. For more\n information about region availability, see AWS Regional Services.

\n \n \n

\n \n

\n AWS Snow Family device types and their capacities.\n

\n " + "smithy.api#documentation": "

Creates a job to import or export data between Amazon S3 and your on-premises data\n center. Your AWS account must have the right trust policies and permissions in place to create\n a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide\n the clusterId value; the other job attributes are inherited from the cluster.\n

\n \n

Only the Snowball; Edge device type is supported when ordering clustered jobs.

\n

The device capacity is optional.

\n

Availability of device types differ by AWS Region. For more information about Region\n availability, see AWS Regional Services.

\n \n \n

\n \n

\n AWS Snow Family device types and their capacities.\n

\n " } }, "com.amazonaws.snowball#CreateJobRequest": { @@ -745,6 +763,12 @@ "smithy.api#documentation": "

Defines the Amazon S3 buckets associated with this job.

\n\n

With IMPORT jobs, you specify the bucket or buckets that your transferred\n data will be imported into.

\n\n

With EXPORT jobs, you specify the bucket or buckets that your transferred\n data will be exported from. Optionally, you can also specify a KeyRange value. If\n you choose to export a range, you define the length of the range by providing either an\n inclusive BeginMarker value, an inclusive EndMarker value, or both.\n Ranges are UTF-8 binary sorted.

" } }, + "OnDeviceServiceConfiguration": { + "target": "com.amazonaws.snowball#OnDeviceServiceConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies the service or services on the Snow Family device that your\n transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).

" + } + }, "Description": { "target": "com.amazonaws.snowball#String", "traits": { @@ -802,7 +826,7 @@ "ForwardingAddressId": { "target": "com.amazonaws.snowball#AddressId", "traits": { - "smithy.api#documentation": "

The forwarding address ID for a job. This field is not supported in most\n regions.

" + "smithy.api#documentation": "

The forwarding address ID for a job. This field is not supported in most\n Regions.

" } }, "TaxDocuments": { @@ -817,10 +841,16 @@ "smithy.api#documentation": "

Defines the device configuration for an AWS Snowcone job.

\n \n

For more information, see\n \"https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html\" (Snow\n Family Devices and Capacity) in the Snowcone User Guide or\n \"https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html\" (Snow\n Family Devices and Capacity) in the Snowcone User Guide.

" } }, + "RemoteManagement": { + "target": "com.amazonaws.snowball#RemoteManagement", + "traits": { + "smithy.api#documentation": "

Allows you to securely operate and manage Snowcone devices remotely from outside of your\n internal network. When set to INSTALLED_AUTOSTART, remote management will\n automatically be available when the device arrives at your location. Otherwise, you need to\n use the Snowball Client to manage the device.

" + } + }, "LongTermPricingId": { "target": "com.amazonaws.snowball#LongTermPricingId", "traits": { - "smithy.api#documentation": "

The ID of the long term pricing type for the device.

" + "smithy.api#documentation": "

The ID of the long-term pricing type for the device.

" } } } @@ -850,7 +880,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a job with long term usage option for a device. The long term usage is a one year or three year long term pricing type for the device. \n You are billed upfront and AWS give discounts for long term pricing. For detailed information see XXXXXXXX

" + "smithy.api#documentation": "

Creates a job with the long-term usage option for a device. The long-term usage is a\n 1-year or 3-year long-term pricing type for the device. You are billed upfront, and AWS\n provides discounts for long-term pricing.\n

" } }, "com.amazonaws.snowball#CreateLongTermPricingRequest": { @@ -859,20 +889,20 @@ "LongTermPricingType": { "target": "com.amazonaws.snowball#LongTermPricingType", "traits": { - "smithy.api#documentation": "

The type of long term pricing option you want for the device - one year or three year long term pricing.

", + "smithy.api#documentation": "

The type of long-term pricing option you want for the device, either 1-year or 3-year\n long-term pricing.

", "smithy.api#required": {} } }, "IsLongTermPricingAutoRenew": { "target": "com.amazonaws.snowball#JavaBoolean", "traits": { - "smithy.api#documentation": "

Specifies whether the current long term pricing type for the device should be renewed.

" + "smithy.api#documentation": "

Specifies whether the current long-term pricing type for the device should be renewed.

" } }, "SnowballType": { "target": "com.amazonaws.snowball#SnowballType", "traits": { - "smithy.api#documentation": "

The type of AWS Snow Family device to use for the long term pricing job.

" + "smithy.api#documentation": "

The type of AWS Snow Family device to use for the long-term pricing job.

" } } } @@ -883,7 +913,7 @@ "LongTermPricingId": { "target": "com.amazonaws.snowball#LongTermPricingId", "traits": { - "smithy.api#documentation": "

The ID of the long term pricing type for the device.

" + "smithy.api#documentation": "

The ID of the long-term pricing type for the device.

" } } } @@ -923,7 +953,7 @@ "JobId": { "target": "com.amazonaws.snowball#JobId", "traits": { - "smithy.api#documentation": "

The ID for a job that you want to create the return shipping label for. For example\n JID123e4567-e89b-12d3-a456-426655440000.

", + "smithy.api#documentation": "

The ID for a job that you want to create the return shipping label for; for example,\n JID123e4567-e89b-12d3-a456-426655440000.

", "smithy.api#required": {} } }, @@ -1230,6 +1260,21 @@ "smithy.api#documentation": "

The container for SnowconeDeviceConfiguration.

" } }, + "com.amazonaws.snowball#DeviceServiceName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NFS_ON_DEVICE_SERVICE", + "name": "NFS_ON_DEVICE_SERVICE" + }, + { + "value": "S3_ON_DEVICE_SERVICE", + "name": "S3_ON_DEVICE_SERVICE" + } + ] + } + }, "com.amazonaws.snowball#Ec2AmiResource": { "type": "structure", "members": { @@ -1292,7 +1337,7 @@ "com.amazonaws.snowball#GSTIN": { "type": "string", "traits": { - "smithy.api#pattern": "\\d{2}[A-Z]{5}\\d{4}[A-Z]{1}[A-Z\\d]{1}[Z]{1}[A-Z\\d]{1}" + "smithy.api#pattern": "^\\d{2}[A-Z]{5}\\d{4}[A-Z]{1}[A-Z\\d]{1}[Z]{1}[A-Z\\d]{1}$" } }, "com.amazonaws.snowball#GetJobManifest": { @@ -1556,7 +1601,7 @@ "min": 39, "max": 39 }, - "smithy.api#pattern": "(M|J)ID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + "smithy.api#pattern": "^(M|J)ID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "com.amazonaws.snowball#JobListEntry": { @@ -1755,10 +1800,22 @@ "DeviceConfiguration": { "target": "com.amazonaws.snowball#DeviceConfiguration" }, + "RemoteManagement": { + "target": "com.amazonaws.snowball#RemoteManagement", + "traits": { + "smithy.api#documentation": "

Allows you to securely operate and manage Snowcone devices remotely from outside of your\n internal network. When set to INSTALLED_AUTOSTART, remote management will\n automatically be available when the device arrives at your location. Otherwise, you need to\n use the Snowball Client to manage the device.

" + } + }, "LongTermPricingId": { "target": "com.amazonaws.snowball#LongTermPricingId", "traits": { - "smithy.api#documentation": "

The ID of the long term pricing type for the device.

" + "smithy.api#documentation": "

The ID of the long-term pricing type for the device.

" + } + }, + "OnDeviceServiceConfiguration": { + "target": "com.amazonaws.snowball#OnDeviceServiceConfiguration", + "traits": { + "smithy.api#documentation": "

Represents metadata and configuration settings for services on an AWS Snow Family device.

" } } }, @@ -1921,7 +1978,7 @@ "min": 0, "max": 255 }, - "smithy.api#pattern": "arn:aws.*:kms:.*:[0-9]{12}:key/.*" + "smithy.api#pattern": "^arn:aws.*:kms:.*:[0-9]{12}:key/" } }, "com.amazonaws.snowball#LambdaResource": { @@ -2200,7 +2257,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all long term pricing types.

" + "smithy.api#documentation": "

Lists all long-term pricing types.

" } }, "com.amazonaws.snowball#ListLongTermPricingRequest": { @@ -2259,7 +2316,7 @@ "min": 41, "max": 41 }, - "smithy.api#pattern": "LTPID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + "smithy.api#pattern": "^LTPID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "com.amazonaws.snowball#LongTermPricingListEntry": { @@ -2268,66 +2325,66 @@ "LongTermPricingId": { "target": "com.amazonaws.snowball#LongTermPricingId", "traits": { - "smithy.api#documentation": "

The ID of the long term pricing type for the device.

" + "smithy.api#documentation": "

The ID of the long-term pricing type for the device.

" } }, "LongTermPricingEndDate": { "target": "com.amazonaws.snowball#Timestamp", "traits": { - "smithy.api#documentation": "

The end date the long term pricing contract.

" + "smithy.api#documentation": "

The end date the long-term pricing contract.

" } }, "LongTermPricingStartDate": { "target": "com.amazonaws.snowball#Timestamp", "traits": { - "smithy.api#documentation": "

The start date of the long term pricing contract.

" + "smithy.api#documentation": "

The start date of the long-term pricing contract.

" } }, "LongTermPricingType": { "target": "com.amazonaws.snowball#LongTermPricingType", "traits": { - "smithy.api#documentation": "

The type of long term pricing that was selected for the device.

" + "smithy.api#documentation": "

The type of long-term pricing that was selected for the device.

" } }, "CurrentActiveJob": { "target": "com.amazonaws.snowball#JobId", "traits": { - "smithy.api#documentation": "

The current active jobs on the device the long term pricing type.

" + "smithy.api#documentation": "

The current active jobs on the device the long-term pricing type.

" } }, "ReplacementJob": { "target": "com.amazonaws.snowball#JobId", "traits": { - "smithy.api#documentation": "

A new device that replaces a device that is ordered with long term pricing.

" + "smithy.api#documentation": "

A new device that replaces a device that is ordered with long-term pricing.

" } }, "IsLongTermPricingAutoRenew": { "target": "com.amazonaws.snowball#JavaBoolean", "traits": { - "smithy.api#documentation": "

If set to true, specifies that the current long term pricing type for the\n device should be automatically renewed before the long term pricing contract expires.

" + "smithy.api#documentation": "

If set to true, specifies that the current long-term pricing type for the\n device should be automatically renewed before the long-term pricing contract expires.

" } }, "LongTermPricingStatus": { "target": "com.amazonaws.snowball#String", "traits": { - "smithy.api#documentation": "

The status of the long term pricing type.

" + "smithy.api#documentation": "

The status of the long-term pricing type.

" } }, "SnowballType": { "target": "com.amazonaws.snowball#SnowballType", "traits": { - "smithy.api#documentation": "

The type of AWS Snow Family device associated with this long term pricing job.

" + "smithy.api#documentation": "

The type of AWS Snow Family device associated with this long-term pricing job.

" } }, "JobIds": { "target": "com.amazonaws.snowball#LongTermPricingAssociatedJobIdList", "traits": { - "smithy.api#documentation": "

The IDs of the jobs that are associated with a long term pricing type.

" + "smithy.api#documentation": "

The IDs of the jobs that are associated with a long-term pricing type.

" } } }, "traits": { - "smithy.api#documentation": "

Each LongTermPricingListEntry object contains information about a long term pricing type.

" + "smithy.api#documentation": "

Each LongTermPricingListEntry object contains information about a long-term pricing type.

" } }, "com.amazonaws.snowball#LongTermPricingType": { @@ -2345,13 +2402,33 @@ ] } }, + "com.amazonaws.snowball#NFSOnDeviceServiceConfiguration": { + "type": "structure", + "members": { + "StorageLimit": { + "target": "com.amazonaws.snowball#StorageLimit", + "traits": { + "smithy.api#documentation": "

The maximum NFS storage for one Snowball Family device.

" + } + }, + "StorageUnit": { + "target": "com.amazonaws.snowball#StorageUnit", + "traits": { + "smithy.api#documentation": "

The scale unit of the NFS storage on the device.

\n

Valid values: TB.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that represents metadata and configuration settings for NFS service on an AWS Snow Family device.

" + } + }, "com.amazonaws.snowball#Notification": { "type": "structure", "members": { "SnsTopicARN": { "target": "com.amazonaws.snowball#SnsTopicARN", "traits": { - "smithy.api#documentation": "

The new SNS TopicArn that you want to associate with this job. You can\n create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API\n action.

\n\n

You can subscribe email addresses to an Amazon SNS topic through the AWS Management\n Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.

" + "smithy.api#documentation": "

The new SNS TopicArn that you want to associate with this job. You can\n create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API\n action.

\n\n

You can subscribe email addresses to an Amazon SNS topic through the AWS Management\n Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.

" } }, "JobStatesToNotify": { @@ -2371,6 +2448,35 @@ "smithy.api#documentation": "

The Amazon Simple Notification Service (Amazon SNS) notification settings associated\n with a specific job. The Notification object is returned as a part of the\n response syntax of the DescribeJob action in the JobMetadata data\n type.

\n\n

When the notification settings are defined during job creation, you can choose to\n notify based on a specific set of job states using the JobStatesToNotify array of\n strings, or you can specify that you want to have Amazon SNS notifications sent out for all\n job states with NotifyAll set to true.

" } }, + "com.amazonaws.snowball#OnDeviceServiceConfiguration": { + "type": "structure", + "members": { + "NFSOnDeviceService": { + "target": "com.amazonaws.snowball#NFSOnDeviceServiceConfiguration", + "traits": { + "smithy.api#documentation": "

Represents the NFS service on a Snow Family device.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that represents metadata and configuration settings for services on an AWS Snow Family device.

" + } + }, + "com.amazonaws.snowball#RemoteManagement": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INSTALLED_ONLY", + "name": "INSTALLED_ONLY" + }, + { + "value": "INSTALLED_AUTOSTART", + "name": "INSTALLED_AUTOSTART" + } + ] + } + }, "com.amazonaws.snowball#ResourceARN": { "type": "string", "traits": { @@ -2378,7 +2484,7 @@ "min": 0, "max": 255 }, - "smithy.api#pattern": "arn:aws.*:*" + "smithy.api#pattern": "^arn:aws.*:*$" } }, "com.amazonaws.snowball#ReturnShippingLabelAlreadyExistsException": { @@ -2400,7 +2506,7 @@ "min": 0, "max": 255 }, - "smithy.api#pattern": "arn:aws.*:iam::[0-9]{12}:role/.*" + "smithy.api#pattern": "^arn:aws.*:iam::[0-9]{12}:role/" } }, "com.amazonaws.snowball#S3Resource": { @@ -2417,6 +2523,12 @@ "traits": { "smithy.api#documentation": "

For export jobs, you can provide an optional KeyRange within a specific\n Amazon S3 bucket. The length of the range is defined at job creation, and has either an\n inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are\n UTF-8 binary sorted.

" } + }, + "TargetOnDeviceServices": { + "target": "com.amazonaws.snowball#TargetOnDeviceServiceList", + "traits": { + "smithy.api#documentation": "

Specifies the service or services on the Snow Family device that your\n transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).

" + } } }, "traits": { @@ -2470,7 +2582,7 @@ "ShippingOption": { "target": "com.amazonaws.snowball#ShippingOption", "traits": { - "smithy.api#documentation": "

The shipping speed for a particular job. This speed doesn't dictate how soon you'll get\n the Snow device from the job's creation date. This speed represents how quickly it moves to its\n destination while in transit. Regional shipping speeds are as follows:

\n\n " + "smithy.api#documentation": "

The shipping speed for a particular job. This speed doesn't dictate how soon you'll get\n the Snow device from the job's creation date. This speed represents how quickly it moves to its\n destination while in transit. Regional shipping speeds are as follows:

\n\n " } }, "InboundShipment": { @@ -2631,7 +2743,26 @@ "min": 0, "max": 255 }, - "smithy.api#pattern": "arn:aws.*:sns:.*:[0-9]{12}:.*" + "smithy.api#pattern": "^arn:aws.*:sns:.*:[0-9]{12}:" + } + }, + "com.amazonaws.snowball#StorageLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.snowball#StorageUnit": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TB", + "name": "TB" + } + ] } }, "com.amazonaws.snowball#String": { @@ -2643,6 +2774,32 @@ } } }, + "com.amazonaws.snowball#TargetOnDeviceService": { + "type": "structure", + "members": { + "ServiceName": { + "target": "com.amazonaws.snowball#DeviceServiceName", + "traits": { + "smithy.api#documentation": "

Specifies the name of the service on the Snow Family device that your\n transferred data will be exported from or imported into.

" + } + }, + "TransferOption": { + "target": "com.amazonaws.snowball#TransferOption", + "traits": { + "smithy.api#documentation": "

Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that represents the service or services on the Snow Family device that your\n transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).

" + } + }, + "com.amazonaws.snowball#TargetOnDeviceServiceList": { + "type": "list", + "member": { + "target": "com.amazonaws.snowball#TargetOnDeviceService" + } + }, "com.amazonaws.snowball#TaxDocuments": { "type": "structure", "members": { @@ -2657,6 +2814,25 @@ "com.amazonaws.snowball#Timestamp": { "type": "timestamp" }, + "com.amazonaws.snowball#TransferOption": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IMPORT", + "name": "IMPORT" + }, + { + "value": "EXPORT", + "name": "EXPORT" + }, + { + "value": "LOCAL_USE", + "name": "LOCAL_USE" + } + ] + } + }, "com.amazonaws.snowball#UnsupportedAddressException": { "type": "structure", "members": { @@ -2726,6 +2902,12 @@ "smithy.api#documentation": "

The updated arrays of JobResource objects that can include updated\n S3Resource objects or LambdaResource objects.

" } }, + "OnDeviceServiceConfiguration": { + "target": "com.amazonaws.snowball#OnDeviceServiceConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies the service or services on the Snow Family device that your\n transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).

" + } + }, "AddressId": { "target": "com.amazonaws.snowball#AddressId", "traits": { @@ -2816,6 +2998,12 @@ "smithy.api#documentation": "

The updated JobResource object, or the updated JobResource object.

" } }, + "OnDeviceServiceConfiguration": { + "target": "com.amazonaws.snowball#OnDeviceServiceConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies the service or services on the Snow Family device that your\n transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).

" + } + }, "AddressId": { "target": "com.amazonaws.snowball#AddressId", "traits": { @@ -2869,7 +3057,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the state when a the shipment states changes to a different state.

" + "smithy.api#documentation": "

Updates the state when a shipment state changes to a different state.

" } }, "com.amazonaws.snowball#UpdateJobShipmentStateRequest": { @@ -2909,7 +3097,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the long term pricing type.

" + "smithy.api#documentation": "

Updates the long-term pricing type.

" } }, "com.amazonaws.snowball#UpdateLongTermPricingRequest": { @@ -2918,20 +3106,20 @@ "LongTermPricingId": { "target": "com.amazonaws.snowball#LongTermPricingId", "traits": { - "smithy.api#documentation": "

The ID of the long term pricing type for the device.

", + "smithy.api#documentation": "

The ID of the long-term pricing type for the device.

", "smithy.api#required": {} } }, "ReplacementJob": { "target": "com.amazonaws.snowball#JobId", "traits": { - "smithy.api#documentation": "

Specifies that a device that is ordered with long term pricing should be replaced with a new device.

" + "smithy.api#documentation": "

Specifies that a device that is ordered with long-term pricing should be replaced with a new device.

" } }, "IsLongTermPricingAutoRenew": { "target": "com.amazonaws.snowball#JavaBoolean", "traits": { - "smithy.api#documentation": "

If set to true, specifies that the current long term pricing type for the\n device should be automatically renewed before the long term pricing contract expires.

" + "smithy.api#documentation": "

If set to true, specifies that the current long-term pricing type for the\n device should be automatically renewed before the long-term pricing contract expires.

" } } } diff --git a/aws/sdk/aws-models/sns.json b/aws/sdk/aws-models/sns.json index 4232eeac0..7cb7951b7 100644 --- a/aws/sdk/aws-models/sns.json +++ b/aws/sdk/aws-models/sns.json @@ -249,6 +249,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationError", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

Indicates that the user has been denied access to the requested resource.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -320,6 +324,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ConcurrentAccess", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Can't perform multiple operations on a tag simultaneously. Perform the operations\n sequentially.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -877,6 +885,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "EndpointDisabled", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Exception error indicating endpoint disabled.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -890,6 +902,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "FilterPolicyLimitExceeded", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

Indicates that the number of filter polices in your AWS account exceeds the limit. To\n add more filter polices, submit an SNS Limit Increase case in the AWS Support\n Center.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -1219,6 +1235,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InternalError", + "httpResponseCode": 500 + }, "smithy.api#documentation": "

Indicates an internal service error.

", "smithy.api#error": "server", "smithy.api#httpError": 500 @@ -1232,6 +1252,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameter", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Indicates that a request parameter does not comply with the associated\n constraints.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1248,6 +1272,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ParameterValueInvalid", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Indicates that a request parameter does not comply with the associated\n constraints.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1261,6 +1289,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSecurity", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

The credential signature isn't valid. You must use an HTTPS endpoint and sign your\n request using Signature Version 4.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -1285,6 +1317,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSAccessDenied", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The ciphertext references a key that doesn't exist or that you don't have access\n to.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1298,6 +1334,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSDisabled", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the specified customer master key (CMK) isn't\n enabled.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1311,6 +1351,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSInvalidState", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the state of the specified resource isn't valid for\n this request. For more information, see How Key State Affects Use of a\n Customer Master Key in the AWS Key Management Service Developer\n Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1324,6 +1368,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSNotFound", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the specified entity or resource can't be\n found.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1337,6 +1385,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSOptInRequired", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

The AWS access key ID needs a subscription for the service.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -1350,6 +1402,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSThrottling", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was denied due to request throttling. For more information about\n throttling, see Limits in\n the AWS Key Management Service Developer Guide.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2089,6 +2145,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "NotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

Indicates that the requested resource does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -2190,6 +2250,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "OptedOut", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Indicates that the specified phone number opted out of receiving SMS messages from\n your AWS account. You can't send SMS messages to phone numbers that opt out.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2298,6 +2362,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "PlatformApplicationDisabled", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Exception error indicating platform application disabled.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2495,6 +2563,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

Can’t perform the action on the specified resource. Make sure that the resource\n exists.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -2816,6 +2888,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "StaleTag", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

A tag has been added to a resource with the same ARN as a deleted resource. Wait a\n short while and then retry the operation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2968,6 +3044,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionLimitExceeded", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

Indicates that the customer already owns the maximum allowed number of\n subscriptions.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -3024,6 +3104,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "TagLimitExceeded", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Can't add more than 50 tags to a topic.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3043,6 +3127,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "TagPolicy", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request doesn't comply with the IAM tag policy. Correct your request and then\n retry it.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3126,6 +3214,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "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#error": "client", "smithy.api#httpError": 429 @@ -3165,6 +3257,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "TopicLimitExceeded", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

Indicates that the customer already owns the maximum allowed number of topics.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -3283,6 +3379,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "UserError", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Indicates that a request parameter does not comply with the associated\n constraints.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3299,6 +3399,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ValidationException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Indicates that a parameter in the request is invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 diff --git a/aws/sdk/aws-models/sqs.json b/aws/sdk/aws-models/sqs.json index dc0e201c3..c7fe0d5f9 100644 --- a/aws/sdk/aws-models/sqs.json +++ b/aws/sdk/aws-models/sqs.json @@ -52,7 +52,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a permission to a queue for a specific \n principal.\n This allows sharing access to the queue.

\n

When you create a queue, you have full control access rights for the queue.\n Only you, the owner of the queue, can grant or deny permissions to the queue.\n For more information about these permissions, see\n Allow \n Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide.

\n \n \n \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

\n &AttributeName.1=first\n

\n

\n &AttributeName.2=second\n

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon Simple Queue Service Developer Guide.

\n " + "smithy.api#documentation": "

Adds a permission to a queue for a specific \n principal.\n This allows sharing access to the queue.

\n

When you create a queue, you have full control access rights for the queue.\n Only you, the owner of the queue, can grant or deny permissions to the queue.\n For more information about these permissions, see\n Allow \n Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.

\n \n \n \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

\n &AttributeName.1=first\n

\n

\n &AttributeName.2=second\n

\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

\n " } }, "com.amazonaws.sqs#AddPermissionRequest": { @@ -75,7 +75,7 @@ "AWSAccountIds": { "target": "com.amazonaws.sqs#AWSAccountIdList", "traits": { - "smithy.api#documentation": "

The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS\n account identification, see Your AWS Identifiers in the Amazon Simple Queue Service Developer Guide.

", + "smithy.api#documentation": "

The account numbers of the principals who are to receive\n permission. For information about locating the account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer\n Guide.

", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AWSAccountId" @@ -84,7 +84,7 @@ "Actions": { "target": "com.amazonaws.sqs#ActionNameList", "traits": { - "smithy.api#documentation": "

The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

\n

For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource \n in the Amazon Simple Queue Service Developer Guide.

\n

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch,\n DeleteMessageBatch, and ChangeMessageVisibilityBatch.

", + "smithy.api#documentation": "

The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

\n

For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource \n in the Amazon SQS Developer Guide.

\n

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch,\n DeleteMessageBatch, and ChangeMessageVisibilityBatch.

", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "ActionName" @@ -172,7 +172,7 @@ "name": "sqs" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "

Welcome to the Amazon Simple Queue Service API Reference.

\n

Amazon Simple Queue Service (Amazon SQS) is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.

\n

For information on the permissions you need to use this API, see\n Identity and\n access management in the Amazon Simple Queue Service Developer Guide.\n

\n

You can use AWS SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:

\n \n \n

\n Additional information\n

\n ", + "smithy.api#documentation": "

Welcome to the Amazon SQS API Reference.

\n

Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.

\n

For information on the permissions you need to use this API, see\n Identity and\n access management in the Amazon SQS Developer Guide.\n

\n

You can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:

\n \n \n

\n Additional information\n

\n ", "smithy.api#title": "Amazon Simple Queue Service", "smithy.api#xmlNamespace": { "uri": "http://queue.amazonaws.com/doc/2012-11-05/" @@ -189,6 +189,10 @@ "type": "structure", "members": {}, "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.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 @@ -198,6 +202,10 @@ "type": "structure", "members": {}, "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.BatchRequestTooLong", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The length of all the messages put together is more than the limit.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -279,7 +287,7 @@ } ], "traits": { - "smithy.api#documentation": "

Changes the visibility timeout of a specified message in a queue to a new value. The\n default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The\n maximum is 12 hours. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.

\n

For example, you have a message with a visibility timeout of 5 minutes. After 3\n minutes, you call ChangeMessageVisibility with a timeout of 10 minutes. You\n can continue to call ChangeMessageVisibility to extend the visibility\n timeout to the maximum allowed time. If you try to extend the visibility timeout beyond\n the maximum, your request is rejected.

\n

An Amazon SQS message has three basic states:

\n
    \n
  1. \n

    Sent to a queue by a producer.

    \n
    2. \n
  2. \n

    Received from the queue by a consumer.

    \n
    3. \n
  3. \n

    Deleted from the queue.

    \n
    4. \n
\n

A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages.\n A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages.

\n

Limits that apply to inflight messages are unrelated to the unlimited number of stored messages.

\n

For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). \n If you reach this limit, Amazon SQS returns the OverLimit error message.\n To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.\n To request a limit increase, file a support request.

\n

For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.

\n\n \n

If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.

\n

Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout \n for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received.

\n " + "smithy.api#documentation": "

Changes the visibility timeout of a specified message in a queue to a new value. The\n default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The\n maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.

\n

For example, you have a message with a visibility timeout of 5 minutes. After 3\n minutes, you call ChangeMessageVisibility with a timeout of 10 minutes. You\n can continue to call ChangeMessageVisibility to extend the visibility\n timeout to the maximum allowed time. If you try to extend the visibility timeout beyond\n the maximum, your request is rejected.

\n

An Amazon SQS message has three basic states:

\n
    \n
  1. \n

    Sent to a queue by a producer.

    \n
    2. \n
  2. \n

    Received from the queue by a consumer.

    \n
    3. \n
  3. \n

    Deleted from the queue.

    \n
    4. \n
\n

A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages.\n A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages.

\n

Limits that apply to inflight messages are unrelated to the unlimited number of stored messages.

\n

For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). \n If you reach this limit, Amazon SQS returns the OverLimit error message.\n To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.\n To request a limit increase, file a support request.

\n

For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.

\n\n \n

If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.

\n

Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout \n for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received.

\n " } }, "com.amazonaws.sqs#ChangeMessageVisibilityBatch": { @@ -456,7 +464,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:

\n \n\n

To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.

\n \n

After you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.

\n \n

To get the queue URL, use the \n GetQueueUrl\n action. \n GetQueueUrl\n requires only the QueueName parameter.\n be aware of existing queue names:

\n \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

\n &AttributeName.1=first\n

\n

\n &AttributeName.2=second\n

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon Simple Queue Service Developer Guide.

\n " + "smithy.api#documentation": "

Creates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:

\n \n\n

To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.

\n \n

After you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.

\n \n

To get the queue URL, use the \n GetQueueUrl\n action. \n GetQueueUrl\n requires only the QueueName parameter.\n be aware of existing queue names:

\n \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

\n &AttributeName.1=first\n

\n

\n &AttributeName.2=second\n

\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

\n " } }, "com.amazonaws.sqs#CreateQueueRequest": { @@ -472,7 +480,7 @@ "tags": { "target": "com.amazonaws.sqs#TagMap", "traits": { - "smithy.api#documentation": "

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

\n \n

When you use queue tags, keep the following guidelines in mind:

\n \n

For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.

\n \n

To be able to tag a queue on creation, you must have the\n sqs:CreateQueue and sqs:TagQueue permissions.

\n

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon Simple Queue Service Developer Guide.

\n ", + "smithy.api#documentation": "

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.

\n \n

When you use queue tags, keep the following guidelines in mind:

\n \n

For a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.

\n \n

To be able to tag a queue on creation, you must have the\n sqs:CreateQueue and sqs:TagQueue permissions.

\n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

\n ", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Tag" } @@ -480,7 +488,7 @@ "Attributes": { "target": "com.amazonaws.sqs#QueueAttributeMap", "traits": { - "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:

\n \n \n

The following attributes apply only to server-side-encryption:

\n \n \n \n

The following attributes apply only to FIFO (first-in-first-out) queues:

\n \n \n \n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n \n

To enable high throughput for FIFO queues, do the following:

\n \n

If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.

\n

For information on throughput quotas, \n see Quotas related to messages \n in the Amazon Simple Queue Service Developer Guide.

", + "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:

\n \n \n

The following attributes apply only to server-side-encryption:

\n \n \n \n

The following attributes apply only to FIFO (first-in-first-out) queues:

\n \n \n \n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n \n

To enable high throughput for FIFO queues, do the following:

\n \n

If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.

\n

For information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.

", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Attribute" } @@ -674,7 +682,7 @@ "target": "com.amazonaws.sqs#DeleteQueueRequest" }, "traits": { - "smithy.api#documentation": "

Deletes the queue specified by the QueueUrl, regardless of the queue's contents.

\n \n

Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.\n

\n \n

When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a \n \n SendMessage\n request might succeed, but after 60 seconds the queue and the message you sent no longer exist.

\n

When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon Simple Queue Service Developer Guide.

\n " + "smithy.api#documentation": "

Deletes the queue specified by the QueueUrl, regardless of the queue's contents.

\n \n

Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.\n

\n \n

When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a \n \n SendMessage\n request might succeed, but after 60 seconds the queue and the message you sent no longer exist.

\n

When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

\n " } }, "com.amazonaws.sqs#DeleteQueueRequest": { @@ -696,6 +704,10 @@ "type": "structure", "members": {}, "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.EmptyBatchRequest", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The batch request doesn't contain any entries.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -731,7 +743,7 @@ "AttributeNames": { "target": "com.amazonaws.sqs#AttributeNameList", "traits": { - "smithy.api#documentation": "

A list of attributes for which to retrieve information.

\n \n

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

\n \n

The following attributes are supported:

\n \n

The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, \n and ApproximateNumberOfMessagesVisible metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is required for \n the queue metadata to reach eventual consistency.

\n \n \n \n

The following attributes apply only to server-side-encryption:

\n \n \n \n

The following attributes apply only to FIFO (first-in-first-out) queues:

\n \n \n \n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n \n

To enable high throughput for FIFO queues, do the following:

\n \n

If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.

\n

For information on throughput quotas, \n see Quotas related to messages \n in the Amazon Simple Queue Service Developer Guide.

", + "smithy.api#documentation": "

A list of attributes for which to retrieve information.

\n

The AttributeName.N parameter is optional, but if you don't specify values for this parameter,\n the request returns empty results.

\n \n

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

\n \n

The following attributes are supported:

\n \n

The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, \n and ApproximateNumberOfMessagesVisible metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is required for \n the queue metadata to reach eventual consistency.

\n \n \n \n

The following attributes apply only to server-side-encryption:

\n \n \n \n

The following attributes apply only to FIFO (first-in-first-out) queues:

\n \n \n \n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n \n

To enable high throughput for FIFO queues, do the following:

\n \n

If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.

\n

For information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.

", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AttributeName" } @@ -771,7 +783,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the URL of an existing Amazon SQS queue.

\n

To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. \n For more information about shared queue access, see \n AddPermission\n or see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide.\n

" + "smithy.api#documentation": "

Returns the URL of an existing Amazon SQS queue.

\n

To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. \n For more information about shared queue access, see \n AddPermission\n or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.\n

" } }, "com.amazonaws.sqs#GetQueueUrlRequest": { @@ -787,7 +799,7 @@ "QueueOwnerAWSAccountId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

The AWS account ID of the account that created the queue.

" + "smithy.api#documentation": "

The account ID of the account that created the queue.

" } } }, @@ -806,7 +818,7 @@ } }, "traits": { - "smithy.api#documentation": "

For more information, see Interpreting Responses in the Amazon Simple Queue Service Developer Guide.

" + "smithy.api#documentation": "

For more information, see Interpreting Responses in the Amazon SQS Developer Guide.

" } }, "com.amazonaws.sqs#Integer": { @@ -824,6 +836,10 @@ "type": "structure", "members": {}, "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.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 @@ -859,7 +875,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.

\n

The ListDeadLetterSourceQueues methods supports\n pagination. Set parameter MaxResults in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults,\n the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to\n display, the response includes a value for NextToken. Use\n NextToken as a parameter in your next request to\n ListDeadLetterSourceQueues to receive the next page of results.

\n \n

For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon Simple Queue Service Developer Guide.

", + "smithy.api#documentation": "

Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.

\n

The ListDeadLetterSourceQueues methods supports\n pagination. Set parameter MaxResults in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults,\n the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to\n display, the response includes a value for NextToken. Use\n NextToken as a parameter in your next request to\n ListDeadLetterSourceQueues to receive the next page of results.

\n \n

For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon SQS Developer Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -927,7 +943,7 @@ "target": "com.amazonaws.sqs#ListQueueTagsResult" }, "traits": { - "smithy.api#documentation": "

List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon Simple Queue Service Developer Guide.

\n " + "smithy.api#documentation": "

List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.

\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

\n " } }, "com.amazonaws.sqs#ListQueueTagsRequest": { @@ -964,7 +980,7 @@ "target": "com.amazonaws.sqs#ListQueuesResult" }, "traits": { - "smithy.api#documentation": "

Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional \n QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.

\n

The listQueues methods supports\n pagination. Set parameter MaxResults in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults,\n the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to\n display, the response includes a value for NextToken. Use\n NextToken as a parameter in your next request to\n listQueues to receive the next page of results.

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon Simple Queue Service Developer Guide.

\n ", + "smithy.api#documentation": "

Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional \n QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.

\n

The listQueues methods supports\n pagination. Set parameter MaxResults in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults,\n the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to\n display, the response includes a value for NextToken. Use\n NextToken as a parameter in your next request to\n listQueues to receive the next page of results.

\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1027,7 +1043,7 @@ "MessageId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

A unique identifier for the message. A MessageIdis considered unique across all AWS accounts for an extended period of time.

" + "smithy.api#documentation": "

A unique identifier for the message. A MessageIdis considered unique across all accounts for an extended period of time.

" } }, "ReceiptHandle": { @@ -1065,7 +1081,7 @@ "MessageAttributes": { "target": "com.amazonaws.sqs#MessageBodyAttributeMap", "traits": { - "smithy.api#documentation": "

Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

", + "smithy.api#documentation": "

Each message attribute consists of a Name, Type, \nand Value. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.

", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "MessageAttribute" } @@ -1118,7 +1134,7 @@ "DataType": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

\n

You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

", + "smithy.api#documentation": "

Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

\n

You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.

", "smithy.api#required": {} } } @@ -1167,6 +1183,10 @@ "type": "structure", "members": {}, "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.MessageNotInflight", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified message isn't in flight.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1271,7 +1291,7 @@ "DataType": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

\n

You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

", + "smithy.api#documentation": "

Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

\n

You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.

", "smithy.api#required": {} } } @@ -1284,6 +1304,10 @@ "type": "structure", "members": {}, "traits": { + "aws.protocols#awsQueryError": { + "code": "OverLimit", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

The specified action violates a limit. For example, ReceiveMessage\n returns this error if the maximum number of inflight messages is reached and\n AddPermission returns this error if the maximum number of permissions\n for the queue is reached.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -1310,6 +1334,10 @@ "type": "structure", "members": {}, "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.PurgeQueueInProgress", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

Indicates that the specified queue previously received a PurgeQueue request within the last 60 seconds (the time it can take to delete the messages in the queue).

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -1436,6 +1464,10 @@ "type": "structure", "members": {}, "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.QueueDeletedRecently", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

You must wait 60 seconds after deleting a queue before you can create another queue\n with the same name.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1445,6 +1477,10 @@ "type": "structure", "members": {}, "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.NonExistentQueue", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified queue doesn't exist.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1454,6 +1490,10 @@ "type": "structure", "members": {}, "traits": { + "aws.protocols#awsQueryError": { + "code": "QueueAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

A queue with this name already exists. Amazon SQS returns this error only if the request\n includes attributes whose values differ from those of the existing queue.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1487,7 +1527,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. \n For more information, see Amazon SQS Long Polling in the Amazon Simple Queue Service Developer Guide.\n

\n

Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned. \n If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, \n you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.\n

\n

For each message returned, the response includes the following:

\n \n

The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue \n and Message Identifiers in the Amazon Simple Queue Service Developer Guide.

\n

You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue \n is used for the returned messages. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.

\n

A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.

\n \n

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

\n " + "smithy.api#documentation": "

Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. \n For more information, see Amazon SQS Long Polling in the Amazon SQS Developer Guide.\n

\n

Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned. \n If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, \n you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.\n

\n

For each message returned, the response includes the following:

\n \n

The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue \n and Message Identifiers in the Amazon SQS Developer Guide.

\n

You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue \n is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.

\n

A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.

\n \n

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

\n " } }, "com.amazonaws.sqs#ReceiveMessageRequest": { @@ -1503,7 +1543,7 @@ "AttributeNames": { "target": "com.amazonaws.sqs#AttributeNameList", "traits": { - "smithy.api#documentation": "

A list of attributes that need to be returned along with each message. These attributes\n include:

\n ", + "smithy.api#documentation": "

A list of attributes that need to be returned along with each message. These attributes\n include:

\n ", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AttributeName" } @@ -1537,7 +1577,7 @@ "ReceiveRequestAttemptId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, \n it is possible to retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.

\n \n

The maximum length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using ReceiveRequestAttemptId, see\n Using the ReceiveRequestAttemptId Request Parameter\n in the Amazon Simple Queue Service Developer Guide.

" + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, \n it is possible to retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.

\n \n

The maximum length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using ReceiveRequestAttemptId, see\n Using the ReceiveRequestAttemptId Request Parameter\n in the Amazon SQS Developer Guide.

" } } }, @@ -1567,7 +1607,7 @@ "target": "com.amazonaws.sqs#RemovePermissionRequest" }, "traits": { - "smithy.api#documentation": "

Revokes any permissions in the queue policy that matches the specified Label parameter.

\n \n \n " + "smithy.api#documentation": "

Revokes any permissions in the queue policy that matches the specified Label parameter.

\n \n \n " } }, "com.amazonaws.sqs#RemovePermissionRequest": { @@ -1694,7 +1734,7 @@ "MessageAttributes": { "target": "com.amazonaws.sqs#MessageBodyAttributeMap", "traits": { - "smithy.api#documentation": "

Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

", + "smithy.api#documentation": "

Each message attribute consists of a Name, Type, \nand Value. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.

", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "MessageAttribute" } @@ -1702,7 +1742,7 @@ "MessageSystemAttributes": { "target": "com.amazonaws.sqs#MessageBodySystemAttributeMap", "traits": { - "smithy.api#documentation": "

The message system attribute to send Each message system attribute consists of a Name, Type, and Value.

\n \n \n ", + "smithy.api#documentation": "

The message system attribute to send Each message system attribute consists of a Name, Type, and Value.

\n \n \n ", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "MessageSystemAttribute" } @@ -1710,13 +1750,13 @@ "MessageDeduplicationId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular \n MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are \n accepted successfully but aren't delivered. For more information, see \n Exactly-once processing in the Amazon Simple Queue Service Developer Guide.

\n \n \n

The MessageDeduplicationId is available to the consumer of the\n 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 \n MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

\n

Amazon SQS 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. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageDeduplicationId, see\n Using the MessageDeduplicationId Property\n in the Amazon Simple Queue Service Developer Guide.

" + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular \n MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are \n accepted successfully but aren't delivered. For more information, see \n Exactly-once processing in the Amazon SQS Developer Guide.

\n \n \n

The MessageDeduplicationId is available to the consumer of the\n 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 \n MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

\n

Amazon SQS 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. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageDeduplicationId, see\n Using the MessageDeduplicationId Property\n in the Amazon SQS Developer Guide.

" } }, "MessageGroupId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.

\n \n

The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageGroupId, see\n Using the MessageGroupId Property\n in the Amazon Simple Queue Service Developer Guide.

\n \n

\n MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

\n " + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.

\n \n

The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageGroupId, see\n Using the MessageGroupId Property\n in the Amazon SQS Developer Guide.

\n \n

\n MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

\n " } } }, @@ -1789,7 +1829,7 @@ "MD5OfMessageSystemAttributes": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

" + "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message system attribute string. You can use this \nattribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

" } }, "SequenceNumber": { @@ -1835,7 +1875,7 @@ "MessageAttributes": { "target": "com.amazonaws.sqs#MessageBodyAttributeMap", "traits": { - "smithy.api#documentation": "

Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

", + "smithy.api#documentation": "

Each message attribute consists of a Name, Type, \nand Value. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.

", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "MessageAttribute" } @@ -1843,7 +1883,7 @@ "MessageSystemAttributes": { "target": "com.amazonaws.sqs#MessageBodySystemAttributeMap", "traits": { - "smithy.api#documentation": "

The message system attribute to send. Each message system attribute consists of a Name, Type, and Value.

\n \n \n ", + "smithy.api#documentation": "

The message system attribute to send. Each message system attribute consists of a Name, Type, and Value.

\n \n \n ", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "MessageSystemAttribute" } @@ -1851,13 +1891,13 @@ "MessageDeduplicationId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId \n are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see \n Exactly-once processing in the Amazon Simple Queue Service Developer Guide.

\n \n \n

The MessageDeduplicationId is available to the consumer of the\n 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 \n MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

\n

Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

\n \n

The maximum length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageDeduplicationId, see\n Using the MessageDeduplicationId Property\n in the Amazon Simple Queue Service Developer Guide.

" + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId \n are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see \n Exactly-once processing in the Amazon SQS Developer Guide.

\n \n \n

The MessageDeduplicationId is available to the consumer of the\n 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 \n MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

\n

Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

\n \n

The maximum length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageDeduplicationId, see\n Using the MessageDeduplicationId Property\n in the Amazon SQS Developer Guide.

" } }, "MessageGroupId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.

\n \n

The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageGroupId, see\n Using the MessageGroupId Property\n in the Amazon Simple Queue Service Developer Guide.

\n \n

\n MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

\n " + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.

\n \n

The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageGroupId, see\n Using the MessageGroupId Property\n in the Amazon SQS Developer Guide.

\n \n

\n MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

\n " } } }, @@ -1883,13 +1923,13 @@ "MD5OfMessageSystemAttributes": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.

" + "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message system attribute string. You can use this \nattribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.

" } }, "MessageId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers\n in the Amazon Simple Queue Service Developer Guide.\n

" + "smithy.api#documentation": "

An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers\n in the Amazon SQS Developer Guide.\n

" } }, "SequenceNumber": { @@ -1914,7 +1954,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. \n Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.

\n \n \n " + "smithy.api#documentation": "

Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. \n Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.

\n \n \n " } }, "com.amazonaws.sqs#SetQueueAttributesRequest": { @@ -1930,7 +1970,7 @@ "Attributes": { "target": "com.amazonaws.sqs#QueueAttributeMap", "traits": { - "smithy.api#documentation": "

A map of attributes to set.

\n

The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:

\n \n \n

The following attributes apply only to server-side-encryption:

\n \n \n \n

The following attribute applies only to FIFO (first-in-first-out) queues:

\n \n \n \n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n \n

To enable high throughput for FIFO queues, do the following:

\n \n

If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.

\n

For information on throughput quotas, \n see Quotas related to messages \n in the Amazon Simple Queue Service Developer Guide.

", + "smithy.api#documentation": "

A map of attributes to set.

\n

The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:

\n \n \n

The following attributes apply only to server-side-encryption:

\n \n \n \n

The following attribute applies only to FIFO (first-in-first-out) queues:

\n \n \n \n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n \n

To enable high throughput for FIFO queues, do the following:

\n \n

If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.

\n

For information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.

", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Attribute" @@ -1983,7 +2023,7 @@ "target": "com.amazonaws.sqs#TagQueueRequest" }, "traits": { - "smithy.api#documentation": "

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

\n \n

When you use queue tags, keep the following guidelines in mind:

\n \n

For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon Simple Queue Service Developer Guide.

\n " + "smithy.api#documentation": "

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.

\n \n

When you use queue tags, keep the following guidelines in mind:

\n \n

For a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.

\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

\n " } }, "com.amazonaws.sqs#TagQueueRequest": { @@ -2017,6 +2057,10 @@ "type": "structure", "members": {}, "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.TooManyEntriesInBatchRequest", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The batch request contains more entries than permissible.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2026,6 +2070,10 @@ "type": "structure", "members": {}, "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.UnsupportedOperation", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Error code 400. Unsupported operation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2037,7 +2085,7 @@ "target": "com.amazonaws.sqs#UntagQueueRequest" }, "traits": { - "smithy.api#documentation": "

Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

\n \n

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon Simple Queue Service Developer Guide.

\n " + "smithy.api#documentation": "

Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.

\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

\n " } }, "com.amazonaws.sqs#UntagQueueRequest": { diff --git a/aws/sdk/aws-models/ssm-contacts.json b/aws/sdk/aws-models/ssm-contacts.json index 76b7e7d40..4d808225a 100644 --- a/aws/sdk/aws-models/ssm-contacts.json +++ b/aws/sdk/aws-models/ssm-contacts.json @@ -234,7 +234,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "^[a-zA-Z0-9_\\-\\s\\.]*$" + "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.\\-]*$" } }, "com.amazonaws.ssmcontacts#ChannelTargetInfo": { @@ -425,10 +425,10 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 255 }, - "smithy.api#pattern": "^[a-zA-Z0-9_\\-\\s\\.]*$" + "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.\\-]*$" } }, "com.amazonaws.ssmcontacts#ContactTargetInfo": { @@ -1886,6 +1886,9 @@ }, { "target": "com.amazonaws.ssmcontacts#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmcontacts#ValidationException" } ], "traits": { @@ -2023,7 +2026,7 @@ "min": 1, "max": 395000 }, - "smithy.api#pattern": ".*\\S.*" + "smithy.api#pattern": "\\S" } }, "com.amazonaws.ssmcontacts#PublicContent": { @@ -2442,7 +2445,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\\w+=\\/,.@]*:[0-9]+:([\\w+=\\/,.@:-]+)*" + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\\w+=\\/,.@]*:[0-9]+:([\\w+=\\/,.@:-]+)*$" } }, "com.amazonaws.ssmcontacts#Stage": { @@ -2603,6 +2606,9 @@ { "target": "com.amazonaws.ssmcontacts#ResourceNotFoundException" }, + { + "target": "com.amazonaws.ssmcontacts#ThrottlingException" + }, { "target": "com.amazonaws.ssmcontacts#ValidationException" } @@ -2681,7 +2687,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 255 + "max": 128 }, "smithy.api#pattern": "^[\\\\\\/a-zA-Z0-9_+=\\-]*$" } @@ -2758,7 +2764,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 255 + "max": 256 }, "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*$" } @@ -2876,6 +2882,9 @@ }, { "target": "com.amazonaws.ssmcontacts#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmcontacts#ValidationException" } ], "traits": { diff --git a/aws/sdk/aws-models/ssm-incidents.json b/aws/sdk/aws-models/ssm-incidents.json index 20f4f25d9..e2ab5381f 100644 --- a/aws/sdk/aws-models/ssm-incidents.json +++ b/aws/sdk/aws-models/ssm-incidents.json @@ -4041,4 +4041,4 @@ } } } -} +} \ No newline at end of file diff --git a/aws/sdk/aws-models/sts.json b/aws/sdk/aws-models/sts.json index 4b9552b67..aa321ed83 100644 --- a/aws/sdk/aws-models/sts.json +++ b/aws/sdk/aws-models/sts.json @@ -593,6 +593,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ExpiredTokenException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The web identity token that was passed is expired or is not valid. Get a new identity\n token from the identity provider and then retry the request.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -844,6 +848,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "IDPCommunicationError", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request could not be fulfilled because the identity provider (IDP) that\n was asked to verify the incoming identity token could not be reached. This is often a\n transient error caused by network conditions. Retry the request a limited number of\n times so that you don't exceed the request rate. If the error persists, the\n identity provider might be down or not responding.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -857,6 +865,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "IDPRejectedClaim", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

The identity provider (IdP) reported that authentication failed. This might be because\n the claim is invalid.

\n

If this error is returned for the AssumeRoleWithWebIdentity operation, it\n can also mean that the claim has expired or has been explicitly revoked.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -870,6 +882,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidAuthorizationMessageException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The error returned if the message passed to DecodeAuthorizationMessage\n was invalid. This can happen if the token contains invalid characters, such as\n linebreaks.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -883,6 +899,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidIdentityToken", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The web identity token that was passed could not be validated by AWS. Get a new\n identity token from the identity provider and then retry the request.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -899,6 +919,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "MalformedPolicyDocument", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the policy document was malformed. The error message\n describes the specific error.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -915,6 +939,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "PackedPolicyTooLarge", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the total packed size of the session policies and\n session tags combined was too large. An AWS conversion compresses the session policy\n document, session policy ARNs, and session tags into a packed binary format that has a\n separate limit. The error message indicates by percentage how close the policies and\n tags are to the upper size limit. For more information, see Passing Session Tags in STS in\n the IAM User Guide.

\n

You could receive this error even though you meet other defined session policy and\n session tag limits. For more information, see IAM and STS Entity\n Character Limits in the IAM User Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -942,6 +970,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "RegionDisabledException", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

STS is not activated in the requested region for the account that is being asked to\n generate credentials. The account administrator must use the IAM console to activate STS\n in that region. For more information, see Activating and\n Deactivating AWS STS in an AWS Region in the IAM User\n Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -991,7 +1023,7 @@ "min": 16, "max": 128 }, - "smithy.api#pattern": "[\\w]*" + "smithy.api#pattern": "^[\\w]*$" } }, "com.amazonaws.sts#accessKeySecretType": { @@ -1007,7 +1039,7 @@ "min": 20, "max": 2048 }, - "smithy.api#pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]+" + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]+$" } }, "com.amazonaws.sts#assumedRoleIdType": { @@ -1017,7 +1049,7 @@ "min": 2, "max": 193 }, - "smithy.api#pattern": "[\\w+=,.@:-]*" + "smithy.api#pattern": "^[\\w+=,.@:-]*$" } }, "com.amazonaws.sts#clientTokenType": { @@ -1064,7 +1096,7 @@ "min": 2, "max": 1224 }, - "smithy.api#pattern": "[\\w+=,.@:\\/-]*" + "smithy.api#pattern": "^[\\w+=,.@:\\/-]*$" } }, "com.amazonaws.sts#federatedIdType": { @@ -1074,7 +1106,7 @@ "min": 2, "max": 193 }, - "smithy.api#pattern": "[\\w+=,.@\\:-]*" + "smithy.api#pattern": "^[\\w+=,.@\\:-]*$" } }, "com.amazonaws.sts#idpCommunicationErrorMessage": { @@ -1130,7 +1162,7 @@ "min": 2, "max": 64 }, - "smithy.api#pattern": "[\\w+=,.@-]*" + "smithy.api#pattern": "^[\\w+=,.@-]*$" } }, "com.amazonaws.sts#serialNumberType": { @@ -1140,7 +1172,7 @@ "min": 9, "max": 256 }, - "smithy.api#pattern": "[\\w+=/:,.@-]*" + "smithy.api#pattern": "^[\\w+=/:,.@-]*$" } }, "com.amazonaws.sts#sessionPolicyDocumentType": { @@ -1150,7 +1182,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" } }, "com.amazonaws.sts#sourceIdentityType": { @@ -1160,7 +1192,7 @@ "min": 2, "max": 64 }, - "smithy.api#pattern": "[\\w+=,.@-]*" + "smithy.api#pattern": "^[\\w+=,.@-]*$" } }, "com.amazonaws.sts#tagKeyListType": { @@ -1182,7 +1214,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+" + "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+$" } }, "com.amazonaws.sts#tagListType": { @@ -1204,7 +1236,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*" + "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$" } }, "com.amazonaws.sts#tokenCodeType": { @@ -1214,7 +1246,7 @@ "min": 6, "max": 6 }, - "smithy.api#pattern": "[\\d]*" + "smithy.api#pattern": "^[\\d]*$" } }, "com.amazonaws.sts#tokenType": { @@ -1239,7 +1271,7 @@ "min": 2, "max": 32 }, - "smithy.api#pattern": "[\\w+=,.@-]*" + "smithy.api#pattern": "^[\\w+=,.@-]*$" } }, "com.amazonaws.sts#webIdentitySubjectType": { diff --git a/aws/sdk/aws-models/transfer.json b/aws/sdk/aws-models/transfer.json index 375f01aa9..2a7d94191 100644 --- a/aws/sdk/aws-models/transfer.json +++ b/aws/sdk/aws-models/transfer.json @@ -37,6 +37,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "AccessDenied", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -112,7 +116,7 @@ } ], "traits": { - "smithy.api#documentation": "

Used by administrators to choose which groups in the directory should have access to\n upload and download files over the enabled protocols using AWS Transfer Family. For example, a\n Microsoft Active Directory might contain 50,000 users, but only a small fraction might need\n the ability to transfer files to the server. An administrator can use\n CreateAccess to limit the access to the correct set of users who need this\n ability.

" + "smithy.api#documentation": "

Used by administrators to choose which groups in the directory should have access to\n upload and download files over the enabled protocols using Amazon Web Services Transfer Family. For example, a\n Microsoft Active Directory might contain 50,000 users, but only a small fraction might need\n the ability to transfer files to the server. An administrator can use\n CreateAccess to limit the access to the correct set of users who need this\n ability.

" } }, "com.amazonaws.transfer#CreateAccessRequest": { @@ -133,13 +137,13 @@ "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it will be displayed as is. You also must ensure that your AWS Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]\n

\n

In most cases, you can use this value instead of the scope-down policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n \n

If the target of a logical directory entry does not exist in Amazon S3 or Amazon EFS, the\n entry will be ignored. As a workaround, you can use the Amazon S3 API or EFS API to create\n 0-byte objects as place holders for your directory. If using the AWS CLI, use the\n s3api or efsapi call instead of s3 or\n efs so you can use the put-object operation. For example, you\n can use the following.

\n

\n aws s3api put-object --bucket bucketname --key path/to/folder/\n

\n

The end of the key name must end in a / for it to be considered a\n folder.

\n " + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]\n

\n

In most cases, you can use this value instead of the scope-down policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n \n \n

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is\n ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place\n holders for your directory. If using the CLI, use the s3api or efsapi call instead of\n s3 or efs so you can use the put-object operation. For example, you use the\n following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make\n sure that the end of the key name ends in a / for it to be considered a folder.

\n " } }, "Policy": { "target": "com.amazonaws.transfer#Policy", "traits": { - "smithy.api#documentation": "

A scope-down policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

\n \n \n

This only applies when domain of ServerId is S3.\n Amazon EFS does not use scope-down policies.

\n

For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

\n

For an example of a scope-down policy, see Example\n scope-down policy.

\n

For more information, see AssumeRole in the AWS Security Token Service API\n Reference.

\n " + "smithy.api#documentation": "

A scope-down policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

\n \n \n

This only applies when domain of ServerId is S3.\n Amazon EFS does not use scope-down policies.

\n

For scope-down policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

\n

For an example of a scope-down policy, see Example\n scope-down policy.

\n

For more information, see AssumeRole in the Amazon Web Services Security Token Service API\n Reference.

\n " } }, "PosixProfile": { @@ -162,7 +166,7 @@ "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using AWS Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.

\n\n

\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n

\n \n

In that command, replace YourGroupName with the name of your Active Directory group.

\n\n

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-

", + "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.

\n\n

\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n

\n \n

In that command, replace YourGroupName with the name of your Active Directory group.

\n\n

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-

", "smithy.api#required": {} } } @@ -181,7 +185,7 @@ "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "

The external ID of the group whose users have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using AWS Transfer Family.

", + "smithy.api#documentation": "

The external ID of the group whose users have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web Services Transfer Family.

", "smithy.api#required": {} } } @@ -216,7 +220,7 @@ } ], "traits": { - "smithy.api#documentation": "

Instantiates an auto-scaling virtual server based on the selected file transfer protocol\n in AWS. When you make updates to your file transfer protocol-enabled server or when you work\n with users, use the service-generated ServerId property that is assigned to the\n newly created server.

" + "smithy.api#documentation": "

Instantiates an auto-scaling virtual server based on the selected file transfer protocol\n in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work\n with users, use the service-generated ServerId property that is assigned to the\n newly created server.

" } }, "com.amazonaws.transfer#CreateServerRequest": { @@ -225,7 +229,7 @@ "Certificate": { "target": "com.amazonaws.transfer#Certificate", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required\n when Protocols is set to FTPS.

\n\n

To request a new public certificate, see Request a public certificate\n in the AWS Certificate Manager User Guide.

\n\n

To import an existing certificate into ACM, see Importing certificates into ACM\n in the AWS Certificate Manager User Guide.

\n\n

To request a private certificate to use FTPS through private IP addresses, see Request a\n private certificate in the AWS Certificate Manager User\n Guide.

\n\n

Certificates with the following cryptographic algorithms and key sizes are\n supported:

\n\n \n\n \n

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP\n address specified and information about the issuer.

\n " + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager (ACM) certificate. Required\n when Protocols is set to FTPS.

\n\n

To request a new public certificate, see Request a public certificate\n in the Amazon Web Services Certificate Manager User Guide.

\n\n

To import an existing certificate into ACM, see Importing certificates into ACM\n in the Amazon Web Services Certificate Manager User Guide.

\n\n

To request a private certificate to use FTPS through private IP addresses, see Request a\n private certificate in the Amazon Web Services Certificate Manager User\n Guide.

\n\n

Certificates with the following cryptographic algorithms and key sizes are\n supported:

\n\n \n\n \n

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP\n address specified and information about the issuer.

\n " } }, "Domain": { @@ -243,13 +247,13 @@ "EndpointType": { "target": "com.amazonaws.transfer#EndpointType", "traits": { - "smithy.api#documentation": "

The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)\n or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and \n resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

\n \n

After May 19, 2021, you won't be able to create a server using\n EndpointType=VPC_ENDPOINT in your AWS account if your account hasn't already\n done so before May 19, 2021. If you have already created servers with\n EndpointType=VPC_ENDPOINT in your AWS account on or before May 19, 2021,\n you will not be affected. After this date, use\n EndpointType=VPC.

\n \n

For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

\n

It is recommended that you use VPC as the EndpointType. With\n this endpoint type, you have the option to directly associate up to three Elastic IPv4\n addresses (BYO IP included) with your server's endpoint and use VPC security groups to\n restrict traffic by the client's public IP address. This is not possible with\n EndpointType set to VPC_ENDPOINT.

\n " + "smithy.api#documentation": "

The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)\n or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and \n resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

\n \n

After May 19, 2021, you won't be able to create a server using\n EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already\n done so before May 19, 2021. If you have already created servers with\n EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021,\n you will not be affected. After this date, use\n EndpointType=VPC.

\n \n

For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

\n

It is recommended that you use VPC as the EndpointType. With\n this endpoint type, you have the option to directly associate up to three Elastic IPv4\n addresses (BYO IP included) with your server's endpoint and use VPC security groups to\n restrict traffic by the client's public IP address. This is not possible with\n EndpointType set to VPC_ENDPOINT.

\n " } }, "HostKey": { "target": "com.amazonaws.transfer#HostKey", "traits": { - "smithy.api#documentation": "

The RSA private key as generated by the ssh-keygen -N \"\" -m PEM -f\n my-new-server-key command.

\n\n \n

If you aren't planning to migrate existing users from an existing SFTP-enabled\n server to a new server, don't update the host key. Accidentally changing a\n server's host key can be disruptive.

\n \n\n \n\n

For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer\n Family User Guide.

" + "smithy.api#documentation": "

The RSA private key as generated by the ssh-keygen -N \"\" -m PEM -f\n my-new-server-key command.

\n\n \n

If you aren't planning to migrate existing users from an existing SFTP-enabled\n server to a new server, don't update the host key. Accidentally changing a\n server's host key can be disruptive.

\n \n\n \n\n

For more information, see Change the host key for your SFTP-enabled server in the Amazon Web Services Transfer\n Family User Guide.

" } }, "IdentityProviderDetails": { @@ -261,19 +265,19 @@ "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 AWS Transfer Family service. Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in AWS Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in AWS using AD Connectors. This option also requires you to\n provide a Directory ID using the IdentityProviderDetails parameter. Use the\n 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.

" } }, "LoggingRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

Allows the service to write your users' activity to your Amazon CloudWatch logs for\n monitoring and auditing purposes.

" + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in\n your CloudWatch logs.

" } }, "Protocols": { "target": "com.amazonaws.transfer#Protocols", "traits": { - "smithy.api#documentation": "

Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:

\n\n \n\n \n

If you select FTPS, you must choose a certificate stored in AWS Certificate\n Manager (ACM) which will be used to identify your server when clients connect to it over\n FTPS.

\n\n

If Protocol includes either FTP or FTPS, then the\n EndpointType must be VPC and the\n IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.

\n\n

If Protocol includes FTP, then\n AddressAllocationIds cannot be associated.

\n\n

If Protocol is set only to SFTP, the EndpointType\n can be set to PUBLIC and the IdentityProviderType can be set to\n SERVICE_MANAGED.

\n " + "smithy.api#documentation": "

Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:

\n\n \n\n \n

If you select FTPS, you must choose a certificate stored in Amazon Web Services Certificate\n Manager (ACM) which is used to identify your server when clients connect to it over\n FTPS.

\n\n

If Protocol includes either FTP or FTPS, then the\n EndpointType must be VPC and the\n IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.

\n\n

If Protocol includes FTP, then\n AddressAllocationIds cannot be associated.

\n\n

If Protocol is set only to SFTP, the EndpointType\n can be set to PUBLIC and the IdentityProviderType can be set to\n SERVICE_MANAGED.

\n " } }, "SecurityPolicyName": { @@ -328,7 +332,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a user and associates them with an existing file transfer protocol-enabled server.\n You can only create and associate users with servers that have the\n IdentityProviderType set to SERVICE_MANAGED. Using parameters for\n CreateUser, you can specify the user name, set the home directory, store the\n user's public key, and assign the user's AWS Identity and Access Management (IAM)\n role. You can also optionally add a scope-down policy, and assign metadata with tags that can\n be used to group and search for users.

" + "smithy.api#documentation": "

Creates a user and associates them with an existing file transfer protocol-enabled server.\n You can only create and associate users with servers that have the\n IdentityProviderType set to SERVICE_MANAGED. Using parameters for\n CreateUser, you can specify the user name, set the home directory, store the\n user's public key, and assign the user's Amazon Web Services Identity and Access Management (IAM)\n role. You can also optionally add a scope-down policy, and assign metadata with tags that can\n be used to group and search for users.

" } }, "com.amazonaws.transfer#CreateUserRequest": { @@ -349,13 +353,13 @@ "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or EFS paths and keys should be visible to\n your user and how you want to make them visible. You will need to specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or EFS path. If you only specify a\n target, it will be displayed as is. You will need to also make sure that your IAM role\n provides access to paths in Target. This value can only be set when\n HomeDirectoryType is set to LOGICAL.

\n\n

The following is an Entry and Target pair example.

\n\n

\n [ { \"Entry\": \"your-personal-report.pdf\", \"Target\":\n \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]\n

\n\n

In most cases, you can use this value instead of the scope-down policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the HomeDirectory\n parameter value.

\n\n

The following is an Entry and Target pair example for\n chroot.

\n\n

\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n\n \n

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry will\n be ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place\n holders for your directory. If using the CLI, use the s3api or efsapi call instead of\n s3 or efs so you can use the put-object operation. For example, you use the\n following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make\n sure that the end of the key name ends in a / for it to be considered a\n folder.

\n " + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n\n

The following is an Entry and Target pair example.

\n\n

\n [ { \"Entry\": \"your-personal-report.pdf\", \"Target\":\n \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]\n

\n\n

In most cases, you can use this value instead of the scope-down policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the HomeDirectory\n parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n \n \n

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is\n ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place\n holders for your directory. If using the CLI, use the s3api or efsapi call instead of\n s3 or efs so you can use the put-object operation. For example, you use the\n following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make\n sure that the end of the key name ends in a / for it to be considered a folder.

\n " } }, "Policy": { "target": "com.amazonaws.transfer#Policy", "traits": { - "smithy.api#documentation": "

A scope-down policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

\n\n \n

This only applies when domain of ServerId is S3. EFS does not use scope down policy.

\n

For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead\n of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass\n it in the Policy argument.

\n\n \n\n

For an example of a scope-down policy, see Example scope-down\n policy.

\n\n \n\n

For more information, see AssumeRole in the AWS\n Security Token Service API Reference.

\n " + "smithy.api#documentation": "

A scope-down policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

\n\n \n

This only applies when domain of ServerId is S3. EFS does not use scope down policy.

\n

For scope-down policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead\n of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass\n it in the Policy argument.

\n\n \n\n

For an example of a scope-down policy, see Example scope-down\n policy.

\n\n \n\n

For more information, see AssumeRole in the Amazon Web Services\n Security Token Service API Reference.

\n " } }, "PosixProfile": { @@ -457,7 +461,7 @@ "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using AWS Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.

\n\n

\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n

\n \n

In that command, replace YourGroupName with the name of your Active Directory group.

\n\n

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-

", + "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.

\n\n

\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n

\n \n

In that command, replace YourGroupName with the name of your Active Directory group.

\n\n

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-

", "smithy.api#required": {} } } @@ -634,7 +638,7 @@ "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using AWS Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.

\n\n

\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n

\n \n

In that command, replace YourGroupName with the name of your Active Directory group.

\n\n

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-

", + "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.

\n\n

\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n

\n \n

In that command, replace YourGroupName with the name of your Active Directory group.

\n\n

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-

", "smithy.api#required": {} } } @@ -798,7 +802,7 @@ "UserName": { "target": "com.amazonaws.transfer#UserName", "traits": { - "smithy.api#documentation": "

The name of the user assigned to one or more servers. User names are part of the sign-in\n credentials to use the AWS Transfer Family service and perform file transfer tasks.

", + "smithy.api#documentation": "

The name of the user assigned to one or more servers. User names are part of the sign-in\n credentials to use the Amazon Web Services Transfer Family service and perform file transfer tasks.

", "smithy.api#required": {} } } @@ -835,7 +839,7 @@ "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths\n and keys should be visible to the associated access and how you want to make them visible. You\n must specify the \"Entry\" and \"Target\" pair, where Entry\n shows how the path is made visible and Target is the actual Amazon S3 or EFS\n path. If you only specify a target, it will be displayed as is. You also must ensure that your\n AWS Identity and Access Management (IAM) role provides access to paths in\n Target.

\n \n

In most cases, you can use this value instead of the scope-down policy to lock down the\n associated access to the designated home directory (\"chroot\"). To do this, you\n can set Entry to '/' and set Target to the\n HomeDirectory parameter value.

" + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n \n

In most cases, you can use this value instead of the scope-down policy to lock down the\n associated access to the designated home directory (\"chroot\"). To do this, you\n can set Entry to '/' and set Target to the\n HomeDirectory parameter value.

" } }, "HomeDirectoryType": { @@ -862,7 +866,7 @@ "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using AWS Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.

\n\n

\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n

\n \n

In that command, replace YourGroupName with the name of your Active Directory group.

\n\n

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-

" + "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.

\n\n

\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n

\n \n

In that command, replace YourGroupName with the name of your Active Directory group.

\n\n

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-

" } } }, @@ -928,7 +932,13 @@ "Certificate": { "target": "com.amazonaws.transfer#Certificate", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when\n Protocols is set to FTPS.

" + "smithy.api#documentation": "

Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when\n Protocols is set to FTPS.

" + } + }, + "ProtocolDetails": { + "target": "com.amazonaws.transfer#ProtocolDetails", + "traits": { + "smithy.api#documentation": "

\n The protocol settings that are configured for your server.\n

\n

\n Use the PassiveIp parameter to indicate passive mode.\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n

" } }, "Domain": { @@ -940,7 +950,7 @@ "EndpointDetails": { "target": "com.amazonaws.transfer#EndpointDetails", "traits": { - "smithy.api#documentation": "

Specifies the virtual private cloud (VPC) endpoint settings that you configured for your\n server.

" + "smithy.api#documentation": "

The virtual private cloud (VPC) endpoint settings that are configured for your server.\n When you host your endpoint within your VPC, you can make it accessible only to resources\n within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over\n the internet. Your VPC's default security groups are automatically assigned to your\n endpoint.

" } }, "EndpointType": { @@ -964,13 +974,13 @@ "IdentityProviderType": { "target": "com.amazonaws.transfer#IdentityProviderType", "traits": { - "smithy.api#documentation": "

Specifies the mode of authentication method enabled for this service. A value of\n AWS_DIRECTORY_SERVICE means that you are providing access to Active Directory\n groups in AWS Managed Active Directory or Microsoft Active Directory in your on-premises\n environment or in AWS using AD Connectors. A value of SERVICE_MANAGED means that\n you are using this server to store and access user credentials within the service. A value of\n API_GATEWAY indicates that you have integrated an API Gateway endpoint that\n will be invoked for authenticating your user into the service.

" + "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.

" } }, "LoggingRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in\n your CloudWatch logs.

" + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in\n your CloudWatch logs.

" } }, "Protocols": { @@ -1033,7 +1043,7 @@ "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Specifies the logical directory mappings that specify what Amazon S3 or EFS paths and keys should\n be visible to your user and how you want to make them visible. You will need to specify the\n \"Entry\" and \"Target\" pair, where Entry shows how the\n path is made visible and Target is the actual Amazon S3 or EFS path. If you only specify\n a target, it will be displayed as is. You will need to also make sure that your AWS Identity\n and Access Management (IAM) role provides access to paths in Target.

\n\n

In most cases, you can use this value instead of the scope-down policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set\n Entry to '/' and set Target to the HomeDirectory\n parameter value.

" + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n\n

In most cases, you can use this value instead of the scope-down policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set\n Entry to '/' and set Target to the HomeDirectory\n parameter value.

" } }, "HomeDirectoryType": { @@ -1126,7 +1136,7 @@ "VpcEndpointId": { "target": "com.amazonaws.transfer#VpcEndpointId", "traits": { - "smithy.api#documentation": "

The ID of the VPC endpoint.

\n\n \n

This property can only be set when EndpointType is set to\n VPC_ENDPOINT.

\n \n

For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

\n " + "smithy.api#documentation": "

The ID of the VPC endpoint.

\n\n \n

This property can only be set when EndpointType is set to\n VPC_ENDPOINT.

\n \n

For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

\n " } }, "VpcId": { @@ -1143,7 +1153,7 @@ } }, "traits": { - "smithy.api#documentation": "

The virtual private cloud (VPC) endpoint settings that are configured for your file\n transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server\n and resources only within your VPC. To control incoming internet traffic, invoke the\n UpdateServer API and attach an Elastic IP address to your server's\n endpoint.

\n \n

After May 19, 2021, you won't be able to create a server using\n EndpointType=VPC_ENDPOINT in your AWS account if your account hasn't already\n done so before May 19, 2021. If you have already created servers with\n EndpointType=VPC_ENDPOINT in your AWS account on or before May 19, 2021,\n you will not be affected. After this date, use\n EndpointType=VPC.

\n \n

For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

\n " + "smithy.api#documentation": "

The virtual private cloud (VPC) endpoint settings that are configured for your file\n transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server\n and resources only within your VPC. To control incoming internet traffic, invoke the\n UpdateServer API and attach an Elastic IP address to your server's\n endpoint.

\n \n

After May 19, 2021, you won't be able to create a server using\n EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already\n done so before May 19, 2021. If you have already created servers with\n EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021,\n you will not be affected. After this date, use\n EndpointType=VPC.

\n \n

For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

\n " } }, "com.amazonaws.transfer#EndpointType": { @@ -1197,7 +1207,7 @@ "Entry": { "target": "com.amazonaws.transfer#MapEntry", "traits": { - "smithy.api#documentation": "

Represents an entry and a target for HomeDirectoryMappings.

", + "smithy.api#documentation": "

Represents an entry for HomeDirectoryMappings.

", "smithy.api#required": {} } }, @@ -1210,7 +1220,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents an object that contains entries and targets for\n HomeDirectoryMappings.

" + "smithy.api#documentation": "

Represents an object that contains entries and targets for\n HomeDirectoryMappings.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n \n \n

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is\n ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place\n holders for your directory. If using the CLI, use the s3api or efsapi call instead of\n s3 or efs so you can use the put-object operation. For example, you use the\n following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make\n sure that the end of the key name ends in a / for it to be considered a folder.

\n " } }, "com.amazonaws.transfer#HomeDirectoryMappings": { @@ -1271,7 +1281,7 @@ "DirectoryId": { "target": "com.amazonaws.transfer#DirectoryId", "traits": { - "smithy.api#documentation": "

The identifier of the AWS Directory Service directory that you want to stop sharing.

" + "smithy.api#documentation": "

The identifier of the Amazon Web ServicesDirectory Service directory that you want to stop sharing.

" } } }, @@ -1397,7 +1407,7 @@ } }, "traits": { - "smithy.api#documentation": "

This exception is thrown when an error occurs in the AWS Transfer Family service.

", + "smithy.api#documentation": "

This exception is thrown when an error occurs in the Amazon Web ServicesTransfer Family service.

", "smithy.api#error": "server", "smithy.api#httpError": 503 } @@ -1606,7 +1616,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the file transfer protocol-enabled servers that are associated with your AWS\n account.

", + "smithy.api#documentation": "

Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services\n account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1686,7 +1696,7 @@ "Arn": { "target": "com.amazonaws.transfer#Arn", "traits": { - "smithy.api#documentation": "

Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an\n identifier for a specific AWS resource, such as a server, user, or role.

", + "smithy.api#documentation": "

Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an\n identifier for a specific Amazon Web Services resource, such as a server, user, or role.

", "smithy.api#required": {} } }, @@ -1834,7 +1844,7 @@ "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using AWS Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.

\n\n

\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n

\n \n

In that command, replace YourGroupName with the name of your Active Directory group.

\n\n

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-

" + "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.

\n\n

\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n

\n \n

In that command, replace YourGroupName with the name of your Active Directory group.

\n\n

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-

" } } }, @@ -1867,19 +1877,19 @@ "IdentityProviderType": { "target": "com.amazonaws.transfer#IdentityProviderType", "traits": { - "smithy.api#documentation": "

Specifies the authentication method used to validate a user for a server that was\n specified. This can include Secure Shell (SSH), Active Directory groups, user name and\n password combinations, or your own custom authentication method.

" + "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.

" } }, "EndpointType": { "target": "com.amazonaws.transfer#EndpointType", "traits": { - "smithy.api#documentation": "

Specifies the type of VPC endpoint that your server is connected to. If your server is\n connected to a VPC endpoint, your server isn't accessible over the public\n internet.

" + "smithy.api#documentation": "

Specifies the type of VPC endpoint that your server is connected to. If your server is\n connected to a VPC endpoint, your server isn't accessible over the public internet.

" } }, "LoggingRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "

Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging.

" + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in\n your CloudWatch logs.

" } }, "ServerId": { @@ -2014,6 +2024,15 @@ "smithy.api#pattern": "^$|arn:.*role/" } }, + "com.amazonaws.transfer#PassiveIp": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + } + } + }, "com.amazonaws.transfer#Policy": { "type": "string", "traits": { @@ -2080,6 +2099,20 @@ ] } }, + "com.amazonaws.transfer#ProtocolDetails": { + "type": "structure", + "members": { + "PassiveIp": { + "target": "com.amazonaws.transfer#PassiveIp", + "traits": { + "smithy.api#documentation": "

\n Indicates passive mode, for FTP and FTPS protocols.\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n For example:\n

\n

\n \n aws transfer update-server --protocol-details PassiveIp=0.0.0.0\n \n

\n

Replace \n 0.0.0.0\n in the example above with the actual IP address you want to use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The protocol settings that are configured for your server.\n

\n \n

\n This type is only valid in the UpdateServer API.\n

\n " + } + }, "com.amazonaws.transfer#Protocols": { "type": "list", "member": { @@ -2146,7 +2179,7 @@ } }, "traits": { - "smithy.api#documentation": "

This exception is thrown when a resource is not found by the AWS Transfer Family\n service.

", + "smithy.api#documentation": "

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family\n service.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -2250,7 +2283,11 @@ } }, "traits": { - "smithy.api#documentation": "

The request has failed because the AWS Transfer Family service is not available.

", + "aws.protocols#awsQueryError": { + "code": "ServiceUnavailable", + "httpResponseCode": 503 + }, + "smithy.api#documentation": "

The request has failed because the Amazon Web ServicesTransfer Family service is not available.

", "smithy.api#error": "server", "smithy.api#httpError": 503 } @@ -2524,7 +2561,7 @@ "Arn": { "target": "com.amazonaws.transfer#Arn", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) for a specific AWS resource, such as a server, user, or\n role.

", + "smithy.api#documentation": "

An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or\n role.

", "smithy.api#required": {} } }, @@ -2760,7 +2797,7 @@ "name": "transfer" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

AWS 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). AWS helps you seamlessly migrate your file transfer workflows to AWS 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 AWS services for processing, analytics, machine learning,\n and archiving. Getting started with AWS Transfer Family is easy since there is no\n infrastructure to buy and set up.

", + "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" } }, @@ -2793,7 +2830,7 @@ "Arn": { "target": "com.amazonaws.transfer#Arn", "traits": { - "smithy.api#documentation": "

The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is\n an identifier for a specific AWS resource, such as a server, user, or role.

", + "smithy.api#documentation": "

The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is\n an identifier for a specific Amazon Web Services resource, such as a server, user, or role.

", "smithy.api#required": {} } }, @@ -2853,13 +2890,13 @@ "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it will be displayed as is. You also must ensure that your AWS Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]\n

\n

In most cases, you can use this value instead of the scope-down policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n \n

If the target of a logical directory entry does not exist in Amazon S3 or Amazon EFS, the\n entry will be ignored. As a workaround, you can use the Amazon S3 API or EFS API to create\n 0-byte objects as place holders for your directory. If using the AWS CLI, use the\n s3api or efsapi call instead of s3 or\n efs so you can use the put-object operation. For example, you\n can use the following.

\n

\n aws s3api put-object --bucket bucketname --key path/to/folder/\n

\n

The end of the key name must end in a / for it to be considered a\n folder.

\n " + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]\n

\n

In most cases, you can use this value instead of the scope-down policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n \n \n

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is\n ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place\n holders for your directory. If using the CLI, use the s3api or efsapi call instead of\n s3 or efs so you can use the put-object operation. For example, you use the\n following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make\n sure that the end of the key name ends in a / for it to be considered a folder.

\n " } }, "Policy": { "target": "com.amazonaws.transfer#Policy", "traits": { - "smithy.api#documentation": "

A scope-down policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

\n \n \n

This only applies when domain of ServerId is S3. Amazon EFS does not use scope\n down policy.

\n

For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

\n

For an example of a scope-down policy, see Example\n scope-down policy.

\n

For more information, see AssumeRole in the AWS Security Token Service API\n Reference.

\n " + "smithy.api#documentation": "

A scope-down policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

\n \n \n

This only applies when domain of ServerId is S3. Amazon EFS does not use scope\n down policy.

\n

For scope-down policies, Amazon Web ServicesTransfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

\n

For an example of a scope-down policy, see Example\n scope-down policy.

\n

For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API\n Reference.

\n " } }, "PosixProfile": { @@ -2881,7 +2918,7 @@ "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using AWS Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.

\n\n

\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n

\n \n

In that command, replace YourGroupName with the name of your Active Directory group.

\n\n

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-

", + "smithy.api#documentation": "

A unique identifier that is required to identify specific groups within your directory.\n The users of the group that you associate have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name,\n you can view the SID values by running the following command using Windows PowerShell.

\n\n

\n Get-ADGroup -Filter {samAccountName -like \"YourGroupName*\"} -Properties * | Select SamAccountName,ObjectSid\n

\n \n

In that command, replace YourGroupName with the name of your Active Directory group.

\n\n

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces.\n You can also include underscores or any of the following characters: =,.@:/-

", "smithy.api#required": {} } } @@ -2900,7 +2937,7 @@ "ExternalId": { "target": "com.amazonaws.transfer#ExternalId", "traits": { - "smithy.api#documentation": "

The external ID of the group whose users have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using AWS Transfer Family.

", + "smithy.api#documentation": "

The external ID of the group whose users have access to your Amazon S3 or Amazon EFS\n resources over the enabled protocols using Amazon Web ServicesTransfer Family.

", "smithy.api#required": {} } } @@ -2950,25 +2987,31 @@ "Certificate": { "target": "com.amazonaws.transfer#Certificate", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required\n when Protocols is set to FTPS.

\n\n

To request a new public certificate, see Request a public certificate\n in the AWS Certificate Manager User Guide.

\n\n

To import an existing certificate into ACM, see Importing certificates into ACM\n in the AWS Certificate Manager User Guide.

\n\n

To request a private certificate to use FTPS through private IP addresses, see Request a\n private certificate in the AWS Certificate Manager User\n Guide.

\n\n

Certificates with the following cryptographic algorithms and key sizes are\n supported:

\n\n \n\n \n

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP\n address specified and information about the issuer.

\n " + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required\n when Protocols is set to FTPS.

\n\n

To request a new public certificate, see Request a public certificate\n in the Amazon Web ServicesCertificate Manager User Guide.

\n\n

To import an existing certificate into ACM, see Importing certificates into ACM\n in the Amazon Web ServicesCertificate Manager User Guide.

\n\n

To request a private certificate to use FTPS through private IP addresses, see Request a\n private certificate in the Amazon Web ServicesCertificate Manager User\n Guide.

\n\n

Certificates with the following cryptographic algorithms and key sizes are\n supported:

\n\n \n\n \n

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP\n address specified and information about the issuer.

\n " + } + }, + "ProtocolDetails": { + "target": "com.amazonaws.transfer#ProtocolDetails", + "traits": { + "smithy.api#documentation": "

\n The protocol settings that are configured for your server.\n

\n

\n Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols).\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n

" } }, "EndpointDetails": { "target": "com.amazonaws.transfer#EndpointDetails", "traits": { - "smithy.api#documentation": "

The virtual private cloud (VPC) endpoint settings that are configured for your server.\n With a VPC endpoint, you can restrict access to your server to resources only within your VPC.\n To control incoming internet traffic, you will need to associate one or more Elastic IP\n addresses with your server's endpoint.

" + "smithy.api#documentation": "

The virtual private cloud (VPC) endpoint settings that are configured for your server.\n When you host your endpoint within your VPC, you can make it accessible only to resources\n within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over\n the internet. Your VPC's default security groups are automatically assigned to your\n endpoint.

" } }, "EndpointType": { "target": "com.amazonaws.transfer#EndpointType", "traits": { - "smithy.api#documentation": "

The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)\n or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and \n resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

\n \n

After May 19, 2021, you won't be able to create a server using\n EndpointType=VPC_ENDPOINT in your AWS account if your account hasn't already\n done so before May 19, 2021. If you have already created servers with\n EndpointType=VPC_ENDPOINT in your AWS account on or before May 19, 2021,\n you will not be affected. After this date, use\n EndpointType=VPC.

\n \n

For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

\n

It is recommended that you use VPC as the EndpointType. With\n this endpoint type, you have the option to directly associate up to three Elastic IPv4\n addresses (BYO IP included) with your server's endpoint and use VPC security groups to\n restrict traffic by the client's public IP address. This is not possible with\n EndpointType set to VPC_ENDPOINT.

\n " + "smithy.api#documentation": "

The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)\n or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and \n resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

\n \n

After May 19, 2021, you won't be able to create a server using\n EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already\n done so before May 19, 2021. If you have already created servers with\n EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021,\n you will not be affected. After this date, use\n EndpointType=VPC.

\n \n

For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

\n

It is recommended that you use VPC as the EndpointType. With\n this endpoint type, you have the option to directly associate up to three Elastic IPv4\n addresses (BYO IP included) with your server's endpoint and use VPC security groups to\n restrict traffic by the client's public IP address. This is not possible with\n EndpointType set to VPC_ENDPOINT.

\n " } }, "HostKey": { "target": "com.amazonaws.transfer#HostKey", "traits": { - "smithy.api#documentation": "

The RSA private key as generated by ssh-keygen -N \"\" -m PEM -f\n my-new-server-key.

\n\n \n

If you aren't planning to migrate existing users from an existing server to a new\n server, don't update the host key. Accidentally changing a server's host key can\n be disruptive.

\n \n\n \n\n

For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer\n Family User Guide.

" + "smithy.api#documentation": "

The RSA private key as generated by ssh-keygen -N \"\" -m PEM -f\n my-new-server-key.

\n\n \n

If you aren't planning to migrate existing users from an existing server to a new\n server, don't update the host key. Accidentally changing a server's host key can\n be disruptive.

\n \n\n \n\n

For more information, see Change the host key for your SFTP-enabled server in the Amazon Web ServicesTransfer\n Family User Guide.

" } }, "IdentityProviderDetails": { @@ -2980,13 +3023,13 @@ "LoggingRole": { "target": "com.amazonaws.transfer#NullableRole", "traits": { - "smithy.api#documentation": "

Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 or Amazon EFS events to\n be logged in Amazon CloudWatch, turning logging on or off.

" + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn\n on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in\n your CloudWatch logs.

" } }, "Protocols": { "target": "com.amazonaws.transfer#Protocols", "traits": { - "smithy.api#documentation": "

Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:

\n\n \n\n \n

If you select FTPS, you must choose a certificate stored in AWS Certificate\n Manager (ACM) which will be used to identify your server when clients connect to it over\n FTPS.

\n\n \n

If Protocol includes either FTP or FTPS, then the\n EndpointType must be VPC and the\n IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.

\n\n

If Protocol includes FTP, then\n AddressAllocationIds cannot be associated.

\n\n

If Protocol is set only to SFTP, the EndpointType\n can be set to PUBLIC and the IdentityProviderType can be set to\n SERVICE_MANAGED.

\n " + "smithy.api#documentation": "

Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:

\n\n \n\n \n

If you select FTPS, you must choose a certificate stored in Amazon Web ServicesCertificate\n Manager (ACM) which will be used to identify your server when clients connect to it over\n FTPS.

\n\n \n

If Protocol includes either FTP or FTPS, then the\n EndpointType must be VPC and the\n IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.

\n\n

If Protocol includes FTP, then\n AddressAllocationIds cannot be associated.

\n\n

If Protocol is set only to SFTP, the EndpointType\n can be set to PUBLIC and the IdentityProviderType can be set to\n SERVICE_MANAGED.

\n " } }, "SecurityPolicyName": { @@ -3063,13 +3106,13 @@ "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to\n your user and how you want to make them visible. You will need to specify the\n \"Entry\" and \"Target\" pair, where Entry shows how the\n path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify\n a target, it will be displayed as is. You will need to also make sure that your IAM role\n provides access to paths in Target. The following is an example.

\n\n

\n '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\":\n \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'\n

\n\n

In most cases, you can use this value instead of the scope-down policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to '/' and set Target to the HomeDirectory\n parameter value.

\n\n \n

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry\n will be ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0-byte\n objects as place holders for your directory. If using the AWS CLI, use the\n s3api or efsapi call instead of s3\n efs so you can use the put-object operation. For example, you use the\n following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make\n sure that the end of the key name ends in a / for it to be considered a folder.

\n " + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"your-personal-report.pdf\", \"Target\":\n \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]\n

\n\n

In most cases, you can use this value instead of the scope-down policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to '/' and set Target to the HomeDirectory\n parameter value.

\n\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n \n \n

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is\n ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place\n holders for your directory. If using the CLI, use the s3api or efsapi call instead of\n s3 or efs so you can use the put-object operation. For example, you use the\n following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make\n sure that the end of the key name ends in a / for it to be considered a folder.

\n " } }, "Policy": { "target": "com.amazonaws.transfer#Policy", "traits": { - "smithy.api#documentation": "

A scope-down policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

\n \n \n

This only applies when domain of ServerId is S3.\n Amazon EFS does not use scope-down policies.

\n \n

For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy.\n You save the policy as a JSON blob and pass it in the Policy argument.

\n \n \n\n

For an example of a scope-down policy, see Creating a scope-down\n policy.

\n\n \n\n

For more information, see AssumeRole in the AWS\n Security Token Service API Reference.

\n " + "smithy.api#documentation": "

A scope-down policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user\n access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName},\n ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

\n \n \n

This only applies when domain of ServerId is S3.\n Amazon EFS does not use scope-down policies.

\n \n

For scope-down policies, Amazon Web ServicesTransfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy.\n You save the policy as a JSON blob and pass it in the Policy argument.

\n \n \n\n

For an example of a scope-down policy, see Creating a scope-down\n policy.

\n\n \n\n

For more information, see AssumeRole in the Amazon Web Services\n Security Token Service API Reference.

\n " } }, "PosixProfile": { diff --git a/aws/sdk/aws-models/wafv2.json b/aws/sdk/aws-models/wafv2.json index 091c14c60..698407b28 100644 --- a/aws/sdk/aws-models/wafv2.json +++ b/aws/sdk/aws-models/wafv2.json @@ -166,7 +166,7 @@ "name": "wafv2" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "\n

This is the latest version of the AWS WAF API, released in\n November, 2019. The names of the entities that you use to access this API, like\n endpoints and namespaces, all have the versioning information added, like \"V2\" or \"v2\",\n to distinguish from the prior version. We recommend migrating your resources to this\n version, because it has a number of significant improvements.

\n

If you used AWS WAF prior to this release, you can't use this AWS WAFV2 API to access\n any AWS WAF resources that you created before. You can access your old rules, web ACLs,\n and other AWS WAF resources only through the AWS WAF Classic APIs. The AWS WAF Classic\n APIs have retained the prior names, endpoints, and namespaces.

\n

For information, including how to migrate your AWS WAF resources to this version, see the AWS WAF\n Developer Guide.

\n \n

AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests\n that are forwarded to Amazon CloudFront, an Amazon API Gateway REST API, an Application Load\n Balancer, or an AWS AppSync GraphQL API. AWS 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 API Gateway REST API, CloudFront distribution, the Application Load Balancer, \n or the AWS AppSync GraphQL API responds to requests\n either with the requested content or with an HTTP 403 status code (Forbidden). You also can\n configure CloudFront to return a custom error page when a request is blocked.

\n

This API guide is for developers who need detailed information about AWS WAF API\n actions, data types, and errors. For detailed information about AWS WAF features and an\n overview of how to use AWS WAF, see the AWS WAF Developer Guide.

\n

You can make calls using the endpoints listed in AWS Service Endpoints for AWS WAF.

\n \n

Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the\n programming language or platform that you're using. For more information, see AWS SDKs.

\n

We currently provide two versions of the AWS WAF API: this API and the prior versions,\n the classic AWS WAF APIs. This new API provides the same functionality as the older\n versions, with the following major improvements:

\n ", + "smithy.api#documentation": "WAF\n \n

This is the latest version of the WAF API, released in\n November, 2019. The names of the entities that you use to access this API, like\n endpoints and namespaces, all have the versioning information added, like \"V2\" or \"v2\",\n to distinguish from the prior version. We recommend migrating your resources to this\n 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\n any WAF resources that you created before. You can access your old rules, web ACLs,\n and other WAF resources only through the WAF Classic APIs. The WAF Classic\n APIs have retained the prior names, endpoints, and namespaces.

\n

For information, including how to migrate your WAF resources to this version, see the WAF\n Developer Guide.

\n \n

WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests\n that are forwarded to Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync 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, \n or the AppSync GraphQL API responds to requests\n either with the requested content or with an HTTP 403 status code (Forbidden). You also can\n configure CloudFront to return a custom error page when a request is blocked.

\n

This API guide is for developers who need detailed information about WAF API\n actions, data types, and errors. For detailed information about WAF features and an\n overview of how to use WAF, see the WAF Developer Guide.

\n

You can make calls using the endpoints listed in Amazon Web Services Service Endpoints for WAF.

\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\n versions, with the following major improvements:

\n ", "smithy.api#title": "AWS WAFV2", "smithy.api#xmlNamespace": { "uri": "http://waf.amazonaws.com/doc/2019-07-29/" @@ -214,14 +214,14 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Inspect all of the elements that AWS WAF has parsed and extracted from the web request JSON body that are within the JsonBody \n MatchScope. This is used with the FieldToMatch option JsonBody.

\n

This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

" + "smithy.api#documentation": "

Inspect all of the elements that WAF has parsed and extracted from the web request JSON body that are within the JsonBody \n MatchScope. This is used with the FieldToMatch option JsonBody.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" } }, "com.amazonaws.wafv2#AllQueryArguments": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

All query arguments of a web request.

\n

This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

" + "smithy.api#documentation": "

All query arguments of a web request.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" } }, "com.amazonaws.wafv2#AllowAction": { @@ -230,12 +230,12 @@ "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 AWS WAF in the \n AWS WAF Developer Guide.

" + "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 AWS WAF should allow the request and optionally defines additional custom handling for the request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" + "smithy.api#documentation": "

Specifies that WAF should allow the request and optionally defines additional custom handling for the request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" } }, "com.amazonaws.wafv2#AndStatement": { @@ -279,7 +279,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a Web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

\n

For AWS CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a Web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the Web ACL. For information, see UpdateDistribution.

" + "smithy.api#documentation": "

Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

\n

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution.

" } }, "com.amazonaws.wafv2#AssociateWebACLRequest": { @@ -288,14 +288,14 @@ "WebACLArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Web ACL that you want to associate with the resource.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

", "smithy.api#required": {} } }, "ResourceArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to associate with the web ACL.

\n \n

The ARN must be in one of the following formats:

\n ", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to associate with the web ACL.

\n \n

The ARN must be in one of the following formats:

\n ", "smithy.api#required": {} } } @@ -311,19 +311,19 @@ "CustomResponse": { "target": "com.amazonaws.wafv2#CustomResponse", "traits": { - "smithy.api#documentation": "

Defines a custom response for the web request.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the \n AWS WAF Developer Guide.

" + "smithy.api#documentation": "

Defines a custom response 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 AWS WAF should block the request and optionally defines additional custom handling for the response to the web request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" + "smithy.api#documentation": "

Specifies that WAF should block the request and optionally defines additional custom handling for the response to the web request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" } }, "com.amazonaws.wafv2#Body": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

The body of a web request. This immediately follows the request headers.

\n

This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

" + "smithy.api#documentation": "

The body of a web request. This immediately follows the request headers.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" } }, "com.amazonaws.wafv2#BodyParsingFallbackBehavior": { @@ -354,34 +354,34 @@ "SearchString": { "target": "com.amazonaws.wafv2#SearchString", "traits": { - "smithy.api#documentation": "

A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 50 bytes.

\n

Valid values depend on the component that you specify for inspection in FieldToMatch:

\t\t\n \n \n

If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

\n

\n If you're using the AWS WAF API\n

\n

Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

\n

For example, suppose the value of Type is HEADER and the\n value of Data is User-Agent. If you want to search the\n User-Agent header for the value BadBot, you base64-encode\n BadBot using MIME\n base64-encoding\n and include the resulting value, QmFkQm90, in the value of\n SearchString.

\n

\n If you're using the AWS CLI or one of the AWS SDKs\n

\n

The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.

", + "smithy.api#documentation": "

A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 50 bytes.

\n

Valid values depend on the component that you specify for inspection in FieldToMatch:

\t\t\n \n \n

If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

\n

\n If you're using the WAF API\n

\n

Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

\n

For example, suppose the value of Type is HEADER and the\n value of Data is User-Agent. If you want to search the\n User-Agent header for the value BadBot, you base64-encode\n BadBot using MIME\n base64-encoding\n and include the resulting value, QmFkQm90, in the value of\n SearchString.

\n

\n If you're using the CLI or one of the Amazon Web Services SDKs\n

\n

The value that you want WAF to search for. The SDK automatically base64 encodes the value.

", "smithy.api#required": {} } }, "FieldToMatch": { "target": "com.amazonaws.wafv2#FieldToMatch", "traits": { - "smithy.api#documentation": "

The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

", + "smithy.api#documentation": "

The part of a web request that you want WAF to inspect. For more information, see FieldToMatch.

", "smithy.api#required": {} } }, "TextTransformations": { "target": "com.amazonaws.wafv2#TextTransformations", "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

", + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

", "smithy.api#required": {} } }, "PositionalConstraint": { "target": "com.amazonaws.wafv2#PositionalConstraint", "traits": { - "smithy.api#documentation": "

The area within the portion of a web request that you want AWS WAF to search for SearchString. Valid values include the following:

\n

\n CONTAINS\n

\n

The specified part of the web request must include the value of SearchString, but the location doesn't matter.

\t\t\n

\n CONTAINS_WORD\n

\n

The specified part of the web request must include the value of SearchString, and \n SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, \n SearchString must be a word, which means that both of the following are true:

\n \n

\n EXACTLY\n

\n

The value of the specified part of the web request must exactly match the value of SearchString.

\n

\n STARTS_WITH\n

\n

The value of SearchString must appear at the beginning of the specified part of the web request.

\t\t\n

\n ENDS_WITH\n

\n

The value of SearchString must appear at the end of the specified part of the web request.

", + "smithy.api#documentation": "

The area within the portion of a web request that you want WAF to search for SearchString. Valid values include the following:

\n

\n CONTAINS\n

\n

The specified part of the web request must include the value of SearchString, but the location doesn't matter.

\t\t\n

\n CONTAINS_WORD\n

\n

The specified part of the web request must include the value of SearchString, and \n SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, \n SearchString must be a word, which means that both of the following are true:

\n \n

\n EXACTLY\n

\n

The value of the specified part of the web request must exactly match the value of SearchString.

\n

\n STARTS_WITH\n

\n

The value of SearchString must appear at the beginning of the specified part of the web request.

\t\t\n

\n ENDS_WITH\n

\n

The value of SearchString must appear at the end of the specified part of the web request.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.

" + "smithy.api#documentation": "

A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is refered to as a string match statement.

" } }, "com.amazonaws.wafv2#CapacityUnit": { @@ -424,7 +424,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. \n You can use this to check the capacity requirements for the rules you want to use in a \n RuleGroup or WebACL. \n

\n

AWS WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. AWS WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

" + "smithy.api#documentation": "

Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. \n You can use this to check the capacity requirements for the rules you want to use in a \n RuleGroup or WebACL. \n

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

" } }, "com.amazonaws.wafv2#CheckCapacityRequest": { @@ -433,7 +433,7 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } }, @@ -533,12 +533,12 @@ "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 AWS WAF in the \n AWS WAF Developer Guide.

" + "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 AWS WAF should count the request. Optionally defines additional custom handling for the request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" + "smithy.api#documentation": "

Specifies that WAF should count the request. Optionally defines additional custom handling for the request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" } }, "com.amazonaws.wafv2#Country": { @@ -1593,7 +1593,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure AWS WAF to block them using an IPSet that lists those IP addresses.

" + "smithy.api#documentation": "

Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.

" } }, "com.amazonaws.wafv2#CreateIPSetRequest": { @@ -1609,7 +1609,7 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } }, @@ -1629,7 +1629,7 @@ "Addresses": { "target": "com.amazonaws.wafv2#IPAddresses", "traits": { - "smithy.api#documentation": "

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Examples:

\n \n

For more information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

", + "smithy.api#documentation": "

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Examples:

\n \n

For more information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

", "smithy.api#required": {} } }, @@ -1687,7 +1687,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have AWS WAF inspect a web request component for the specified patterns.

" + "smithy.api#documentation": "

Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.

" } }, "com.amazonaws.wafv2#CreateRegexPatternSetRequest": { @@ -1703,7 +1703,7 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } }, @@ -1799,14 +1799,14 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } }, "Capacity": { "target": "com.amazonaws.wafv2#CapacityUnit", "traits": { - "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

When you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.

\n

AWS WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. AWS WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

", + "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

When you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

", "smithy.api#required": {} } }, @@ -1819,7 +1819,7 @@ "Rules": { "target": "com.amazonaws.wafv2#Rules", "traits": { - "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching \n web requests, and parameters that govern how AWS WAF handles them. \n

" + "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" } }, "VisibilityConfig": { @@ -1838,7 +1838,7 @@ "CustomResponseBodies": { "target": "com.amazonaws.wafv2#CustomResponseBodies", "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 rule group, and then use them in the rules that you define in the rule group.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the \n AWS WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the \n AWS WAF Developer Guide.

" + "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 rule group, and then use them in the rules that you define in the rule group.

\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.

" } } } @@ -1901,7 +1901,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a WebACL per the specifications provided.

\n

A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync GraphQL API.

" + "smithy.api#documentation": "

Creates a WebACL per the specifications provided.

\n

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API.

" } }, "com.amazonaws.wafv2#CreateWebACLRequest": { @@ -1910,14 +1910,14 @@ "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

", + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", "smithy.api#required": {} } }, "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } }, @@ -1931,13 +1931,13 @@ "Description": { "target": "com.amazonaws.wafv2#EntityDescription", "traits": { - "smithy.api#documentation": "

A description of the Web ACL that helps with identification.

" + "smithy.api#documentation": "

A description of the web ACL that helps with identification.

" } }, "Rules": { "target": "com.amazonaws.wafv2#Rules", "traits": { - "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching \n web requests, and parameters that govern how AWS WAF handles them. \n

" + "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" } }, "VisibilityConfig": { @@ -1956,7 +1956,7 @@ "CustomResponseBodies": { "target": "com.amazonaws.wafv2#CustomResponseBodies", "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 AWS WAF in the \n AWS WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the \n AWS WAF Developer Guide.

" + "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.

" } } } @@ -1978,7 +1978,7 @@ "Name": { "target": "com.amazonaws.wafv2#CustomHTTPHeaderName", "traits": { - "smithy.api#documentation": "

The name of the custom header.

\n

For custom request header insertion, when AWS WAF inserts the header into the request, it prefixes this name x-amzn-waf-, to avoid confusion with the headers that are already in the request. For example, for the header name sample, AWS WAF inserts the header x-amzn-waf-sample.

", + "smithy.api#documentation": "

The name of the custom header.

\n

For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf-, to avoid confusion with the headers that are already in the request. For example, for the header name sample, WAF inserts the header x-amzn-waf-sample.

", "smithy.api#required": {} } }, @@ -2031,13 +2031,13 @@ "InsertHeaders": { "target": "com.amazonaws.wafv2#CustomHTTPHeaders", "traits": { - "smithy.api#documentation": "

The HTTP headers to insert into the request. Duplicate header names are not allowed.

\n

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the \n AWS WAF Developer Guide.

", + "smithy.api#documentation": "

The HTTP headers to insert into the request. Duplicate header names are not allowed.

\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.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Custom request handling behavior that inserts custom headers into a web request. You can add custom request handling for the rule actions allow and count.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the \n AWS WAF Developer Guide.

" + "smithy.api#documentation": "

Custom request handling behavior that inserts custom headers into a web request. You can add custom request handling for the rule actions allow and count.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

" } }, "com.amazonaws.wafv2#CustomResponse": { @@ -2046,25 +2046,25 @@ "ResponseCode": { "target": "com.amazonaws.wafv2#ResponseStatusCode", "traits": { - "smithy.api#documentation": "

The HTTP status code to return to the client.

\n

For a list of status codes that you can use in your custom reqponses, see Supported status codes for custom response in the \n AWS WAF Developer Guide.

", + "smithy.api#documentation": "

The HTTP status code to return to the client.

\n

For a list of status codes that you can use in your custom reqponses, see Supported status codes for custom response in the \n WAF Developer Guide.

", "smithy.api#required": {} } }, "CustomResponseBodyKey": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

References the response body that you want AWS WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first \n define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference\n the response body using this key.

" + "smithy.api#documentation": "

References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first \n define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference\n the response body using this key.

" } }, "ResponseHeaders": { "target": "com.amazonaws.wafv2#CustomHTTPHeaders", "traits": { - "smithy.api#documentation": "

The HTTP headers to use in the response. Duplicate header names are not allowed.

\n

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the \n AWS WAF Developer Guide.

" + "smithy.api#documentation": "

The HTTP headers to use in the response. Duplicate header names are not allowed.

\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.

" } } }, "traits": { - "smithy.api#documentation": "

A custom response to send to the client. You can define a custom response for rule actions and default web ACL actions that are set to BlockAction.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the \n AWS WAF Developer Guide.

" + "smithy.api#documentation": "

A custom response to send to the client. You can define a custom response for rule actions and default web ACL actions that are set to BlockAction.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

" } }, "com.amazonaws.wafv2#CustomResponseBodies": { @@ -2094,7 +2094,7 @@ "Content": { "target": "com.amazonaws.wafv2#ResponseContent", "traits": { - "smithy.api#documentation": "

The payload of the custom response.

\n

You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the ContentType setting.

\n

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the \n AWS WAF Developer Guide.

", + "smithy.api#documentation": "

The payload of the custom response.

\n

You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the ContentType setting.

\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.

", "smithy.api#required": {} } } @@ -2109,18 +2109,18 @@ "Block": { "target": "com.amazonaws.wafv2#BlockAction", "traits": { - "smithy.api#documentation": "

Specifies that AWS WAF should block requests by default.

" + "smithy.api#documentation": "

Specifies that WAF should block requests by default.

" } }, "Allow": { "target": "com.amazonaws.wafv2#AllowAction", "traits": { - "smithy.api#documentation": "

Specifies that AWS WAF should allow requests by default.

" + "smithy.api#documentation": "

Specifies that WAF should allow requests by default.

" } } }, "traits": { - "smithy.api#documentation": "

In a WebACL, this is the action that you want AWS WAF \n to perform when a web request doesn't match any of the rules in the WebACL. The default action must be a terminating action, so you can't use count.

" + "smithy.api#documentation": "

In a WebACL, this is the action that you want WAF \n to perform when a web request doesn't match any of the rules in the WebACL. The default action must be a terminating action, so you can't use count.

" } }, "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroups": { @@ -2149,7 +2149,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes all rule groups that are managed by AWS Firewall Manager for the specified web ACL.

\n

You can only use this if ManagedByFirewallManager is false in the specified WebACL.

" + "smithy.api#documentation": "

Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.

\n

You can only use this if ManagedByFirewallManager is false in the specified WebACL.

" } }, "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroupsRequest": { @@ -2165,7 +2165,7 @@ "WebACLLockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", "smithy.api#required": {} } } @@ -2177,7 +2177,7 @@ "NextWebACLLockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } } } @@ -2233,7 +2233,7 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } }, @@ -2247,7 +2247,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", "smithy.api#required": {} } } @@ -2392,7 +2392,7 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } }, @@ -2406,7 +2406,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", "smithy.api#required": {} } } @@ -2467,7 +2467,7 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } }, @@ -2481,7 +2481,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", "smithy.api#required": {} } } @@ -2535,28 +2535,28 @@ "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

", + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", "smithy.api#required": {} } }, "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } }, "Id": { "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", "smithy.api#required": {} } }, "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", "smithy.api#required": {} } } @@ -2615,7 +2615,7 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } } @@ -2627,7 +2627,7 @@ "Capacity": { "target": "com.amazonaws.wafv2#CapacityUnit", "traits": { - "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group. \n AWS WAF uses web ACL capacity units (WCU) to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. AWS WAF\n calculates capacity differently for each rule type, to reflect each rule's relative\n cost. Rule group capacity is fixed at creation, so users can plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

" + "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group. \n WAF uses web ACL capacity units (WCU) to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect each rule's relative\n cost. Rule group capacity is fixed at creation, so users can plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

" } }, "Rules": { @@ -2639,13 +2639,13 @@ "LabelNamespace": { "target": "com.amazonaws.wafv2#LabelName", "traits": { - "smithy.api#documentation": "

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

\n " + "smithy.api#documentation": "

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

\n " } }, "AvailableLabels": { "target": "com.amazonaws.wafv2#LabelSummaries", "traits": { - "smithy.api#documentation": "

The labels that one or more rules in this rule group add to matching web ACLs. These labels are defined in the RuleLabels for a Rule.

" + "smithy.api#documentation": "

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

" } }, "ConsumedLabels": { @@ -2679,7 +2679,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates a Web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

\n

For AWS CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a Web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution.

" + "smithy.api#documentation": "

Disassociates a web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

\n

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution.

" } }, "com.amazonaws.wafv2#DisassociateWebACLRequest": { @@ -2688,7 +2688,7 @@ "ResourceArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.

\n \n

The ARN must be in one of the following formats:

\n ", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.

\n \n

The ARN must be in one of the following formats:

\n ", "smithy.api#required": {} } } @@ -2782,7 +2782,7 @@ "SingleQueryArgument": { "target": "com.amazonaws.wafv2#SingleQueryArgument", "traits": { - "smithy.api#documentation": "

Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

\n

This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

\n

Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n

" + "smithy.api#documentation": "

Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

\n

Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n

" } }, "AllQueryArguments": { @@ -2806,7 +2806,7 @@ "Body": { "target": "com.amazonaws.wafv2#Body", "traits": { - "smithy.api#documentation": "

Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any \n additional data that you want to send to your web server as the HTTP request body, such as data from a form.

\n

Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

" + "smithy.api#documentation": "

Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any \n additional data that you want to send to your web server as the HTTP request body, such as data from a form.

\n

Note that only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

" } }, "Method": { @@ -2818,12 +2818,12 @@ "JsonBody": { "target": "com.amazonaws.wafv2#JsonBody", "traits": { - "smithy.api#documentation": "

Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any \n additional data that you want to send to your web server as the HTTP request body, such as data from a form.

\n

Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

" + "smithy.api#documentation": "

Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any \n additional data that you want to send to your web server as the HTTP request body, such as data from a form.

\n

Note that only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

" } } }, "traits": { - "smithy.api#documentation": "

The part of a web request that you want AWS WAF to inspect. Include the single FieldToMatch type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in FieldToMatch for each rule statement that requires it. To inspect more than one component of a web request, create a separate rule statement for each component.

" + "smithy.api#documentation": "

The part of a web request that you want WAF to inspect. Include the single FieldToMatch type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in FieldToMatch for each rule statement that requires it. To inspect more than one component of a web request, create a separate rule statement for each component.

" } }, "com.amazonaws.wafv2#FieldToMatchData": { @@ -2833,7 +2833,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": ".*\\S.*" + "smithy.api#pattern": "\\S" } }, "com.amazonaws.wafv2#Filter": { @@ -2919,32 +2919,34 @@ "Priority": { "target": "com.amazonaws.wafv2#RulePriority", "traits": { - "smithy.api#documentation": "

If you define more than one rule group in the first or last Firewall Manager rule groups,\n AWS WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. \n The priorities don't need to be consecutive, but they must all be different.

", + "smithy.api#documentation": "

If you define more than one rule group in the first or last Firewall Manager rule groups,\n WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. \n The priorities don't need to be consecutive, but they must all be different.

", "smithy.api#required": {} } }, "FirewallManagerStatement": { "target": "com.amazonaws.wafv2#FirewallManagerStatement", "traits": { - "smithy.api#documentation": "

The processing guidance for an AWS Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

", + "smithy.api#documentation": "

The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

", "smithy.api#required": {} } }, "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#required": {} } }, "VisibilityConfig": { "target": "com.amazonaws.wafv2#VisibilityConfig", "traits": { + "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A rule group that's defined for an AWS Firewall Manager WAF policy.

" + "smithy.api#documentation": "

A rule group that's defined for an Firewall Manager WAF policy.

" } }, "com.amazonaws.wafv2#FirewallManagerRuleGroups": { @@ -2957,14 +2959,20 @@ "type": "structure", "members": { "ManagedRuleGroupStatement": { - "target": "com.amazonaws.wafv2#ManagedRuleGroupStatement" + "target": "com.amazonaws.wafv2#ManagedRuleGroupStatement", + "traits": { + "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

\n

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

" + } }, "RuleGroupReferenceStatement": { - "target": "com.amazonaws.wafv2#RuleGroupReferenceStatement" + "target": "com.amazonaws.wafv2#RuleGroupReferenceStatement", + "traits": { + "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

\n

You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

" + } } }, "traits": { - "smithy.api#documentation": "

The processing guidance for an AWS Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

" + "smithy.api#documentation": "

The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

" } }, "com.amazonaws.wafv2#ForwardedIPConfig": { @@ -2973,20 +2981,20 @@ "HeaderName": { "target": "com.amazonaws.wafv2#ForwardedIPHeaderName", "traits": { - "smithy.api#documentation": "

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

\n \n \n

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

\n ", + "smithy.api#documentation": "

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n ", "smithy.api#required": {} } }, "FallbackBehavior": { "target": "com.amazonaws.wafv2#FallbackBehavior", "traits": { - "smithy.api#documentation": "

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

\n \n \n

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

\n \n \n

You can specify the following fallback behaviors:

\n ", + "smithy.api#documentation": "

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n \n

You can specify the following fallback behaviors:

\n ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

\n \n \n \n

This configuration is used for GeoMatchStatement and RateBasedStatement. \n For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.

\n

AWS WAF only evaluates the first IP address found in the specified HTTP header.

" + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n \n \n

This configuration is used for GeoMatchStatement and RateBasedStatement. \n For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.

\n

WAF only evaluates the first IP address found in the specified HTTP header.

" } }, "com.amazonaws.wafv2#ForwardedIPHeaderName": { @@ -3030,7 +3038,7 @@ "ForwardedIPConfig": { "target": "com.amazonaws.wafv2#ForwardedIPConfig", "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

\n " + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n " } } }, @@ -3077,7 +3085,7 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } }, @@ -3102,7 +3110,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } } } @@ -3234,21 +3242,21 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } }, "WebACLName": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

", + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", "smithy.api#required": {} } }, "WebACLId": { "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", "smithy.api#required": {} } }, @@ -3317,7 +3325,7 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } }, @@ -3342,7 +3350,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } } } @@ -3379,22 +3387,25 @@ "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the rule group. You cannot change the name of a rule group after you create it.

" } }, "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} + "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 " } }, "Id": { "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" } } } @@ -3411,7 +3422,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } } } @@ -3436,7 +3447,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

\n

\n GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource \n (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests \n returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.

" + "smithy.api#documentation": "

Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

\n

\n GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource \n (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests \n returns an updated time range. This new time range indicates the actual period during which WAF selected the requests in the sample.

" } }, "com.amazonaws.wafv2#GetSampledRequestsRequest": { @@ -3459,21 +3470,21 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } }, "TimeWindow": { "target": "com.amazonaws.wafv2#TimeWindow", "traits": { - "smithy.api#documentation": "

The start date and time and the end date and time of the range for which you want GetSampledRequests to return a \n sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, AWS WAF sets it to three hours ago.

", + "smithy.api#documentation": "

The start date and time and the end date and time of the range for which you want GetSampledRequests to return a \n sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago.

", "smithy.api#required": {} } }, "MaxItems": { "target": "com.amazonaws.wafv2#ListMaxItems", "traits": { - "smithy.api#documentation": "

The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received\n during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests \n returns information about all of them.

", + "smithy.api#documentation": "

The number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web Services resource received\n during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests \n returns information about all of them.

", "smithy.api#required": {} } } @@ -3491,13 +3502,13 @@ "PopulationSize": { "target": "com.amazonaws.wafv2#PopulationSize", "traits": { - "smithy.api#documentation": "

The total number of requests from which GetSampledRequests got a sample of MaxItems requests. \n If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource \n received during the specified time range.

" + "smithy.api#documentation": "

The total number of requests from which GetSampledRequests got a sample of MaxItems requests. \n If PopulationSize is less than MaxItems, the sample includes every request that your Amazon Web Services resource \n received during the specified time range.

" } }, "TimeWindow": { "target": "com.amazonaws.wafv2#TimeWindow", "traits": { - "smithy.api#documentation": "

Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. \n However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, \n GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.

" + "smithy.api#documentation": "

Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. \n However, if your Amazon Web Services resource received more than 5,000 requests during the time range that you specified in the request, \n GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.

" } } } @@ -3575,7 +3586,7 @@ "WebACL": { "target": "com.amazonaws.wafv2#WebACL", "traits": { - "smithy.api#documentation": "

The Web ACL that is associated with the resource. If there is no associated resource, AWS WAF returns a null Web ACL.

" + "smithy.api#documentation": "

The web ACL that is associated with the resource. If there is no associated resource, WAF returns a null web ACL.

" } } } @@ -3586,21 +3597,21 @@ "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

", + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", "smithy.api#required": {} } }, "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } }, "Id": { "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", "smithy.api#required": {} } } @@ -3612,13 +3623,13 @@ "WebACL": { "target": "com.amazonaws.wafv2#WebACL", "traits": { - "smithy.api#documentation": "

The Web ACL specification. You can modify the settings in this Web ACL and use it to update this Web ACL or create a new one.

" + "smithy.api#documentation": "

The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or create a new one.

" } }, "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } } } @@ -3712,7 +3723,7 @@ "min": 1, "max": 50 }, - "smithy.api#pattern": ".*\\S.*" + "smithy.api#pattern": "\\S" } }, "com.amazonaws.wafv2#IPAddressVersion": { @@ -3776,13 +3787,13 @@ "Addresses": { "target": "com.amazonaws.wafv2#IPAddresses", "traits": { - "smithy.api#documentation": "

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Examples:

\n \n

For more information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

", + "smithy.api#documentation": "

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Examples:

\n \n

For more information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

\n

AWS WAF assigns an ARN to each IPSet that you create. To use an IP set in a rule, you provide the ARN to the Rule statement IPSetReferenceStatement.

" + "smithy.api#documentation": "

Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

\n

WAF assigns an ARN to each IPSet that you create. To use an IP set in a rule, you provide the ARN to the Rule statement IPSetReferenceStatement.

" } }, "com.amazonaws.wafv2#IPSetForwardedIPConfig": { @@ -3791,27 +3802,27 @@ "HeaderName": { "target": "com.amazonaws.wafv2#ForwardedIPHeaderName", "traits": { - "smithy.api#documentation": "

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

\n \n \n

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

\n ", + "smithy.api#documentation": "

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n ", "smithy.api#required": {} } }, "FallbackBehavior": { "target": "com.amazonaws.wafv2#FallbackBehavior", "traits": { - "smithy.api#documentation": "

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

\n \n \n

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

\n \n \n

You can specify the following fallback behaviors:

\n ", + "smithy.api#documentation": "

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n \n

You can specify the following fallback behaviors:

\n ", "smithy.api#required": {} } }, "Position": { "target": "com.amazonaws.wafv2#ForwardedIPPosition", "traits": { - "smithy.api#documentation": "

The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

\n

The options for this setting are the following:

\n ", + "smithy.api#documentation": "

The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

\n

The options for this setting are the following:

\n ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

\n \n \n \n

This configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.

" + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n \n \n

This configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.

" } }, "com.amazonaws.wafv2#IPSetReferenceStatement": { @@ -3827,12 +3838,12 @@ "IPSetForwardedIPConfig": { "target": "com.amazonaws.wafv2#IPSetForwardedIPConfig", "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

\n " + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n " } } }, "traits": { - "smithy.api#documentation": "

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

\n

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

" + "smithy.api#documentation": "

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

\n

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" } }, "com.amazonaws.wafv2#IPSetSummaries": { @@ -3865,7 +3876,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } }, "ARN": { @@ -3888,26 +3899,26 @@ "MatchPattern": { "target": "com.amazonaws.wafv2#JsonMatchPattern", "traits": { - "smithy.api#documentation": "

The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.

", + "smithy.api#documentation": "

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

", "smithy.api#required": {} } }, "MatchScope": { "target": "com.amazonaws.wafv2#JsonMatchScope", "traits": { - "smithy.api#documentation": "

The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values.

", + "smithy.api#documentation": "

The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

", "smithy.api#required": {} } }, "InvalidFallbackBehavior": { "target": "com.amazonaws.wafv2#BodyParsingFallbackBehavior", "traits": { - "smithy.api#documentation": "

What AWS WAF should do if it fails to completely parse the JSON body. The options are the following:

\n \n

If you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters.

\n

AWS WAF does its best to parse the entire JSON body, but might be forced\n \tto stop for reasons such as invalid characters, duplicate keys,\n \ttruncation, and any content whose root node isn't an object or an array.

\n

AWS WAF parses the JSON in the following examples as two valid key,\n \tvalue pairs:

\n " + "smithy.api#documentation": "

What WAF should do if it fails to completely parse the JSON body. The options are the following:

\n \n

If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

\n

WAF does its best to parse the entire JSON body, but might be forced\n \tto stop for reasons such as characters that aren't valid, duplicate keys,\n \ttruncation, and any content whose root node isn't an object or an array.

\n

WAF parses the JSON in the following examples as two valid key,\n \tvalue pairs:

\n " } } }, "traits": { - "smithy.api#documentation": "

The body of a web request, inspected as JSON. The body immediately follows the request headers. This is used in the FieldToMatch specification.

\n

Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. AWS WAF inspects only the parts of the JSON that result from the matches that you indicate.

" + "smithy.api#documentation": "

The body of a web request, inspected as JSON. The body immediately follows the request headers. This is used in the FieldToMatch specification.

\n

Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON that result from the matches that you indicate.

" } }, "com.amazonaws.wafv2#JsonMatchPattern": { @@ -3927,7 +3938,7 @@ } }, "traits": { - "smithy.api#documentation": "

The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.

" + "smithy.api#documentation": "

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.

" } }, "com.amazonaws.wafv2#JsonMatchScope": { @@ -3956,7 +3967,7 @@ "min": 1, "max": 512 }, - "smithy.api#pattern": "([/])|([/](([^~])|(~[01]))+)" + "smithy.api#pattern": "^([/])|([/](([^~])|(~[01]))+)$" } }, "com.amazonaws.wafv2#JsonPointerPaths": { @@ -4023,13 +4034,13 @@ "Key": { "target": "com.amazonaws.wafv2#LabelMatchKey", "traits": { - "smithy.api#documentation": "

The string to match against. The setting you provide for this depends on the match statement's Scope settings:

\n \n

Labels are case sensitive and components of a label must be separated by colon, for example NS1:NS2:name.

", + "smithy.api#documentation": "

The string to match against. The setting you provide for this depends on the match statement's Scope setting:

\n \n

Labels are case sensitive and components of a label must be separated by colon, for example NS1:NS2:name.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL.

\n

The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, AWS WAF performs the search for labels that were added in the same context as the label match statement.

" + "smithy.api#documentation": "

A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL.

\n

The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

" } }, "com.amazonaws.wafv2#LabelName": { @@ -4103,7 +4114,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves an array of managed rule groups that are available for you to use. This list includes all AWS Managed Rules rule groups and the AWS Marketplace managed rule groups that you're subscribed to.

" + "smithy.api#documentation": "

Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and the Marketplace managed rule groups that you're subscribed to.

" } }, "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsRequest": { @@ -4112,20 +4123,20 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": { "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" } }, "Limit": { "target": "com.amazonaws.wafv2#PaginationLimit", "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want AWS WAF to return for this request. If more \n objects are available, in the response, AWS WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" } } } @@ -4136,7 +4147,7 @@ "NextMarker": { "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" } }, "ManagedRuleGroups": { @@ -4176,20 +4187,20 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": { "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" } }, "Limit": { "target": "com.amazonaws.wafv2#PaginationLimit", "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want AWS WAF to return for this request. If more \n objects are available, in the response, AWS WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" } } } @@ -4200,7 +4211,7 @@ "NextMarker": { "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" } }, "IPSets": { @@ -4240,19 +4251,19 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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 " } }, "NextMarker": { "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" } }, "Limit": { "target": "com.amazonaws.wafv2#PaginationLimit", "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want AWS WAF to return for this request. If more \n objects are available, in the response, AWS WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" } } } @@ -4269,7 +4280,7 @@ "NextMarker": { "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" } } } @@ -4312,20 +4323,20 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": { "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" } }, "Limit": { "target": "com.amazonaws.wafv2#PaginationLimit", "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want AWS WAF to return for this request. If more \n objects are available, in the response, AWS WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" } } } @@ -4336,7 +4347,7 @@ "NextMarker": { "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" } }, "RegexPatternSets": { @@ -4370,7 +4381,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL. If you want the list of AWS CloudFront resources, use the AWS CloudFront call ListDistributionsByWebACLId.

" + "smithy.api#documentation": "

Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL. If you want the list of Amazon CloudFront resources, use the CloudFront call ListDistributionsByWebACLId.

" } }, "com.amazonaws.wafv2#ListResourcesForWebACLRequest": { @@ -4379,14 +4390,14 @@ "WebACLArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Web ACL.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL.

", "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.wafv2#ResourceType", "traits": { - "smithy.api#documentation": "

Used for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

" + "smithy.api#documentation": "

Used for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

" } } } @@ -4431,20 +4442,20 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": { "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" } }, "Limit": { "target": "com.amazonaws.wafv2#PaginationLimit", "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want AWS WAF to return for this request. If more \n objects are available, in the response, AWS WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" } } } @@ -4455,7 +4466,7 @@ "NextMarker": { "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" } }, "RuleGroups": { @@ -4495,7 +4506,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

\n

You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP \n sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console.

" + "smithy.api#documentation": "

Retrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP \n sets, and regex pattern sets. You can't manage or view tags through the WAF console.

" } }, "com.amazonaws.wafv2#ListTagsForResourceRequest": { @@ -4504,13 +4515,13 @@ "NextMarker": { "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" } }, "Limit": { "target": "com.amazonaws.wafv2#PaginationLimit", "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want AWS WAF to return for this request. If more \n objects are available, in the response, AWS WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" } }, "ResourceARN": { @@ -4528,7 +4539,7 @@ "NextMarker": { "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" } }, "TagInfoForResource": { @@ -4568,20 +4579,20 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": { "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" } }, "Limit": { "target": "com.amazonaws.wafv2#PaginationLimit", "traits": { - "smithy.api#documentation": "

The maximum number of objects that you want AWS WAF to return for this request. If more \n objects are available, in the response, AWS WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" } } } @@ -4592,7 +4603,7 @@ "NextMarker": { "target": "com.amazonaws.wafv2#NextMarker", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, AWS WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" } }, "WebACLs": { @@ -4651,7 +4662,7 @@ "ManagedByFirewallManager": { "target": "com.amazonaws.wafv2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only \n Firewall Manager can modify or delete the configuration.

" + "smithy.api#documentation": "

Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration. If true, only \n Firewall Manager can modify or delete the configuration.

" } }, "LoggingFilter": { @@ -4662,7 +4673,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines an association between Amazon Kinesis Data Firehose destinations and a web ACL resource, for \n logging from AWS WAF.\n As part of the association, you can specify parts of the standard logging fields to keep out of the logs and you \n can specify filters so that you log only a subset of the logging records.

" + "smithy.api#documentation": "

Defines an association between Amazon Kinesis Data Firehose destinations and a web ACL resource, for \n logging from WAF.\n As part of the association, you can specify parts of the standard logging fields to keep out of the logs and you \n can specify filters so that you log only a subset of the logging records.

" } }, "com.amazonaws.wafv2#LoggingConfigurations": { @@ -4717,11 +4728,14 @@ } }, "ScopeDownStatement": { - "target": "com.amazonaws.wafv2#Statement" + "target": "com.amazonaws.wafv2#Statement", + "traits": { + "smithy.api#documentation": "

An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

" + } } }, "traits": { - "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

\n

You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

" + "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

\n

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

" } }, "com.amazonaws.wafv2#ManagedRuleGroupSummaries": { @@ -4748,19 +4762,19 @@ "Description": { "target": "com.amazonaws.wafv2#EntityDescription", "traits": { - "smithy.api#documentation": "

The description of the managed rule group, provided by AWS Managed Rules or the AWS Marketplace seller who manages it.

" + "smithy.api#documentation": "

The description of the managed rule group, provided by Amazon Web Services Managed Rules or the Marketplace seller who manages it.

" } } }, "traits": { - "smithy.api#documentation": "

High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include AWS Managed Rules rule groups, which are free of charge to AWS WAF customers, and AWS Marketplace managed rule groups, which you can subscribe to through AWS Marketplace.

" + "smithy.api#documentation": "

High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups, which are free of charge to WAF customers, and Marketplace managed rule groups, which you can subscribe to through Marketplace.

" } }, "com.amazonaws.wafv2#Method": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.

\n

This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

" + "smithy.api#documentation": "

The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" } }, "com.amazonaws.wafv2#MetricName": { @@ -4780,14 +4794,14 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": ".*\\S.*" + "smithy.api#pattern": "\\S" } }, "com.amazonaws.wafv2#NoneAction": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Specifies that AWS WAF should do nothing. This is generally used to try out a rule 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.

" + "smithy.api#documentation": "

Specifies that WAF should do nothing. This is generally used to try out a rule 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.

" } }, "com.amazonaws.wafv2#NotStatement": { @@ -5084,7 +5098,7 @@ "min": 1, "max": 395000 }, - "smithy.api#pattern": ".*\\S.*" + "smithy.api#pattern": "\\S" } }, "com.amazonaws.wafv2#PopulationSize": { @@ -5149,7 +5163,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.

\n

You can access information about all traffic that AWS WAF inspects using the following\n steps:

\n
    \n
  1. \n

    Create an Amazon Kinesis Data\n Firehose.

    \n

    Create the data firehose with a PUT source and in the Region that you are operating. If you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

    \n

    Give the data firehose a name that starts with the prefix aws-waf-logs-. For example, aws-waf-logs-us-east-2-analytics.

    \n \n

    Do not create the data firehose using a Kinesis stream as your source.

    \n     \n
    2. \n
  2. \n

    Associate that firehose to your web ACL using a PutLoggingConfiguration request.

    \n
    3. \n
\n \n

When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.

" + "smithy.api#documentation": "

Enables the specified LoggingConfiguration, to start logging from a 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\n Firehose.

    \n

    Create the data firehose with a PUT source and in the Region that you are operating. If you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

    \n

    Give the data firehose a name that starts with the prefix aws-waf-logs-. For example, aws-waf-logs-us-east-2-analytics.

    \n \n

    Do not create the data firehose using a Kinesis stream as your source.

    \n     \n
    2. \n
  2. \n

    Associate that firehose to your web ACL using a PutLoggingConfiguration request.

    \n
    3. \n
\n \n

When you successfully enable logging using a PutLoggingConfiguration request, WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the WAF Developer 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 " } }, "com.amazonaws.wafv2#PutLoggingConfigurationRequest": { @@ -5198,7 +5212,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts.

\n

You must be the owner of the rule group to perform this operation.

\n

This action is subject to the following restrictions:

\n " + "smithy.api#documentation": "

Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts.

\n

You must be the owner of the rule group to perform this operation.

\n

This action is subject to the following restrictions:

\n " } }, "com.amazonaws.wafv2#PutPermissionPolicyRequest": { @@ -5214,7 +5228,7 @@ "Policy": { "target": "com.amazonaws.wafv2#PolicyString", "traits": { - "smithy.api#documentation": "

The policy to attach to the specified rule group.

\n \n

The policy specifications must conform to the following:

\n \n

For more information, see IAM Policies.

", + "smithy.api#documentation": "

The policy to attach to the specified rule group.

\n \n

The policy specifications must conform to the following:

\n \n

For more information, see IAM Policies.

", "smithy.api#required": {} } } @@ -5228,7 +5242,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

The query string of a web request. This is the part of a URL that appears after a ? character, if any.

\n

This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

" + "smithy.api#documentation": "

The query string of a web request. This is the part of a URL that appears after a ? character, if any.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" } }, "com.amazonaws.wafv2#RateBasedStatement": { @@ -5251,18 +5265,18 @@ "ScopeDownStatement": { "target": "com.amazonaws.wafv2#Statement", "traits": { - "smithy.api#documentation": "

An optional nested statement that narrows the scope of the rate-based statement to matching web requests. This can be any nestable statement, and you can nest statements at any level below this scope-down statement.

" + "smithy.api#documentation": "

An optional nested statement that narrows the scope of the web requests that are evaluated by the rate-based statement. Requests are only tracked by the rate-based statement if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

" } }, "ForwardedIPConfig": { "target": "com.amazonaws.wafv2#ForwardedIPConfig", "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

\n \n \n \n

This is required if AggregateKeyType is set to FORWARDED_IP.

" + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n \n \n

This is required if AggregateKeyType is set to FORWARDED_IP.

" } } }, "traits": { - "smithy.api#documentation": "

A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

\n

When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.

\n

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

\n \n

In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.

\n

You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

" + "smithy.api#documentation": "

A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

\n

When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.

\n

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

\n \n

In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.

\n

You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

" } }, "com.amazonaws.wafv2#RateBasedStatementAggregateKeyType": { @@ -5367,7 +5381,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains one or more regular expressions.

\n

AWS WAF assigns an ARN to each RegexPatternSet that you create. To use a set in a rule, you provide the ARN to the Rule statement RegexPatternSetReferenceStatement.

" + "smithy.api#documentation": "

Contains one or more regular expressions.

\n

WAF assigns an ARN to each RegexPatternSet that you create. To use a set in a rule, you provide the ARN to the Rule statement RegexPatternSetReferenceStatement.

" } }, "com.amazonaws.wafv2#RegexPatternSetReferenceStatement": { @@ -5383,20 +5397,20 @@ "FieldToMatch": { "target": "com.amazonaws.wafv2#FieldToMatch", "traits": { - "smithy.api#documentation": "

The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

", + "smithy.api#documentation": "

The part of a web request that you want WAF to inspect. For more information, see FieldToMatch.

", "smithy.api#required": {} } }, "TextTransformations": { "target": "com.amazonaws.wafv2#TextTransformations", "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

", + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

\n

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

" + "smithy.api#documentation": "

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

\n

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" } }, "com.amazonaws.wafv2#RegexPatternSetSummaries": { @@ -5429,7 +5443,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } }, "ARN": { @@ -5466,7 +5480,7 @@ "min": 20, "max": 2048 }, - "smithy.api#pattern": ".*\\S.*" + "smithy.api#pattern": "\\S" } }, "com.amazonaws.wafv2#ResourceArns": { @@ -5501,7 +5515,7 @@ "min": 1, "max": 10240 }, - "smithy.api#pattern": "[\\s\\S]*" + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.wafv2#ResponseContentType": { @@ -5546,21 +5560,21 @@ "Priority": { "target": "com.amazonaws.wafv2#RulePriority", "traits": { - "smithy.api#documentation": "

If you define more than one Rule in a\n WebACL, AWS WAF evaluates each request against the Rules\n in order based on the value of Priority. \n AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

", + "smithy.api#documentation": "

If you define more than one Rule in a\n WebACL, WAF evaluates each request against the Rules\n in order based on the value of Priority. \n WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

", "smithy.api#required": {} } }, "Statement": { "target": "com.amazonaws.wafv2#Statement", "traits": { - "smithy.api#documentation": "

The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.

", + "smithy.api#documentation": "

The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.

", "smithy.api#required": {} } }, "Action": { "target": "com.amazonaws.wafv2#RuleAction", "traits": { - "smithy.api#documentation": "

The action that AWS WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

\n

This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n

You must specify either this Action setting or the rule OverrideAction setting, but not both:

\n " + "smithy.api#documentation": "

The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

\n

This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n

You must specify either this Action setting or the rule OverrideAction setting, but not both:

\n " } }, "OverrideAction": { @@ -5572,7 +5586,7 @@ "RuleLabels": { "target": "com.amazonaws.wafv2#Labels", "traits": { - "smithy.api#documentation": "

Labels to apply to web requests that match the rule match statement. AWS WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

\n

Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement.

\n

For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:

\n \n

For example, myLabelName or nameSpace1:nameSpace2:myLabelName.

" + "smithy.api#documentation": "

Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

\n

Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement.

\n

For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:

\n \n

For example, myLabelName or nameSpace1:nameSpace2:myLabelName.

" } }, "VisibilityConfig": { @@ -5584,7 +5598,7 @@ } }, "traits": { - "smithy.api#documentation": "

A single rule, which you can use in a WebACL or RuleGroup to identify \n web requests that you want to allow, block, or count. \n Each rule includes one top-level Statement that AWS WAF uses to identify matching \n web requests, and parameters that govern how AWS WAF handles them.

" + "smithy.api#documentation": "

A single rule, which you can use in a WebACL or RuleGroup to identify \n web requests that you want to allow, block, or count. \n Each rule includes one top-level Statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them.

" } }, "com.amazonaws.wafv2#RuleAction": { @@ -5593,24 +5607,24 @@ "Block": { "target": "com.amazonaws.wafv2#BlockAction", "traits": { - "smithy.api#documentation": "

Instructs AWS WAF to block the web request.

" + "smithy.api#documentation": "

Instructs WAF to block the web request.

" } }, "Allow": { "target": "com.amazonaws.wafv2#AllowAction", "traits": { - "smithy.api#documentation": "

Instructs AWS WAF to allow the web request.

" + "smithy.api#documentation": "

Instructs WAF to allow the web request.

" } }, "Count": { "target": "com.amazonaws.wafv2#CountAction", "traits": { - "smithy.api#documentation": "

Instructs AWS WAF to count the web request and allow it.

" + "smithy.api#documentation": "

Instructs WAF to count the web request and allow it.

" } } }, "traits": { - "smithy.api#documentation": "

The action that AWS WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.

" + "smithy.api#documentation": "

The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.

" } }, "com.amazonaws.wafv2#RuleGroup": { @@ -5633,7 +5647,7 @@ "Capacity": { "target": "com.amazonaws.wafv2#CapacityUnit", "traits": { - "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

When you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.

\n

AWS WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. AWS WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

", + "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

When you create your own rule group, you define this, and you cannot change it after creation. \n When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity \n for a set of rules using CheckCapacity.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

", "smithy.api#required": {} } }, @@ -5653,7 +5667,7 @@ "Rules": { "target": "com.amazonaws.wafv2#Rules", "traits": { - "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching \n web requests, and parameters that govern how AWS WAF handles them. \n

" + "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" } }, "VisibilityConfig": { @@ -5666,19 +5680,19 @@ "LabelNamespace": { "target": "com.amazonaws.wafv2#LabelName", "traits": { - "smithy.api#documentation": "

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

\n " + "smithy.api#documentation": "

The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.

\n " } }, "CustomResponseBodies": { "target": "com.amazonaws.wafv2#CustomResponseBodies", "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 rule group, and then use them in the rules that you define in the rule group.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the \n AWS WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the \n AWS WAF Developer Guide.

" + "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 rule group, and then use them in the rules that you define in the rule group.

\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.

" } }, "AvailableLabels": { "target": "com.amazonaws.wafv2#LabelSummaries", "traits": { - "smithy.api#documentation": "

The labels that one or more rules in this rule group add to matching web ACLs. These labels are defined in the RuleLabels for a Rule.

" + "smithy.api#documentation": "

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule.

" } }, "ConsumedLabels": { @@ -5705,7 +5719,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 AWS WAF to exclude from processing for this rule statement.

" + "smithy.api#documentation": "

The names of rules that are in the referenced rule group, but that you want WAF to exclude from processing for this rule statement.

" } } }, @@ -5743,7 +5757,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } }, "ARN": { @@ -5781,7 +5795,10 @@ } }, "Action": { - "target": "com.amazonaws.wafv2#RuleAction" + "target": "com.amazonaws.wafv2#RuleAction", + "traits": { + "smithy.api#documentation": "

The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.

" + } } }, "traits": { @@ -5822,7 +5839,7 @@ "Timestamp": { "target": "com.amazonaws.wafv2#Timestamp", "traits": { - "smithy.api#documentation": "

The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).

" + "smithy.api#documentation": "

The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).

" } }, "Action": { @@ -5840,7 +5857,7 @@ "RequestHeadersInserted": { "target": "com.amazonaws.wafv2#HTTPHeaders", "traits": { - "smithy.api#documentation": "

Custom request headers inserted by AWS WAF into the request, according to the custom request configuration for the matching rule action.

" + "smithy.api#documentation": "

Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.

" } }, "ResponseCodeSent": { @@ -5852,7 +5869,7 @@ "Labels": { "target": "com.amazonaws.wafv2#Labels", "traits": { - "smithy.api#documentation": "

Labels applied to the web request by matching rules. AWS WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

\n

For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.

" + "smithy.api#documentation": "

Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

\n

For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.

" } } }, @@ -5896,7 +5913,7 @@ } }, "traits": { - "smithy.api#documentation": "

One of the headers in a web request, identified by name, for example, User-Agent or Referer. This setting isn't case sensitive.

\n

This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

" + "smithy.api#documentation": "

One of the headers in a web request, identified by name, for example, User-Agent or Referer. This setting isn't case sensitive.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" } }, "com.amazonaws.wafv2#SingleQueryArgument": { @@ -5929,7 +5946,7 @@ "FieldToMatch": { "target": "com.amazonaws.wafv2#FieldToMatch", "traits": { - "smithy.api#documentation": "

The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

", + "smithy.api#documentation": "

The part of a web request that you want WAF to inspect. For more information, see FieldToMatch.

", "smithy.api#required": {} } }, @@ -5950,13 +5967,13 @@ "TextTransformations": { "target": "com.amazonaws.wafv2#TextTransformations", "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

", + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

", "smithy.api#required": {} } } }, "traits": { - "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 AWS WAF to inspect the request body, AWS 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.

" + "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#SqliMatchStatement": { @@ -5965,20 +5982,20 @@ "FieldToMatch": { "target": "com.amazonaws.wafv2#FieldToMatch", "traits": { - "smithy.api#documentation": "

The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

", + "smithy.api#documentation": "

The part of a web request that you want WAF to inspect. For more information, see FieldToMatch.

", "smithy.api#required": {} } }, "TextTransformations": { "target": "com.amazonaws.wafv2#TextTransformations", "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

", + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.

" + "smithy.api#documentation": "

Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.

" } }, "com.amazonaws.wafv2#Statement": { @@ -5987,25 +6004,25 @@ "ByteMatchStatement": { "target": "com.amazonaws.wafv2#ByteMatchStatement", "traits": { - "smithy.api#documentation": "

A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.

" + "smithy.api#documentation": "

A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is refered to as a string match statement.

" } }, "SqliMatchStatement": { "target": "com.amazonaws.wafv2#SqliMatchStatement", "traits": { - "smithy.api#documentation": "

Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.

" + "smithy.api#documentation": "

Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.

" } }, "XssMatchStatement": { "target": "com.amazonaws.wafv2#XssMatchStatement", "traits": { - "smithy.api#documentation": "

A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. \n XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious \n client-site scripts into other legitimate web browsers. \n The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations \n to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.

" + "smithy.api#documentation": "

A rule statement that defines a cross-site scripting (XSS) match search for WAF to apply to web requests. \n XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious \n client-site scripts into other legitimate web browsers. \n The XSS match statement provides the location in requests that you want WAF to search and text transformations \n to use on the search area before WAF searches for character sequences that are likely to be malicious strings.

" } }, "SizeConstraintStatement": { "target": "com.amazonaws.wafv2#SizeConstraintStatement", "traits": { - "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 AWS WAF to inspect the request body, AWS 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.

" + "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.

" } }, "GeoMatchStatement": { @@ -6023,19 +6040,19 @@ "IPSetReferenceStatement": { "target": "com.amazonaws.wafv2#IPSetReferenceStatement", "traits": { - "smithy.api#documentation": "

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

\n

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

" + "smithy.api#documentation": "

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

\n

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" } }, "RegexPatternSetReferenceStatement": { "target": "com.amazonaws.wafv2#RegexPatternSetReferenceStatement", "traits": { - "smithy.api#documentation": "

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

\n

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

" + "smithy.api#documentation": "

A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

\n

Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.

" } }, "RateBasedStatement": { "target": "com.amazonaws.wafv2#RateBasedStatement", "traits": { - "smithy.api#documentation": "

A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

\n

When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.

\n

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

\n \n

In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.

\n

You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

" + "smithy.api#documentation": "

A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

\n

When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.

\n

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

\n \n

In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.

\n

You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

" } }, "AndStatement": { @@ -6059,18 +6076,18 @@ "ManagedRuleGroupStatement": { "target": "com.amazonaws.wafv2#ManagedRuleGroupStatement", "traits": { - "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

\n

You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

" + "smithy.api#documentation": "

A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

\n

You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

" } }, "LabelMatchStatement": { "target": "com.amazonaws.wafv2#LabelMatchStatement", "traits": { - "smithy.api#documentation": "

A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL.

\n

The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, AWS WAF performs the search for labels that were added in the same context as the label match statement.

" + "smithy.api#documentation": "

A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL.

\n

The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

" } } }, "traits": { - "smithy.api#documentation": "

The processing guidance for a Rule, used by AWS WAF to determine whether a web request matches the rule.

" + "smithy.api#documentation": "

The processing guidance for a Rule, used by WAF to determine whether a web request matches the rule.

" } }, "com.amazonaws.wafv2#Statements": { @@ -6098,7 +6115,7 @@ } }, "traits": { - "smithy.api#documentation": "

A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a \n specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

\n

You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP \n sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console.

" + "smithy.api#documentation": "

A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a \n specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP \n sets, and regex pattern sets. You can't manage or view tags through the WAF console.

" } }, "com.amazonaws.wafv2#TagInfoForResource": { @@ -6118,7 +6135,7 @@ } }, "traits": { - "smithy.api#documentation": "

The collection of tagging definitions for an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a \n specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

\n

You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP \n sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console.

" + "smithy.api#documentation": "

The collection of tagging definitions for an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a \n specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP \n sets, and regex pattern sets. You can't manage or view tags through the WAF console.

" } }, "com.amazonaws.wafv2#TagKey": { @@ -6185,7 +6202,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

\n

You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP \n sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console.

" + "smithy.api#documentation": "

Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP \n sets, and regex pattern sets. You can't manage or view tags through the WAF console.

" } }, "com.amazonaws.wafv2#TagResourceRequest": { @@ -6227,14 +6244,14 @@ "Priority": { "target": "com.amazonaws.wafv2#TextTransformationPriority", "traits": { - "smithy.api#documentation": "

Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all\n transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

", + "smithy.api#documentation": "

Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all\n transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.wafv2#TextTransformationType", "traits": { - "smithy.api#documentation": "

You can specify the following transformation types:

\n

\n CMD_LINE\n

\n

When you're concerned that attackers are injecting an operating system command line\n command and using unusual formatting to disguise some or all of the command, use this\n option to perform the following transformations:

\n \n \n

\n COMPRESS_WHITE_SPACE\n

\n

Use this option to replace the following characters with a space character (decimal 32):

\n \n

\n COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

\t\t\n

\n HTML_ENTITY_DECODE\n

\n

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs \n the following operations:

\n \t\t\n

\n LOWERCASE\n

\n

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

\t\t\n

\n URL_DECODE\n

\n

Use this option to decode a URL-encoded value.

\t\t\n

\n NONE\n

\n

Specify NONE if you don't want any text transformations.

", + "smithy.api#documentation": "

You can specify the following transformation types:

\n

\n BASE64_DECODE - Decode a Base64-encoded\n string.

\n

\n BASE64_DECODE_EXT - Decode a\n Base64-encoded string, but use a forgiving implementation that ignores\n characters that aren't valid.

\n

\n CMD_LINE - Command-line transformations. These are\n helpful in reducing effectiveness of attackers who inject an operating system command-line\n command and use unusual formatting to disguise some or all of the command.

\n \n \n

\n COMPRESS_WHITE_SPACE - Replace these characters\n with a space character (decimal 32):

\n \n

\n COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

\t\t\n

\n CSS_DECODE - Decode characters that were encoded\n using CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes in\n the decoding process, so it can help to uncover ASCII characters that were encoded using\n CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion,\n which is a combination of a backslash and non-hexadecimal characters. For example,\n ja\\vascript for javascript.

\n

\n ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences:\n \\a, \\b, \\f, \\n, \\r, \\t, \\v, \\\\, \\?, \\', \\\", \\xHH (hexadecimal), \\0OOO (octal). Encodings\n that aren't valid remain in the output.

\n

\n HEX_DECODE - Decode a string of hexadecimal characters into a binary.

\n

\n HTML_ENTITY_DECODE - Replace HTML-encoded\n characters with unencoded characters. HTML_ENTITY_DECODE performs these\n operations:

\n \t\t\n

\n JS_DECODE - Decode JavaScript escape sequences. If\n a \\\n u\n HHHH code is in the full-width ASCII code range of FF01-FF5E, then the higher byte is\n used to detect and adjust the lower byte. If not, only the lower byte is used and the\n higher byte is zeroed, causing a possible loss of information.

\n

\n LOWERCASE - Convert uppercase letters (A-Z) to\n lowercase (a-z).

\n

\n MD5 - Calculate an MD5 hash from the data in the\n input. The computed hash is in a raw binary form.

\n

\n NONE - Specify NONE if you don't want any text transformations.\n

\n

\n NORMALIZE_PATH - Remove multiple slashes, directory\n self-references, and directory back-references that are not at the beginning of the input\n from an input string.

\n

\n NORMALIZE_PATH_WIN - This is the same as\n NORMALIZE_PATH, but first converts backslash characters to forward slashes.

\n

\n REMOVE_NULLS - Remove all NULL bytes\n from the input.

\n

\n REPLACE_COMMENTS - Replace each occurrence of a\n C-style comment (/* ... */) with a single space. Multiple consecutive occurrences are not\n compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a\n standalone termination of a comment (*/) is not acted upon.

\n

\n REPLACE_NULLS - Replace NULL bytes in the input\n with space characters (ASCII 0x20).

\n

\n SQL_HEX_DECODE - Decode the following ANSI C escape sequences:\n \\a, \\b, \\f, \\n, \\r, \\t, \\v, \\\\, \\?, \\', \\\", \\xHH (hexadecimal), \\0OOO (octal). Encodings\n that aren't valid remain in the output.

\n

\n URL_DECODE - Decode a URL-encoded value.

\n

\n URL_DECODE_UNI - Like URL_DECODE, but with support\n for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of\n FF01-FF5E, the higher byte is used to detect and adjust the lower byte. Otherwise, only the\n lower byte is used and the higher byte is zeroed.

\n

\n UTF8_TO_UNICODE - Convert all UTF-8 character\n sequences to Unicode. This helps input normalization, and minimizing false-positives and\n false-negatives for non-English languages.

", "smithy.api#required": {} } } @@ -6278,6 +6295,66 @@ { "value": "URL_DECODE", "name": "URL_DECODE" + }, + { + "value": "BASE64_DECODE", + "name": "BASE64_DECODE" + }, + { + "value": "HEX_DECODE", + "name": "HEX_DECODE" + }, + { + "value": "MD5", + "name": "MD5" + }, + { + "value": "REPLACE_COMMENTS", + "name": "REPLACE_COMMENTS" + }, + { + "value": "ESCAPE_SEQ_DECODE", + "name": "ESCAPE_SEQ_DECODE" + }, + { + "value": "SQL_HEX_DECODE", + "name": "SQL_HEX_DECODE" + }, + { + "value": "CSS_DECODE", + "name": "CSS_DECODE" + }, + { + "value": "JS_DECODE", + "name": "JS_DECODE" + }, + { + "value": "NORMALIZE_PATH", + "name": "NORMALIZE_PATH" + }, + { + "value": "NORMALIZE_PATH_WIN", + "name": "NORMALIZE_PATH_WIN" + }, + { + "value": "REMOVE_NULLS", + "name": "REMOVE_NULLS" + }, + { + "value": "REPLACE_NULLS", + "name": "REPLACE_NULLS" + }, + { + "value": "BASE64_DECODE_EXT", + "name": "BASE64_DECODE_EXT" + }, + { + "value": "URL_DECODE_UNI", + "name": "URL_DECODE_UNI" + }, + { + "value": "UTF8_TO_UNICODE", + "name": "UTF8_TO_UNICODE" } ] } @@ -6299,20 +6376,20 @@ "StartTime": { "target": "com.amazonaws.wafv2#Timestamp", "traits": { - "smithy.api#documentation": "

The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your \n AWS resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

", + "smithy.api#documentation": "

The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your \n Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.wafv2#Timestamp", "traits": { - "smithy.api#documentation": "

The end of the time range from which you want GetSampledRequests to return a sample of the requests that your \n AWS resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

", + "smithy.api#documentation": "

The end of the time range from which you want GetSampledRequests to return a sample of the requests that your \n Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

In a GetSampledRequests request, the StartTime and EndTime objects specify the time range \n for which you want AWS WAF to return a sample of web requests.

\n

You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

\n

In a GetSampledRequests response, the StartTime and EndTime objects specify the time range \n for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first \n 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 \n requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime \n is the time that AWS WAF received the 5,000th request.

" + "smithy.api#documentation": "

In a GetSampledRequests request, the StartTime and EndTime objects specify the time range \n for which you want WAF to return a sample of web requests.

\n

You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

\n

In a GetSampledRequests response, the StartTime and EndTime objects specify the time range \n for which WAF actually returned a sample of web requests. WAF gets the specified number of requests from among the first \n 5,000 requests that your Amazon Web Services resource receives during the specified time period. If your resource receives more than 5,000 \n requests during that period, WAF stops sampling after the 5,000th request. In that case, EndTime \n is the time that WAF received the 5,000th request.

" } }, "com.amazonaws.wafv2#Timestamp": { @@ -6350,7 +6427,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates tags from an AWS resource. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be \"customer\" and the tag value might be \"companyA.\" You can specify one or more tags to add to each container. You can add up to 50 tags to each AWS resource.

" + "smithy.api#documentation": "

Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the tag key might be \"customer\" and the tag value might be \"companyA.\" You can specify one or more tags to add to each container. You can add up to 50 tags to each Amazon Web Services resource.

" } }, "com.amazonaws.wafv2#UntagResourceRequest": { @@ -6408,7 +6485,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified IPSet.

\n \n

This operation completely replaces any IP address specifications that you already have in the IP set with the ones that you provide to this call. If you want to add to or modify the addresses that are already in the IP set, retrieve those by calling GetIPSet, update them, and provide the complete updated array of IP addresses to this call.

\n " + "smithy.api#documentation": "

Updates the specified IPSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. To modify the IP set, retrieve it by calling GetIPSet, update the settings as needed, and then provide the complete IP set specification to this call.

\n " } }, "com.amazonaws.wafv2#UpdateIPSetRequest": { @@ -6424,7 +6501,7 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } }, @@ -6444,14 +6521,14 @@ "Addresses": { "target": "com.amazonaws.wafv2#IPAddresses", "traits": { - "smithy.api#documentation": "

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Examples:

\n \n

For more information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

", + "smithy.api#documentation": "

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Examples:

\n \n

For more information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

", "smithy.api#required": {} } }, "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", "smithy.api#required": {} } } @@ -6463,7 +6540,7 @@ "NextLockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" } } } @@ -6500,7 +6577,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified RegexPatternSet.

" + "smithy.api#documentation": "

Updates the specified RegexPatternSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. To modify the regex pattern set, retrieve it by calling GetRegexPatternSet, update the settings as needed, and then provide the complete regex pattern set specification to this call.

\n " } }, "com.amazonaws.wafv2#UpdateRegexPatternSetRequest": { @@ -6516,7 +6593,7 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } }, @@ -6543,7 +6620,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", "smithy.api#required": {} } } @@ -6555,7 +6632,7 @@ "NextLockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" } } } @@ -6598,7 +6675,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified RuleGroup.

\n

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

" + "smithy.api#documentation": "

Updates the specified RuleGroup.

\n \n

This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify the rule group, retrieve it by calling GetRuleGroup, update the settings as needed, and then provide the complete rule group specification to this call.

\n \n

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

" } }, "com.amazonaws.wafv2#UpdateRuleGroupRequest": { @@ -6614,7 +6691,7 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } }, @@ -6634,7 +6711,7 @@ "Rules": { "target": "com.amazonaws.wafv2#Rules", "traits": { - "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching \n web requests, and parameters that govern how AWS WAF handles them. \n

" + "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" } }, "VisibilityConfig": { @@ -6647,14 +6724,14 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", "smithy.api#required": {} } }, "CustomResponseBodies": { "target": "com.amazonaws.wafv2#CustomResponseBodies", "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 rule group, and then use them in the rules that you define in the rule group.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the \n AWS WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the \n AWS WAF Developer Guide.

" + "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 rule group, and then use them in the rules that you define in the rule group.

\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.

" } } } @@ -6665,7 +6742,7 @@ "NextLockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" } } } @@ -6711,7 +6788,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified WebACL.

\n

A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync GraphQL API.

" + "smithy.api#documentation": "

Updates the specified WebACL.

\n \n

This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify the web ACL, retrieve it by calling GetWebACL, update the settings as needed, and then provide the complete web ACL specification to this call.

\n \n

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API.

" } }, "com.amazonaws.wafv2#UpdateWebACLRequest": { @@ -6720,21 +6797,21 @@ "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

", + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", "smithy.api#required": {} } }, "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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": {} } }, "Id": { "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", + "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

", "smithy.api#required": {} } }, @@ -6748,13 +6825,13 @@ "Description": { "target": "com.amazonaws.wafv2#EntityDescription", "traits": { - "smithy.api#documentation": "

A description of the Web ACL that helps with identification.

" + "smithy.api#documentation": "

A description of the web ACL that helps with identification.

" } }, "Rules": { "target": "com.amazonaws.wafv2#Rules", "traits": { - "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching \n web requests, and parameters that govern how AWS WAF handles them. \n

" + "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" } }, "VisibilityConfig": { @@ -6767,14 +6844,14 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", "smithy.api#required": {} } }, "CustomResponseBodies": { "target": "com.amazonaws.wafv2#CustomResponseBodies", "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 AWS WAF in the \n AWS WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the \n AWS WAF Developer Guide.

" + "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.

" } } } @@ -6785,7 +6862,7 @@ "NextLockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" } } } @@ -6794,7 +6871,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

\n

This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

" + "smithy.api#documentation": "

The path component of the URI of a web request. This is the part of a web request that identifies a resource. For example, /images/daily-ad.jpg.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" } }, "com.amazonaws.wafv2#VendorName": { @@ -6804,7 +6881,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": ".*\\S.*" + "smithy.api#pattern": "\\S" } }, "com.amazonaws.wafv2#VisibilityConfig": { @@ -6813,21 +6890,21 @@ "SampledRequestsEnabled": { "target": "com.amazonaws.wafv2#Boolean", "traits": { - "smithy.api#documentation": "

A boolean indicating whether AWS WAF should store a sampling of the web \n requests that match the rules. You can view the sampled requests through the \n AWS WAF console.

", + "smithy.api#documentation": "

A boolean indicating whether WAF should store a sampling of the web \n requests that match the rules. You can view the sampled requests through the \n WAF console.

", "smithy.api#required": {} } }, "CloudWatchMetricsEnabled": { "target": "com.amazonaws.wafv2#Boolean", "traits": { - "smithy.api#documentation": "

A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

", + "smithy.api#documentation": "

A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics.

", "smithy.api#required": {} } }, "MetricName": { "target": "com.amazonaws.wafv2#MetricName", "traits": { - "smithy.api#documentation": "

A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain\n whitespace or metric names reserved for AWS WAF, for example \"All\" and \"Default_Action.\"

", + "smithy.api#documentation": "

A name of the Amazon CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain\n whitespace or metric names reserved for WAF, for example \"All\" and \"Default_Action.\"

", "smithy.api#required": {} } } @@ -6844,7 +6921,7 @@ } }, "traits": { - "smithy.api#documentation": "

AWS WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.

", + "smithy.api#documentation": "

WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.

", "smithy.api#error": "client" } }, @@ -6856,7 +6933,7 @@ } }, "traits": { - "smithy.api#documentation": "

AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.

", + "smithy.api#documentation": "

WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.

", "smithy.api#error": "client" } }, @@ -6868,7 +6945,7 @@ } }, "traits": { - "smithy.api#documentation": "

Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

", + "smithy.api#documentation": "

Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

", "smithy.api#error": "server" } }, @@ -6901,7 +6978,7 @@ } }, "traits": { - "smithy.api#documentation": "

The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

\n ", + "smithy.api#documentation": "

The operation failed because WAF didn't recognize a parameter in the request. For example:

\n ", "smithy.api#error": "client" } }, @@ -6913,7 +6990,7 @@ } }, "traits": { - "smithy.api#documentation": "

The operation failed because the specified policy isn't in the proper format.

\n \n

The policy specifications must conform to the following:

\n \n

For more information, see IAM Policies.

", + "smithy.api#documentation": "

The operation failed because the specified policy isn't in the proper format.

\n \n

The policy specifications must conform to the following:

\n \n

For more information, see IAM Policies.

", "smithy.api#error": "client" } }, @@ -6925,7 +7002,7 @@ } }, "traits": { - "smithy.api#documentation": "

AWS WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.

", + "smithy.api#documentation": "

WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.

", "smithy.api#error": "client" } }, @@ -6937,7 +7014,7 @@ } }, "traits": { - "smithy.api#documentation": "

AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create \n for an AWS account. For more information, see \n Limits in the AWS WAF Developer Guide.

", + "smithy.api#documentation": "

WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create \n for an account. For more information, see \n Limits in the WAF Developer Guide.

", "smithy.api#error": "client" } }, @@ -6949,7 +7026,7 @@ } }, "traits": { - "smithy.api#documentation": "

AWS WAF couldn’t perform the operation because your resource doesn’t exist.

", + "smithy.api#documentation": "

WAF couldn’t perform the operation because your resource doesn’t exist.

", "smithy.api#error": "client" } }, @@ -6961,7 +7038,7 @@ } }, "traits": { - "smithy.api#documentation": "

AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.

", + "smithy.api#documentation": "

WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.

", "smithy.api#error": "client" } }, @@ -6973,7 +7050,7 @@ } }, "traits": { - "smithy.api#documentation": "

AWS WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a call to DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.

", + "smithy.api#documentation": "

WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a call to DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.

", "smithy.api#error": "client" } }, @@ -7009,7 +7086,7 @@ } }, "traits": { - "smithy.api#documentation": "

AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request.

", + "smithy.api#documentation": "

WAF couldn’t perform your tagging operation because of an internal error. Retry your request.

", "smithy.api#error": "server" } }, @@ -7021,7 +7098,7 @@ } }, "traits": { - "smithy.api#documentation": "

AWS WAF couldn’t retrieve the resource that you requested. Retry your request.

", + "smithy.api#documentation": "

WAF couldn’t retrieve the resource that you requested. Retry your request.

", "smithy.api#error": "client" } }, @@ -7031,7 +7108,7 @@ "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

", + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

", "smithy.api#required": {} } }, @@ -7045,7 +7122,7 @@ "ARN": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Web ACL that you want to associate with the resource.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

", "smithy.api#required": {} } }, @@ -7059,13 +7136,13 @@ "Description": { "target": "com.amazonaws.wafv2#EntityDescription", "traits": { - "smithy.api#documentation": "

A description of the Web ACL that helps with identification.

" + "smithy.api#documentation": "

A description of the web ACL that helps with identification.

" } }, "Rules": { "target": "com.amazonaws.wafv2#Rules", "traits": { - "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching \n web requests, and parameters that govern how AWS WAF handles them. \n

" + "smithy.api#documentation": "

The Rule statements used to identify the web requests that you \n want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them. \n

" } }, "VisibilityConfig": { @@ -7078,42 +7155,42 @@ "Capacity": { "target": "com.amazonaws.wafv2#ConsumedCapacity", "traits": { - "smithy.api#documentation": "

The web ACL capacity units (WCUs) currently being used by this web ACL.

\n

AWS WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. AWS WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

" + "smithy.api#documentation": "

The web ACL capacity units (WCUs) currently being used by this web ACL.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

" } }, "PreProcessFirewallManagerRuleGroups": { "target": "com.amazonaws.wafv2#FirewallManagerRuleGroups", "traits": { - "smithy.api#documentation": "

The first set of rules for AWS WAF to process in the web ACL. This is defined in an AWS Firewall Manager WAF policy and \n contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are \n prioritized after these.

\n

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL \n and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to\n determine their relative processing order.

" + "smithy.api#documentation": "

The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and \n contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are \n prioritized after these.

\n

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL \n and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to\n determine their relative processing order.

" } }, "PostProcessFirewallManagerRuleGroups": { "target": "com.amazonaws.wafv2#FirewallManagerRuleGroups", "traits": { - "smithy.api#documentation": "

The last set of rules for AWS WAF to process in the web ACL. This is defined in an AWS Firewall Manager WAF policy and \n contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are \n prioritized before these.

\n

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL \n and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to\n determine their relative processing order.

" + "smithy.api#documentation": "

The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and \n contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are \n prioritized before these.

\n

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL \n and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to\n determine their relative processing order.

" } }, "ManagedByFirewallManager": { "target": "com.amazonaws.wafv2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether this web ACL is managed by AWS Firewall Manager. If true, then only AWS Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.

" + "smithy.api#documentation": "

Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.

" } }, "LabelNamespace": { "target": "com.amazonaws.wafv2#LabelName", "traits": { - "smithy.api#documentation": "

The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.

\n " + "smithy.api#documentation": "

The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.

\n " } }, "CustomResponseBodies": { "target": "com.amazonaws.wafv2#CustomResponseBodies", "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 AWS WAF in the \n AWS WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the \n AWS WAF Developer Guide.

" + "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.

" } } }, "traits": { - "smithy.api#documentation": "

A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync GraphQL API.

" + "smithy.api#documentation": "

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API.

" } }, "com.amazonaws.wafv2#WebACLSummaries": { @@ -7128,25 +7205,25 @@ "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

" + "smithy.api#documentation": "

The name of the web ACL. You cannot change the name of a web ACL after you create it.

" } }, "Id": { "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" + "smithy.api#documentation": "

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

" } }, "Description": { "target": "com.amazonaws.wafv2#EntityDescription", "traits": { - "smithy.api#documentation": "

A description of the Web ACL that helps with identification.

" + "smithy.api#documentation": "

A description of the web ACL that helps with identification.

" } }, "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } }, "ARN": { @@ -7166,20 +7243,20 @@ "FieldToMatch": { "target": "com.amazonaws.wafv2#FieldToMatch", "traits": { - "smithy.api#documentation": "

The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

", + "smithy.api#documentation": "

The part of a web request that you want WAF to inspect. For more information, see FieldToMatch.

", "smithy.api#required": {} } }, "TextTransformations": { "target": "com.amazonaws.wafv2#TextTransformations", "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

", + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n If you specify one or more transformations in a rule statement, WAF performs all transformations on the \n content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. \n XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious \n client-site scripts into other legitimate web browsers. \n The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations \n to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.

" + "smithy.api#documentation": "

A rule statement that defines a cross-site scripting (XSS) match search for WAF to apply to web requests. \n XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious \n client-site scripts into other legitimate web browsers. \n The XSS match statement provides the location in requests that you want WAF to search and text transformations \n to use on the search area before WAF searches for character sequences that are likely to be malicious strings.

" } } } -- GitLab