This is the Amazon Web Services Private Certificate Authority API Reference. It provides descriptions,\n\t\t\tsyntax, and usage examples for each of the actions and data types involved in creating\n\t\t\tand managing a private certificate authority (CA) for your organization.
\nThe documentation for each action shows the API request parameters and the JSON\n\t\t\tresponse. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is\n\t\t\ttailored to the programming language or platform that you prefer. For more information,\n\t\t\tsee Amazon Web Services SDKs.
\nEach Amazon Web Services Private CA API operation has a quota that determines the number of times the\n\t\t\toperation can be called per second. Amazon Web Services Private CA throttles API requests at different rates\n\t\t\tdepending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid\n\t\t\trequest because the request exceeds the operation's quota for the number of requests per\n\t\t\tsecond. When a request is throttled, Amazon Web Services Private CA returns a ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request\n\t\t\trate for APIs.
\nTo see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,\n\t\t\tlog into your Amazon Web Services account and visit the Service Quotas\n\t\t\tconsole.
", + "smithy.api#documentation": "This is the Amazon Web Services Private Certificate Authority API Reference. It provides descriptions,\n\t\t\tsyntax, and usage examples for each of the actions and data types involved in creating\n\t\t\tand managing a private certificate authority (CA) for your organization.
\nThe documentation for each action shows the API request parameters and the JSON\n\t\t\tresponse. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is\n\t\t\ttailored to the programming language or platform that you prefer. For more information,\n\t\t\tsee Amazon Web Services SDKs.
\nEach Amazon Web Services Private CA API operation has a quota that determines the number of times the\n\t\t\toperation can be called per second. Amazon Web Services Private CA throttles API requests at different rates\n\t\t\tdepending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid\n\t\t\trequest because the request exceeds the operation's quota for the number of requests per\n\t\t\tsecond. When a request is throttled, Amazon Web Services Private CA returns a ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request\n\t\t\trate for APIs.
\nTo see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,\n\t\t\tlog into your Amazon Web Services account and visit the Service Quotas\n\t\t\tconsole.
", "smithy.api#title": "AWS Certificate Manager Private Certificate Authority", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1927,7 +1927,7 @@ "KeyStorageSecurityStandard": { "target": "com.amazonaws.acmpca#KeyStorageSecurityStandard", "traits": { - "smithy.api#documentation": "Specifies a cryptographic key management compliance standard used for handling CA\n\t\t\tkeys.
\nDefault: FIPS_140_2_LEVEL_3_OR_HIGHER
\nSome Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you\n\t\t\t\tmust provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument for\n\t\t\t\t\tKeyStorageSecurityStandard. Failure to do this results in an\n\t\t\t\t\tInvalidArgsException with the message, \"A certificate authority\n\t\t\t\tcannot be created in this region with the specified security standard.\"
For information about security standard support in various Regions, see Storage\n\t\t\t\t\tand security compliance of Amazon Web Services Private CA private keys.
\nSpecifies a cryptographic key management compliance standard used for handling CA\n\t\t\tkeys.
\nDefault: FIPS_140_2_LEVEL_3_OR_HIGHER
\nSome Amazon Web Services Regions do not support the default. When creating a CA in these\n\t\t\t\tRegions, you must provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument\n\t\t\t\tfor KeyStorageSecurityStandard. Failure to do this results in an\n\t\t\t\t\tInvalidArgsException with the message, \"A certificate authority\n\t\t\t\tcannot be created in this region with the specified security standard.\"
For information about security standard support in various Regions, see Storage\n\t\t\t\t\tand security compliance of Amazon Web Services Private CA private keys.
\nThe name of the algorithm that will be used to sign the certificate to be issued.
\nThis parameter should not be confused with the SigningAlgorithm parameter\n\t\t\tused to sign a CSR in the CreateCertificateAuthority action.
The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of\n\t\t\t\tthe CA's secret key.
\nThe name of the algorithm that will be used to sign the certificate to be issued.
\nThis parameter should not be confused with the SigningAlgorithm parameter\n\t\t\tused to sign a CSR in the CreateCertificateAuthority action.
The specified signing algorithm family (RSA or ECDSA) must match the algorithm\n\t\t\t\tfamily of the CA's secret key.
\nAlphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after one minute. Therefore, if you\n\t\t\tcall IssueCertificate multiple times with the same\n\t\t\tidempotency token within one minute, Amazon Web Services Private CA recognizes that you are requesting only\n\t\t\tone certificate and will issue only one. If you change the idempotency token for each\n\t\t\tcall, Amazon Web Services Private CA recognizes that you are requesting multiple certificates.
" + "smithy.api#documentation": "Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after five minutes. Therefore, if\n\t\t\tyou call IssueCertificate multiple times with the same\n\t\t\tidempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting\n\t\t\tonly one certificate and will issue only one. If you change the idempotency token for\n\t\t\teach call, Amazon Web Services Private CA recognizes that you are requesting multiple certificates.
" } } }, diff --git a/codegen/sdk-codegen/aws-models/amplifybackend.2020-08-11.json b/codegen/sdk-codegen/aws-models/amplifybackend.2020-08-11.json index c6adc6aaeb2..aec30cda322 100644 --- a/codegen/sdk-codegen/aws-models/amplifybackend.2020-08-11.json +++ b/codegen/sdk-codegen/aws-models/amplifybackend.2020-08-11.json @@ -230,52 +230,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -283,13 +287,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -299,224 +312,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://amplifybackend-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://amplifybackend-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://amplifybackend-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://amplifybackend-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://amplifybackend.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://amplifybackend.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://amplifybackend.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://amplifybackend.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -1268,7 +1232,8 @@ } }, "traits": { - "smithy.api#documentation": "Describes Apple social federation configurations for allowing your app users to sign in using OAuth.
" + "smithy.api#documentation": "Describes Apple social federation configurations for allowing your app users to sign in using OAuth.
", + "smithy.api#sensitive": {} } }, "com.amazonaws.amplifybackend#BackendAuthSocialProviderConfig": { @@ -1290,7 +1255,8 @@ } }, "traits": { - "smithy.api#documentation": "Describes third-party social federation configurations for allowing your app users to sign in using OAuth.
" + "smithy.api#documentation": "Describes third-party social federation configurations for allowing your app users to sign in using OAuth.
", + "smithy.api#sensitive": {} } }, "com.amazonaws.amplifybackend#BackendJobRespObj": { @@ -1459,7 +1425,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for CloneBackend.
" + "smithy.api#documentation": "The request body for CloneBackend.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#CloneBackendResponse": { @@ -1507,6 +1474,9 @@ "smithy.api#jsonName": "status" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#CreateBackend": { @@ -1608,7 +1578,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for CreateBackendAPI.
" + "smithy.api#documentation": "The request body for CreateBackendAPI.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#CreateBackendAPIResponse": { @@ -1656,6 +1627,9 @@ "smithy.api#jsonName": "status" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#CreateBackendAuth": { @@ -1879,7 +1853,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for CreateBackendAuth.
" + "smithy.api#documentation": "The request body for CreateBackendAuth.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#CreateBackendAuthResourceConfig": { @@ -1966,6 +1941,9 @@ "smithy.api#jsonName": "status" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#CreateBackendAuthUserPoolConfig": { @@ -2116,7 +2094,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for CreateBackendConfig.
" + "smithy.api#documentation": "The request body for CreateBackendConfig.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#CreateBackendConfigResponse": { @@ -2150,6 +2129,9 @@ "smithy.api#jsonName": "status" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#CreateBackendRequest": { @@ -2195,7 +2177,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for CreateBackend.
" + "smithy.api#documentation": "The request body for CreateBackend.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#CreateBackendResponse": { @@ -2243,6 +2226,9 @@ "smithy.api#jsonName": "status" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#CreateBackendStorage": { @@ -2313,7 +2299,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for CreateBackendStorage.
" + "smithy.api#documentation": "The request body for CreateBackendStorage.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#CreateBackendStorageResourceConfig": { @@ -2378,6 +2365,9 @@ "smithy.api#jsonName": "status" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#CreateToken": { @@ -2422,6 +2412,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#CreateTokenResponse": { @@ -2455,6 +2448,9 @@ "smithy.api#jsonName": "ttl" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#DeleteBackend": { @@ -2555,7 +2551,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for DeleteBackendAPI.
" + "smithy.api#documentation": "The request body for DeleteBackendAPI.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#DeleteBackendAPIResponse": { @@ -2603,6 +2600,9 @@ "smithy.api#jsonName": "status" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#DeleteBackendAuth": { @@ -2665,7 +2665,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for DeleteBackendAuth.
" + "smithy.api#documentation": "The request body for DeleteBackendAuth.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#DeleteBackendAuthResponse": { @@ -2713,6 +2714,9 @@ "smithy.api#jsonName": "status" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#DeleteBackendRequest": { @@ -2734,6 +2738,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#DeleteBackendResponse": { @@ -2781,6 +2788,9 @@ "smithy.api#jsonName": "status" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#DeleteBackendStorage": { @@ -2851,7 +2861,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for DeleteBackendStorage.
" + "smithy.api#documentation": "The request body for DeleteBackendStorage.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#DeleteBackendStorageResponse": { @@ -2885,6 +2896,9 @@ "smithy.api#jsonName": "status" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#DeleteToken": { @@ -2937,6 +2951,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#DeleteTokenResponse": { @@ -2949,6 +2966,9 @@ "smithy.api#jsonName": "isSuccess" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#DeliveryMethod": { @@ -2990,7 +3010,8 @@ } }, "traits": { - "smithy.api#documentation": "The configuration for the email sent when an app user forgets their password.
" + "smithy.api#documentation": "The configuration for the email sent when an app user forgets their password.
", + "smithy.api#sensitive": {} } }, "com.amazonaws.amplifybackend#GatewayTimeoutException": { @@ -3070,7 +3091,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for GenerateBackendAPIModels.
" + "smithy.api#documentation": "The request body for GenerateBackendAPIModels.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#GenerateBackendAPIModelsResponse": { @@ -3118,6 +3140,9 @@ "smithy.api#jsonName": "status" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#GetBackend": { @@ -3242,7 +3267,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for GetBackendAPIModels.
" + "smithy.api#documentation": "The request body for GetBackendAPIModels.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#GetBackendAPIModelsResponse": { @@ -3269,6 +3295,9 @@ "smithy.api#jsonName": "modelIntrospectionSchema" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#GetBackendAPIRequest": { @@ -3307,7 +3336,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for GetBackendAPI.
" + "smithy.api#documentation": "The request body for GetBackendAPI.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#GetBackendAPIResponse": { @@ -3348,6 +3378,9 @@ "smithy.api#jsonName": "resourceName" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#GetBackendAuth": { @@ -3410,7 +3443,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for GetBackendAuth.
" + "smithy.api#documentation": "The request body for GetBackendAuth.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#GetBackendAuthResponse": { @@ -3451,6 +3485,9 @@ "smithy.api#jsonName": "resourceName" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#GetBackendJob": { @@ -3511,6 +3548,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#GetBackendJobResponse": { @@ -3572,6 +3612,9 @@ "smithy.api#jsonName": "updateTime" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#GetBackendRequest": { @@ -3594,7 +3637,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for GetBackend.
" + "smithy.api#documentation": "The request body for GetBackend.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#GetBackendResponse": { @@ -3649,6 +3693,9 @@ "smithy.api#jsonName": "error" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#GetBackendStorage": { @@ -3711,7 +3758,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for GetBackendStorage.
" + "smithy.api#documentation": "The request body for GetBackendStorage.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#GetBackendStorageResourceConfig": { @@ -3783,6 +3831,9 @@ "smithy.api#jsonName": "resourceName" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#GetToken": { @@ -3835,6 +3886,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#GetTokenResponse": { @@ -3868,6 +3922,9 @@ "smithy.api#jsonName": "ttl" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#ImportBackendAuth": { @@ -3953,7 +4010,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for ImportBackendAuth.
" + "smithy.api#documentation": "The request body for ImportBackendAuth.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#ImportBackendAuthResponse": { @@ -4001,6 +4059,9 @@ "smithy.api#jsonName": "status" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#ImportBackendStorage": { @@ -4070,7 +4131,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for ImportBackendStorage.
" + "smithy.api#documentation": "The request body for ImportBackendStorage.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#ImportBackendStorageResponse": { @@ -4104,6 +4166,9 @@ "smithy.api#jsonName": "status" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#ListBackendJobs": { @@ -4193,7 +4258,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for ListBackendJobs.
" + "smithy.api#documentation": "The request body for ListBackendJobs.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#ListBackendJobsResponse": { @@ -4213,6 +4279,9 @@ "smithy.api#jsonName": "nextToken" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#ListOfAdditionalConstraintsElement": { @@ -4318,7 +4387,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for S3Buckets.
" + "smithy.api#documentation": "The request body for S3Buckets.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#ListS3BucketsResponse": { @@ -4338,6 +4408,9 @@ "smithy.api#jsonName": "nextToken" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#LoginAuthConfigReqObj": { @@ -4572,7 +4645,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for RemoveAllBackends.
" + "smithy.api#documentation": "The request body for RemoveAllBackends.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#RemoveAllBackendsResponse": { @@ -4613,6 +4687,9 @@ "smithy.api#jsonName": "status" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#RemoveBackendConfig": { @@ -4657,6 +4734,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#RemoveBackendConfigResponse": { @@ -4669,6 +4749,9 @@ "smithy.api#jsonName": "error" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#RequiredSignUpAttributesElement": { @@ -4921,7 +5004,8 @@ } }, "traits": { - "smithy.api#documentation": "SMS settings for authentication.
" + "smithy.api#documentation": "SMS settings for authentication.
", + "smithy.api#sensitive": {} } }, "com.amazonaws.amplifybackend#SocialProviderSettings": { @@ -5075,7 +5159,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for UpdateBackendAPI.
" + "smithy.api#documentation": "The request body for UpdateBackendAPI.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#UpdateBackendAPIResponse": { @@ -5123,6 +5208,9 @@ "smithy.api#jsonName": "status" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#UpdateBackendAuth": { @@ -5330,7 +5418,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for UpdateBackendAuth.
" + "smithy.api#documentation": "The request body for UpdateBackendAuth.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#UpdateBackendAuthResourceConfig": { @@ -5417,6 +5506,9 @@ "smithy.api#jsonName": "status" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#UpdateBackendAuthUserPoolConfig": { @@ -5543,7 +5635,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for UpdateBackendConfig.
" + "smithy.api#documentation": "The request body for UpdateBackendConfig.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#UpdateBackendConfigResponse": { @@ -5577,6 +5670,9 @@ "smithy.api#jsonName": "loginAuthConfig" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#UpdateBackendJob": { @@ -5653,7 +5749,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for GetBackendJob.
" + "smithy.api#documentation": "The request body for GetBackendJob.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#UpdateBackendJobResponse": { @@ -5715,6 +5812,9 @@ "smithy.api#jsonName": "updateTime" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#UpdateBackendStorage": { @@ -5785,7 +5885,8 @@ } }, "traits": { - "smithy.api#documentation": "The request body for UpdateBackendStorage.
" + "smithy.api#documentation": "The request body for UpdateBackendStorage.
", + "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#UpdateBackendStorageResourceConfig": { @@ -5843,6 +5944,9 @@ "smithy.api#jsonName": "status" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#__boolean": { diff --git a/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json b/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json index 73ef8b5ea16..014424840bc 100644 --- a/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json +++ b/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json @@ -382,7 +382,7 @@ "Alarms": { "target": "com.amazonaws.autoscaling#AlarmList", "traits": { - "smithy.api#documentation": "The names of one or more CloudWatch alarms to monitor for the instance refresh.
" + "smithy.api#documentation": "The names of one or more CloudWatch alarms to monitor for the instance refresh. You can specify up to 10 alarms.
" } } }, diff --git a/codegen/sdk-codegen/aws-models/backup.2018-11-15.json b/codegen/sdk-codegen/aws-models/backup.2018-11-15.json index 4cb3041c689..81f96384ced 100644 --- a/codegen/sdk-codegen/aws-models/backup.2018-11-15.json +++ b/codegen/sdk-codegen/aws-models/backup.2018-11-15.json @@ -157,7 +157,7 @@ "State": { "target": "com.amazonaws.backup#BackupJobState", "traits": { - "smithy.api#documentation": "The current state of a resource recovery point.
" + "smithy.api#documentation": "The current state of a backup job.
" } }, "StatusMessage": { @@ -600,7 +600,7 @@ "StartWindowMinutes": { "target": "com.amazonaws.backup#WindowMinutes", "traits": { - "smithy.api#documentation": "A value in minutes after a backup is scheduled before a job will be canceled if it\n doesn't start successfully. This value is optional. \n If this value is included, it must be at least 60 minutes to avoid errors.
\nDuring the start window, the backup job status remains in CREATED status until it \n has successfully begun or until the start window time has run out. If within the start \n window time Backup receives an error that allows the job to be retried, \n Backup will automatically retry to begin the job at least every 10 minutes \n until the backup \n successfully begins (the job status changes to RUNNING) or until the job status \n changes to EXPIRED (which is expected to occur when the start window time is over).
A value in minutes after a backup is scheduled before a job will be canceled if it\n doesn't start successfully. This value is optional. \n If this value is included, it must be at least 60 minutes to avoid errors.
\nThis parameter has a maximum value of 100 years (52,560,000 minutes).
\nDuring the start window, the backup job status remains in CREATED status until it \n has successfully begun or until the start window time has run out. If within the start \n window time Backup receives an error that allows the job to be retried, \n Backup will automatically retry to begin the job at least every 10 minutes \n until the backup \n successfully begins (the job status changes to RUNNING) or until the job status \n changes to EXPIRED (which is expected to occur when the start window time is over).
The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup will transition and expire backups automatically according\n to the lifecycle that you define.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.
\nResource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.
" + "smithy.api#documentation": "The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup will transition and expire backups automatically according\n to the lifecycle that you define.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.
\nResource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.
\nThis parameter has a maximum value of 100 years (36,500 days).
" } }, "RecoveryPointTags": { @@ -1966,6 +1966,118 @@ "smithy.api#output": {} } }, + "com.amazonaws.backup#CreateLogicallyAirGappedBackupVault": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#CreateLogicallyAirGappedBackupVaultInput" + }, + "output": { + "target": "com.amazonaws.backup#CreateLogicallyAirGappedBackupVaultOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#AlreadyExistsException" + }, + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#InvalidRequestException" + }, + { + "target": "com.amazonaws.backup#LimitExceededException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "This request creates a logical container where backups are stored.
\nThis request includes a name, optionally one or more resource tags, an encryption key, \n and a request ID.
\nDo not include sensitive data, such as passport numbers, in the name of a backup\n vault.
\nThis is the name of the vault that is being created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackupVaultTags": { + "target": "com.amazonaws.backup#Tags", + "traits": { + "smithy.api#documentation": "These are the tags that will be included in the newly-created vault.
" + } + }, + "CreatorRequestId": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "This is the ID of the creation request.
" + } + }, + "MinRetentionDays": { + "target": "com.amazonaws.backup#Long", + "traits": { + "smithy.api#documentation": "This setting specifies the minimum retention period\n that the vault retains its recovery points. If this parameter is not specified, \n no minimum retention period is enforced.
\nIf specified, any backup or copy job to the vault must have a lifecycle policy with a\n retention period equal to or longer than the minimum retention period. If a job\n retention period is shorter than that minimum retention period, then the vault fails the\n backup or copy job, and you should either modify your lifecycle settings or use a different\n vault.
", + "smithy.api#required": {} + } + }, + "MaxRetentionDays": { + "target": "com.amazonaws.backup#Long", + "traits": { + "smithy.api#documentation": "This is the setting that specifies the maximum retention period\n that the vault retains its recovery points. If this parameter is not specified, Backup \n does not enforce a maximum retention period on the recovery points in the vault (allowing\n indefinite storage).
\nIf specified, any backup or copy job to the vault must have a lifecycle policy with a\n retention period equal to or shorter than the maximum retention period. If the job \n retention period is longer than that maximum retention period, then the vault fails the\n backup or copy job, and you should either modify your lifecycle settings or use a different\n vault.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#CreateLogicallyAirGappedBackupVaultOutput": { + "type": "structure", + "members": { + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", + "traits": { + "smithy.api#documentation": "The name of a logical container where backups are stored. Logically air-gapped \n backup vaults are identified by names that are unique to the account used to create \n them and the Region where they are created. They consist of lowercase letters, numbers, \n and hyphens.
" + } + }, + "BackupVaultArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "This is the ARN (Amazon Resource Name) of the vault being created.
" + } + }, + "CreationDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the vault was created.
\nThis value is in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.
" + } + }, + "VaultState": { + "target": "com.amazonaws.backup#VaultState", + "traits": { + "smithy.api#documentation": "This is the current state of the vault.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.backup#CreateReportPlan": { "type": "operation", "input": { @@ -2100,6 +2212,9 @@ { "target": "com.amazonaws.backup#CreateLegalHold" }, + { + "target": "com.amazonaws.backup#CreateLogicallyAirGappedBackupVault" + }, { "target": "com.amazonaws.backup#CreateReportPlan" }, @@ -2229,6 +2344,9 @@ { "target": "com.amazonaws.backup#ListProtectedResources" }, + { + "target": "com.amazonaws.backup#ListProtectedResourcesByBackupVault" + }, { "target": "com.amazonaws.backup#ListRecoveryPointsByBackupVault" }, @@ -3929,7 +4047,7 @@ "State": { "target": "com.amazonaws.backup#BackupJobState", "traits": { - "smithy.api#documentation": "The current state of a resource recovery point.
" + "smithy.api#documentation": "The current state of a backup job.
" } }, "StatusMessage": { @@ -4076,6 +4194,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "BackupVaultAccountId": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "This is the account ID of the specified backup vault.
", + "smithy.api#httpQuery": "backupVaultAccountId" + } } }, "traits": { @@ -4097,6 +4222,12 @@ "smithy.api#documentation": "An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
This is the type of vault described.
" + } + }, "EncryptionKeyArn": { "target": "com.amazonaws.backup#ARN", "traits": { @@ -4498,6 +4629,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "BackupVaultAccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "This is the account ID of the specified backup vault.
", + "smithy.api#httpQuery": "backupVaultAccountId" + } } }, "traits": { @@ -5902,6 +6040,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "BackupVaultAccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "This is the account ID of the specified backup vault.
", + "smithy.api#httpQuery": "backupVaultAccountId" + } } }, "traits": { @@ -6737,6 +6882,21 @@ "com.amazonaws.backup#ListBackupVaultsInput": { "type": "structure", "members": { + "ByVaultType": { + "target": "com.amazonaws.backup#VaultType", + "traits": { + "smithy.api#documentation": "This parameter will sort the list of vaults by vault type.
", + "smithy.api#httpQuery": "vaultType" + } + }, + "ByShared": { + "target": "com.amazonaws.backup#Boolean2", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "This parameter will sort the list of vaults by shared vaults.
", + "smithy.api#httpQuery": "shared" + } + }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { @@ -7103,6 +7263,97 @@ } } }, + "com.amazonaws.backup#ListProtectedResourcesByBackupVault": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#ListProtectedResourcesByBackupVaultInput" + }, + "output": { + "target": "com.amazonaws.backup#ListProtectedResourcesByBackupVaultOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "This request lists the protected resources corresponding to each backup vault.
", + "smithy.api#http": { + "method": "GET", + "uri": "/backup-vaults/{BackupVaultName}/resources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Results", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backup#ListProtectedResourcesByBackupVaultInput": { + "type": "structure", + "members": { + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", + "traits": { + "smithy.api#documentation": "This is the list of protected resources by backup vault within the vault(s) you specify by name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackupVaultAccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "This is the list of protected resources by backup vault within the vault(s) you specify by account ID.
", + "smithy.api#httpQuery": "backupVaultAccountId" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.
The maximum number of items to be returned.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#ListProtectedResourcesByBackupVaultOutput": { + "type": "structure", + "members": { + "Results": { + "target": "com.amazonaws.backup#ProtectedResourcesList", + "traits": { + "smithy.api#documentation": "These are the results returned for the request ListProtectedResourcesByBackupVault.
" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "The next item following a partial list of returned items. For example, if a request is\n made to return maxResults number of items, NextToken allows you\n to return more items in your list starting at the location pointed to by the next\n token.
This parameter will sort the list of recovery points by account ID.
", + "smithy.api#httpQuery": "backupVaultAccountId" + } + }, "NextToken": { "target": "com.amazonaws.backup#string", "traits": { @@ -9027,19 +9285,19 @@ "StartWindowMinutes": { "target": "com.amazonaws.backup#WindowMinutes", "traits": { - "smithy.api#documentation": "A value in minutes after a backup is scheduled before a job will be canceled if it\n doesn't start successfully. This value is optional, and the default is 8 hours. \n If this value is included, it must be at least 60 minutes to avoid errors.
\nDuring the start window, the backup job status remains in CREATED status until it \n has successfully begun or until the start window time has run out. If within the start \n window time Backup receives an error that allows the job to be retried, \n Backup will automatically retry to begin the job at least every 10 minutes \n until the backup \n successfully begins (the job status changes to RUNNING) or until the job status \n changes to EXPIRED (which is expected to occur when the start window time is over).
A value in minutes after a backup is scheduled before a job will be canceled if it\n doesn't start successfully. This value is optional, and the default is 8 hours. \n If this value is included, it must be at least 60 minutes to avoid errors.
\nThis parameter has a maximum value of 100 years (52,560,000 minutes).
\nDuring the start window, the backup job status remains in CREATED status until it \n has successfully begun or until the start window time has run out. If within the start \n window time Backup receives an error that allows the job to be retried, \n Backup will automatically retry to begin the job at least every 10 minutes \n until the backup \n successfully begins (the job status changes to RUNNING) or until the job status \n changes to EXPIRED (which is expected to occur when the start window time is over).
A value in minutes during which a successfully started backup must complete, or else\n Backup will cancel the job. This value is optional. This value begins\n counting down from when the backup was scheduled. It does not add additional time for\n StartWindowMinutes, or if the backup started later than scheduled.
A value in minutes during which a successfully started backup must complete, or else\n Backup will cancel the job. This value is optional. This value begins\n counting down from when the backup was scheduled. It does not add additional time for\n StartWindowMinutes, or if the backup started later than scheduled.
Like StartWindowMinutes, this parameter has a maximum value of \n 100 years (52,560,000 minutes).
The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup will transition and expire backups automatically according\n to the lifecycle that you define.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.
\nResource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.
" + "smithy.api#documentation": "The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup will transition and expire backups automatically according\n to the lifecycle that you define.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.
\nResource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.
\nThis parameter has a maximum value of 100 years (36,500 days).
" } }, "RecoveryPointTags": { @@ -10073,6 +10331,46 @@ "target": "com.amazonaws.backup#string" } }, + "com.amazonaws.backup#VaultState": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.backup#VaultType": { + "type": "enum", + "members": { + "BACKUP_VAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BACKUP_VAULT" + } + }, + "LOGICALLY_AIR_GAPPED_BACKUP_VAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOGICALLY_AIR_GAPPED_BACKUP_VAULT" + } + } + } + }, "com.amazonaws.backup#WindowMinutes": { "type": "long" }, diff --git a/codegen/sdk-codegen/aws-models/chime-sdk-meetings.2021-07-15.json b/codegen/sdk-codegen/aws-models/chime-sdk-meetings.2021-07-15.json index b87023836a1..ae1b3733a2e 100644 --- a/codegen/sdk-codegen/aws-models/chime-sdk-meetings.2021-07-15.json +++ b/codegen/sdk-codegen/aws-models/chime-sdk-meetings.2021-07-15.json @@ -296,9 +296,15 @@ { "target": "com.amazonaws.chimesdkmeetings#NotFoundException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceFailureException" + }, { "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ThrottlingException" + }, { "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" } @@ -475,52 +481,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -528,13 +538,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -544,224 +563,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://meetings-chime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://meetings-chime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://meetings-chime-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://meetings-chime-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://meetings-chime.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://meetings-chime.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://meetings-chime.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://meetings-chime.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -1352,6 +1322,9 @@ { "target": "com.amazonaws.chimesdkmeetings#BadRequestException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ConflictException" + }, { "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" }, @@ -1472,6 +1445,9 @@ { "target": "com.amazonaws.chimesdkmeetings#BadRequestException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ConflictException" + }, { "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" }, @@ -2216,8 +2192,29 @@ "target": "com.amazonaws.chimesdkmeetings#ListTagsForResourceResponse" }, "errors": [ + { + "target": "com.amazonaws.chimesdkmeetings#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#LimitExceededException" + }, { "target": "com.amazonaws.chimesdkmeetings#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ThrottlingException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" } ], "traits": { @@ -2799,11 +2796,29 @@ { "target": "com.amazonaws.chimesdkmeetings#BadRequestException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#LimitExceededException" + }, { "target": "com.amazonaws.chimesdkmeetings#ResourceNotFoundException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ThrottlingException" + }, { "target": "com.amazonaws.chimesdkmeetings#TooManyTagsException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" } ], "traits": { @@ -3409,8 +3424,26 @@ { "target": "com.amazonaws.chimesdkmeetings#BadRequestException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#LimitExceededException" + }, { "target": "com.amazonaws.chimesdkmeetings#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ThrottlingException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" } ], "traits": { @@ -3472,9 +3505,15 @@ { "target": "com.amazonaws.chimesdkmeetings#NotFoundException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceFailureException" + }, { "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ThrottlingException" + }, { "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" } diff --git a/codegen/sdk-codegen/aws-models/chime-sdk-voice.2022-08-03.json b/codegen/sdk-codegen/aws-models/chime-sdk-voice.2022-08-03.json index 5522ed578b5..1b5ccd24ad4 100644 --- a/codegen/sdk-codegen/aws-models/chime-sdk-voice.2022-08-03.json +++ b/codegen/sdk-codegen/aws-models/chime-sdk-voice.2022-08-03.json @@ -1333,9 +1333,9 @@ } }, "params": { - "Region": "us-gov-east-1", "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "Region": "us-gov-east-1" } }, { @@ -1346,9 +1346,9 @@ } }, "params": { - "Region": "us-gov-east-1", "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "Region": "us-gov-east-1" } }, { @@ -1359,9 +1359,9 @@ } }, "params": { - "Region": "us-gov-east-1", "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "Region": "us-gov-east-1" } }, { @@ -1372,9 +1372,9 @@ } }, "params": { - "Region": "us-gov-east-1", "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "Region": "us-gov-east-1" } }, { @@ -1385,9 +1385,9 @@ } }, "params": { - "Region": "cn-north-1", "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "Region": "cn-north-1" } }, { @@ -1398,9 +1398,9 @@ } }, "params": { - "Region": "cn-north-1", "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "Region": "cn-north-1" } }, { @@ -1411,9 +1411,9 @@ } }, "params": { - "Region": "cn-north-1", "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "Region": "cn-north-1" } }, { @@ -1424,9 +1424,9 @@ } }, "params": { - "Region": "cn-north-1", "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "Region": "cn-north-1" } }, { @@ -1435,9 +1435,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-iso-east-1", "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "Region": "us-iso-east-1" } }, { @@ -1448,9 +1448,9 @@ } }, "params": { - "Region": "us-iso-east-1", "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "Region": "us-iso-east-1" } }, { @@ -1459,9 +1459,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-iso-east-1", "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "Region": "us-iso-east-1" } }, { @@ -1472,9 +1472,9 @@ } }, "params": { - "Region": "us-iso-east-1", "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "Region": "us-iso-east-1" } }, { @@ -1485,9 +1485,9 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "Region": "us-east-1" } }, { @@ -1498,9 +1498,9 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "Region": "us-east-1" } }, { @@ -1511,9 +1511,9 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "Region": "us-east-1" } }, { @@ -1524,9 +1524,9 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "Region": "us-east-1" } }, { @@ -1535,9 +1535,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-isob-east-1", "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "Region": "us-isob-east-1" } }, { @@ -1548,9 +1548,9 @@ } }, "params": { - "Region": "us-isob-east-1", "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "Region": "us-isob-east-1" } }, { @@ -1559,9 +1559,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-isob-east-1", "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "Region": "us-isob-east-1" } }, { @@ -1572,9 +1572,9 @@ } }, "params": { - "Region": "us-isob-east-1", "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "Region": "us-isob-east-1" } }, { @@ -1585,9 +1585,9 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": false, "UseFIPS": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -1597,9 +1597,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", "UseDualStack": false, "UseFIPS": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -1609,9 +1609,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", "UseDualStack": true, "UseFIPS": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -1737,6 +1737,12 @@ "smithy.api#documentation": "List of phone numbers, in E.164 format.
", "smithy.api#required": {} } + }, + "Name": { + "target": "com.amazonaws.chimesdkvoice#PhoneNumberName", + "traits": { + "smithy.api#documentation": "Specifies the name assigned to one or more phone numbers.
" + } } }, "traits": { @@ -6858,6 +6864,12 @@ "traits": { "smithy.api#documentation": "The phone number's order ID.
" } + }, + "Name": { + "target": "com.amazonaws.chimesdkvoice#PhoneNumberName", + "traits": { + "smithy.api#documentation": "The name of the phone number.
" + } } }, "traits": { @@ -7036,6 +7048,17 @@ } } }, + "com.amazonaws.chimesdkvoice#PhoneNumberName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^$|^[a-zA-Z0-9\\,\\.\\_\\-]+(\\s+[a-zA-Z0-9\\,\\.\\_\\-]+)*$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.chimesdkvoice#PhoneNumberOrder": { "type": "structure", "members": { @@ -9740,6 +9763,12 @@ "traits": { "smithy.api#documentation": "The outbound calling name associated with the phone number.
" } + }, + "Name": { + "target": "com.amazonaws.chimesdkvoice#PhoneNumberName", + "traits": { + "smithy.api#documentation": "Specifies the name assigned to one or more phone numbers.
" + } } }, "traits": { @@ -9767,6 +9796,12 @@ "traits": { "smithy.api#documentation": "The outbound calling name to update.
" } + }, + "Name": { + "target": "com.amazonaws.chimesdkvoice#PhoneNumberName", + "traits": { + "smithy.api#documentation": "The name of the phone number.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/cloud9.2017-09-23.json b/codegen/sdk-codegen/aws-models/cloud9.2017-09-23.json index f50b8d9575b..709acb86ff5 100644 --- a/codegen/sdk-codegen/aws-models/cloud9.2017-09-23.json +++ b/codegen/sdk-codegen/aws-models/cloud9.2017-09-23.json @@ -1194,7 +1194,7 @@ "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.\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.
\nThe default Amazon Linux AMI is currently used if the parameter isn't explicitly assigned\n a value in the request.
\nIn the future the parameter for Amazon Linux will no longer be available when you specify\n an AMI for your instance. Amazon Linux 2 will then become the default AMI, which is used to\n launch your instance if no parameter is explicitly defined.
\n\n AMI aliases \n
\n\n Amazon Linux (default):\n amazonlinux-1-x86_64\n \n
Amazon Linux 2: amazonlinux-2-x86_64\n
Ubuntu 18.04: ubuntu-18.04-x86_64\n
\n SSM paths\n
\n\n Amazon Linux (default):\n resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64\n \n
Amazon Linux 2:\n resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64\n
Ubuntu 18.04:\n resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64\n
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.
\nThe default Amazon Linux AMI is currently used if the parameter isn't explicitly assigned\n a value in the request. Because Amazon Linux AMI has ended standard support as of December 31,\n 2020, we recommend you choose Amazon Linux 2, which includes long term support through\n 2023.
\nFrom December 31, 2023, the parameter for Amazon Linux will no longer be available when\n you specify an AMI for your instance. Amazon Linux 2 will then become the default AMI, which\n is used to launch your instance if no parameter is explicitly defined.
\n\n AMI aliases \n
\n\n Amazon Linux (default):\n amazonlinux-1-x86_64\n \n
Amazon Linux 2: amazonlinux-2-x86_64\n
Ubuntu 18.04: ubuntu-18.04-x86_64\n
\n SSM paths\n
\n\n Amazon Linux (default):\n resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64\n \n
Amazon Linux 2:\n resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64\n
Ubuntu 18.04:\n resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64\n
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the environment that was created.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloud9#CreateEnvironmentMembership": { @@ -1300,6 +1306,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloud9#CreateEnvironmentMembershipResult": { @@ -1312,6 +1321,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloud9#DeleteEnvironment": { @@ -1403,11 +1415,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloud9#DeleteEnvironmentMembershipResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.cloud9#DeleteEnvironmentRequest": { "type": "structure", @@ -1419,11 +1437,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloud9#DeleteEnvironmentResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.cloud9#DescribeEnvironmentMemberships": { "type": "operation", @@ -1498,6 +1522,9 @@ "smithy.api#documentation": "The maximum number of environment members to get information about.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloud9#DescribeEnvironmentMembershipsResult": { @@ -1515,6 +1542,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloud9#DescribeEnvironmentStatus": { @@ -1562,6 +1592,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloud9#DescribeEnvironmentStatusResult": { @@ -1581,6 +1614,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloud9#DescribeEnvironments": { @@ -1628,6 +1664,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloud9#DescribeEnvironmentsResult": { @@ -1639,6 +1678,9 @@ "smithy.api#documentation": "Information about the environments that are returned.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloud9#Environment": { @@ -2065,6 +2107,9 @@ "smithy.api#documentation": "The maximum number of environments to get identifiers for.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloud9#ListEnvironmentsResult": { @@ -2082,6 +2127,9 @@ "smithy.api#documentation": "The list of environment identifiers.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloud9#ListTagsForResource": { @@ -2117,6 +2165,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloud9#ListTagsForResourceResponse": { @@ -2128,6 +2179,9 @@ "smithy.api#documentation": "The list of tags associated with the Cloud9 development environment.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloud9#ManagedCredentialsAction": { @@ -2412,11 +2466,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloud9#TagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.cloud9#TagValue": { "type": "string", @@ -2495,11 +2555,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloud9#UntagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.cloud9#UpdateEnvironment": { "type": "operation", @@ -2597,6 +2663,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloud9#UpdateEnvironmentMembershipResult": { @@ -2608,6 +2677,9 @@ "smithy.api#documentation": "Information about the environment member whose settings were changed.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloud9#UpdateEnvironmentRequest": { @@ -2638,11 +2710,17 @@ "smithy.api#documentation": "Allows the environment owner to turn on or turn off the Amazon Web Services managed temporary\n credentials for an Cloud9 environment by using one of the following values:
\n\n ENABLE\n
\n DISABLE\n
Only the environment owner can change the status of managed temporary credentials. An AccessDeniedException is thrown if an attempt to turn on or turn off managed temporary credentials is made by an account that's not the environment\n owner.
A field in a CloudTrail event record on which to filter events to be logged. For\n event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for\n selecting events as filtering is not supported.
\n For CloudTrail event records, supported fields include readOnly,\n eventCategory, eventSource (for management events),\n eventName, resources.type, and resources.ARN.
For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the only supported field is\n eventCategory.
\n \n readOnly\n - Optional. Can be set to\n Equals a value of true or false. If you do\n not add this field, CloudTrail logs both read and\n write events. A value of true logs only\n read events. A value of false logs only\n write events.
\n \n eventSource\n - For filtering\n management events only. This can be set only to NotEquals\n kms.amazonaws.com.
\n \n eventName\n - Can use any operator.\n You can use it to filter in or filter out any data event logged to CloudTrail,\n such as PutBucket or GetSnapshotBlock. You can have\n multiple values for this field, separated by commas.
\n \n eventCategory\n - This is required and\n must be set to Equals. \n
\n For CloudTrail event records, the value\n must be Management or Data. \n
\n For Config\n configuration items, the value must be ConfigurationItem.\n
\n For Audit Manager evidence, the value must be Evidence.\n
\n For non-Amazon Web Services events, the value must be ActivityAuditLog.\n
\n \n resources.type\n - This field is\n required for CloudTrail data events. resources.type can only\n use the Equals operator, and the value can be one of the\n following:
\n AWS::DynamoDB::Table\n
\n AWS::Lambda::Function\n
\n AWS::S3::Object\n
\n AWS::CloudTrail::Channel\n
\n AWS::CodeWhisperer::Profile\n
\n AWS::Cognito::IdentityPool\n
\n AWS::DynamoDB::Stream\n
\n AWS::EC2::Snapshot\n
\n AWS::EMRWAL::Workspace\n
\n AWS::FinSpace::Environment\n
\n AWS::Glue::Table\n
\n AWS::GuardDuty::Detector\n
\n AWS::KendraRanking::ExecutionPlan\n
\n AWS::ManagedBlockchain::Node\n
\n AWS::SageMaker::ExperimentTrialComponent\n
\n AWS::SageMaker::FeatureGroup\n
\n AWS::S3::AccessPoint\n
\n AWS::S3ObjectLambda::AccessPoint\n
\n AWS::S3Outposts::Object\n
You can have only one resources.type field per selector. To log data\n events on more than one resource type, add another selector.
\n \n resources.ARN\n - You can use any\n operator with resources.ARN, but if you use Equals or\n NotEquals, the value must exactly match the ARN of a valid resource\n of the type you've specified in the template as the value of resources.type. For\n example, if resources.type equals AWS::S3::Object, the ARN must be in\n one of the following formats. To log all data events for all objects in a specific S3\n bucket, use the StartsWith operator, and include only the bucket ARN as\n the matching value.
The trailing slash is intentional; do not exclude it. Replace the text between\n less than and greater than symbols (<>) with resource-specific information.
\n\n arn:\n
\n arn:\n
When resources.type equals AWS::DynamoDB::Table, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::Lambda::Function, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::CloudTrail::Channel, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::CodeWhisperer::Profile, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::Cognito::IdentityPool, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::DynamoDB::Stream, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
When resources.type equals AWS::EC2::Snapshot, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::EMRWAL::Workspace, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::FinSpace::Environment,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::Glue::Table, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::GuardDuty::Detector, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::KendraRanking::ExecutionPlan, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::ManagedBlockchain::Node,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::SageMaker::ExperimentTrialComponent, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::SageMaker::FeatureGroup, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::S3::AccessPoint, and the\n operator is set to Equals or NotEquals, the ARN must be in\n one of the following formats. To log events on all objects in an S3 access point, we\n recommend that you use only the access point ARN, don’t include the object path, and\n use the StartsWith or NotStartsWith operators.
\n arn:\n
\n arn:\n
When resources.type equals\n AWS::S3ObjectLambda::AccessPoint, and the operator is set to\n Equals or NotEquals, the ARN must be in the following\n format:
\n arn:\n
When resources.type equals AWS::S3Outposts::Object, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
A field in a CloudTrail event record on which to filter events to be logged. For\n event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for\n selecting events as filtering is not supported.
\n For CloudTrail event records, supported fields include readOnly,\n eventCategory, eventSource (for management events),\n eventName, resources.type, and resources.ARN.
For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the only supported field is\n eventCategory.
\n \n readOnly\n - Optional. Can be set to\n Equals a value of true or false. If you do\n not add this field, CloudTrail logs both read and\n write events. A value of true logs only\n read events. A value of false logs only\n write events.
\n \n eventSource\n - For filtering\n management events only. This can be set only to NotEquals\n kms.amazonaws.com.
\n \n eventName\n - Can use any operator.\n You can use it to filter in or filter out any data event logged to CloudTrail,\n such as PutBucket or GetSnapshotBlock. You can have\n multiple values for this field, separated by commas.
\n \n eventCategory\n - This is required and\n must be set to Equals. \n
\n For CloudTrail event records, the value\n must be Management or Data. \n
\n For Config\n configuration items, the value must be ConfigurationItem.\n
\n For Audit Manager evidence, the value must be Evidence.\n
\n For non-Amazon Web Services events, the value must be ActivityAuditLog.\n
\n \n resources.type\n - This field is\n required for CloudTrail data events. resources.type can only\n use the Equals operator, and the value can be one of the\n following:
\n AWS::DynamoDB::Table\n
\n AWS::Lambda::Function\n
\n AWS::S3::Object\n
\n AWS::CloudTrail::Channel\n
\n AWS::CodeWhisperer::Profile\n
\n AWS::Cognito::IdentityPool\n
\n AWS::DynamoDB::Stream\n
\n AWS::EC2::Snapshot\n
\n AWS::EMRWAL::Workspace\n
\n AWS::FinSpace::Environment\n
\n AWS::Glue::Table\n
\n AWS::GuardDuty::Detector\n
\n AWS::KendraRanking::ExecutionPlan\n
\n AWS::ManagedBlockchain::Network\n
\n AWS::ManagedBlockchain::Node\n
\n AWS::MedicalImaging::Datastore\n
\n AWS::SageMaker::ExperimentTrialComponent\n
\n AWS::SageMaker::FeatureGroup\n
\n AWS::S3::AccessPoint\n
\n AWS::S3ObjectLambda::AccessPoint\n
\n AWS::S3Outposts::Object\n
\n AWS::SSMMessages::ControlChannel\n
\n AWS::VerifiedPermissions::PolicyStore\n
You can have only one resources.type field per selector. To log data\n events on more than one resource type, add another selector.
\n \n resources.ARN\n - You can use any\n operator with resources.ARN, but if you use Equals or\n NotEquals, the value must exactly match the ARN of a valid resource\n of the type you've specified in the template as the value of resources.type. For\n example, if resources.type equals AWS::S3::Object, the ARN must be in\n one of the following formats. To log all data events for all objects in a specific S3\n bucket, use the StartsWith operator, and include only the bucket ARN as\n the matching value.
The trailing slash is intentional; do not exclude it. Replace the text between\n less than and greater than symbols (<>) with resource-specific information.
\n\n arn:\n
\n arn:\n
When resources.type equals AWS::DynamoDB::Table, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::Lambda::Function, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::CloudTrail::Channel, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::CodeWhisperer::Profile, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::Cognito::IdentityPool, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::DynamoDB::Stream, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
When resources.type equals AWS::EC2::Snapshot, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::EMRWAL::Workspace, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::FinSpace::Environment,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::Glue::Table, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::GuardDuty::Detector, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::KendraRanking::ExecutionPlan, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::ManagedBlockchain::Network,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::ManagedBlockchain::Node,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::MedicalImaging::Datastore,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::SageMaker::ExperimentTrialComponent, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::SageMaker::FeatureGroup, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::S3::AccessPoint, and the\n operator is set to Equals or NotEquals, the ARN must be in\n one of the following formats. To log events on all objects in an S3 access point, we\n recommend that you use only the access point ARN, don’t include the object path, and\n use the StartsWith or NotStartsWith operators.
\n arn:\n
\n arn:\n
When resources.type equals\n AWS::S3ObjectLambda::AccessPoint, and the operator is set to\n Equals or NotEquals, the ARN must be in the following\n format:
\n arn:\n
When resources.type equals AWS::S3Outposts::Object, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
When resources.type equals AWS::SSMMessages::ControlChannel, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
When resources.type equals AWS::VerifiedPermissions::PolicyStore, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
The retention period of the event data store, in days. You can set a retention period of\n up to 2557 days, the equivalent of seven years.
" + "smithy.api#documentation": "The retention period of the event data store, in days. You can set a retention period of\n up to 2557 days, the equivalent of seven years. CloudTrail Lake determines whether to retain an event by checking if the eventTime \n of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events \n when the eventTime is older than 90 days.
If you plan to copy trail events to this event data store, we recommend \n that you consider both the age of the events that you\n want to copy as well as how long you want to keep the copied events\n in your event data store. For example, if you copy trail events that are 5 years old \n and specify a retention period of 7 years, the event data store \n will retain those events for two years.
\nThe resource type in which you want to log data events. You can specify the following\n basic event selector resource types:
\n\n AWS::DynamoDB::Table\n
\n AWS::Lambda::Function\n
\n AWS::S3::Object\n
The following resource types are also available through advanced\n event selectors. Basic event selector resource types are valid in advanced event selectors,\n but advanced event selector resource types are not valid in basic event selectors. For more\n information, see AdvancedFieldSelector.
\n\n AWS::CloudTrail::Channel\n
\n AWS::CodeWhisperer::Profile\n
\n AWS::Cognito::IdentityPool\n
\n AWS::DynamoDB::Stream\n
\n AWS::EC2::Snapshot\n
\n AWS::EMRWAL::Workspace\n
\n AWS::FinSpace::Environment\n
\n AWS::Glue::Table\n
\n AWS::GuardDuty::Detector\n
\n AWS::KendraRanking::ExecutionPlan\n
\n AWS::ManagedBlockchain::Node\n
\n AWS::SageMaker::ExperimentTrialComponent\n
\n AWS::SageMaker::FeatureGroup\n
\n AWS::S3::AccessPoint\n
\n AWS::S3ObjectLambda::AccessPoint\n
\n AWS::S3Outposts::Object\n
The resource type in which you want to log data events. You can specify the following\n basic event selector resource types:
\n\n AWS::DynamoDB::Table\n
\n AWS::Lambda::Function\n
\n AWS::S3::Object\n
The following resource types are also available through advanced\n event selectors. Basic event selector resource types are valid in advanced event selectors,\n but advanced event selector resource types are not valid in basic event selectors. For more\n information, see AdvancedFieldSelector.
\n\n AWS::CloudTrail::Channel\n
\n AWS::CodeWhisperer::Profile\n
\n AWS::Cognito::IdentityPool\n
\n AWS::DynamoDB::Stream\n
\n AWS::EC2::Snapshot\n
\n AWS::EMRWAL::Workspace\n
\n AWS::FinSpace::Environment\n
\n AWS::Glue::Table\n
\n AWS::GuardDuty::Detector\n
\n AWS::KendraRanking::ExecutionPlan\n
\n AWS::ManagedBlockchain::Network\n
\n AWS::ManagedBlockchain::Node\n
\n AWS::MedicalImaging::Datastore\n
\n AWS::SageMaker::ExperimentTrialComponent\n
\n AWS::SageMaker::FeatureGroup\n
\n AWS::S3::AccessPoint\n
\n AWS::S3ObjectLambda::AccessPoint\n
\n AWS::S3Outposts::Object\n
\n AWS::SSMMessages::ControlChannel\n
\n AWS::VerifiedPermissions::PolicyStore\n
You are already running the maximum number of concurrent queries. Wait a minute for some\n queries to finish, and then run the query again.
", + "smithy.api#documentation": "You are already running the maximum number of concurrent queries. The maximum number of concurrent queries is 10. Wait a minute for some\n queries to finish, and then run the query again.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -8916,7 +8880,7 @@ "RetentionPeriod": { "target": "com.amazonaws.cloudtrail#RetentionPeriod", "traits": { - "smithy.api#documentation": "The retention period, in days.
" + "smithy.api#documentation": "The retention period of the event data store, in days. You can set a retention period of\n up to 2557 days, the equivalent of seven years. CloudTrail Lake determines whether to retain an event by checking if the eventTime \n of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events \n when the eventTime is older than 90 days.
If you decrease the retention period of an event data store, CloudTrail will remove any events with an eventTime older than the new retention period. For example, if the previous \n retention period was 365 days and you decrease it to 100 days, CloudTrail will remove events with an eventTime older than 100 days.
Information about traffic distributions.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The distribution of agents between the instance and its replica(s).
" + } + }, "com.amazonaws.connect#AgentContactReference": { "type": "structure", "members": { @@ -598,6 +630,9 @@ { "target": "com.amazonaws.connect#AssociateSecurityKey" }, + { + "target": "com.amazonaws.connect#AssociateTrafficDistributionGroupUser" + }, { "target": "com.amazonaws.connect#ClaimPhoneNumber" }, @@ -814,6 +849,9 @@ { "target": "com.amazonaws.connect#DisassociateSecurityKey" }, + { + "target": "com.amazonaws.connect#DisassociateTrafficDistributionGroupUser" + }, { "target": "com.amazonaws.connect#DismissUserContact" }, @@ -940,6 +978,9 @@ { "target": "com.amazonaws.connect#ListTrafficDistributionGroups" }, + { + "target": "com.amazonaws.connect#ListTrafficDistributionGroupUsers" + }, { "target": "com.amazonaws.connect#ListUseCases" }, @@ -1108,6 +1149,9 @@ { "target": "com.amazonaws.connect#UpdateQuickConnectName" }, + { + "target": "com.amazonaws.connect#UpdateRoutingProfileAgentAvailabilityTimer" + }, { "target": "com.amazonaws.connect#UpdateRoutingProfileConcurrency" }, @@ -1228,52 +1272,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -1281,13 +1329,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -1297,92 +1354,83 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://connect-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://connect-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] } ], @@ -1391,155 +1439,115 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, + "aws-us-gov", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] } ] } ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws-us-gov", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://connect.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://connect-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] + "endpoint": { + "url": "https://connect.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://connect-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://connect.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://connect.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://connect.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://connect.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -2714,6 +2722,81 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#AssociateTrafficDistributionGroupUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociateTrafficDistributionGroupUserRequest" + }, + "output": { + "target": "com.amazonaws.connect#AssociateTrafficDistributionGroupUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Associates an agent with a traffic distribution group.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/traffic-distribution-group/{TrafficDistributionGroupId}/user", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connect#AssociateTrafficDistributionGroupUserRequest": { + "type": "structure", + "members": { + "TrafficDistributionGroupId": { + "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "The identifier of the user account. This can be the ID or the ARN of the user.
", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#AssociateTrafficDistributionGroupUserResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#AssociationId": { "type": "string", "traits": { @@ -5212,6 +5295,12 @@ "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } + }, + "AgentAvailabilityTimer": { + "target": "com.amazonaws.connect#AgentAvailabilityTimer", + "traits": { + "smithy.api#documentation": "Whether agents with this routing profile will have their routing order calculated based on\n longest idle time or time since their last inbound\n contact.
" + } } }, "traits": { @@ -5697,7 +5786,7 @@ "Id": { "target": "com.amazonaws.connect#TrafficDistributionGroupId", "traits": { - "smithy.api#documentation": "The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.
" + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
" } }, "Arn": { @@ -7439,7 +7528,7 @@ "TrafficDistributionGroupId": { "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", "traits": { - "smithy.api#documentation": "The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.
", + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8995,7 +9084,7 @@ "TrafficDistributionGroupId": { "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", "traits": { - "smithy.api#documentation": "The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.
", + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9916,24 +10005,85 @@ "smithy.api#input": {} } }, - "com.amazonaws.connect#DisassociateSecurityKey": { + "com.amazonaws.connect#DisassociateSecurityKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DisassociateSecurityKeyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nDeletes the specified security key.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/instance/{InstanceId}/security-key/{AssociationId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DisassociateSecurityKeyRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssociationId": { + "target": "com.amazonaws.connect#AssociationId", + "traits": { + "smithy.api#documentation": "The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#DisassociateTrafficDistributionGroupUser": { "type": "operation", "input": { - "target": "com.amazonaws.connect#DisassociateSecurityKeyRequest" + "target": "com.amazonaws.connect#DisassociateTrafficDistributionGroupUserRequest" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.connect#DisassociateTrafficDistributionGroupUserResponse" }, "errors": [ { - "target": "com.amazonaws.connect#InternalServiceException" + "target": "com.amazonaws.connect#AccessDeniedException" }, { - "target": "com.amazonaws.connect#InvalidParameterException" + "target": "com.amazonaws.connect#InternalServiceException" }, { "target": "com.amazonaws.connect#InvalidRequestException" }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, { "target": "com.amazonaws.connect#ResourceNotFoundException" }, @@ -9942,30 +10092,39 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nDeletes the specified security key.
", + "smithy.api#documentation": "Disassociates an agent from a traffic distribution group.
", "smithy.api#http": { "method": "DELETE", - "uri": "/instance/{InstanceId}/security-key/{AssociationId}", + "uri": "/traffic-distribution-group/{TrafficDistributionGroupId}/user", "code": 200 - } + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.connect#DisassociateSecurityKeyRequest": { + "com.amazonaws.connect#DisassociateTrafficDistributionGroupUserRequest": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", + "TrafficDistributionGroupId": { + "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AssociationId": { - "target": "com.amazonaws.connect#AssociationId", + "UserId": { + "target": "com.amazonaws.connect#UserId", "traits": { - "smithy.api#documentation": "The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The identifier for the user. This can be the ID or the ARN of the user.
", + "smithy.api#httpQuery": "UserId", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "smithy.api#httpQuery": "InstanceId", "smithy.api#required": {} } } @@ -9974,6 +10133,13 @@ "smithy.api#input": {} } }, + "com.amazonaws.connect#DisassociateTrafficDistributionGroupUserResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#DismissUserContact": { "type": "operation", "input": { @@ -11971,7 +12137,7 @@ "UserId": { "target": "com.amazonaws.connect#AgentResourceId", "traits": { - "smithy.api#documentation": "The identifier for the user.
" + "smithy.api#documentation": "The identifier for the user. This can be the ID or the ARN of the user.
" } } }, @@ -12180,7 +12346,7 @@ "Metrics": { "target": "com.amazonaws.connect#MetricsV2", "traits": { - "smithy.api#documentation": "The metrics to retrieve. Specify the name, groupings, and filters 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's\n Guide.
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Percentage
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational analytics.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Valid metric filter key: DISCONNECT_REASON\n
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThe metrics to retrieve. Specify the name, groupings, and filters 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's\n Guide.
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Percentage
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Valid metric filter key: DISCONNECT_REASON\n
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThe identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.
" + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
" } }, "Arn": { @@ -12518,6 +12684,18 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the traffic distribution group.
" } + }, + "SignInConfig": { + "target": "com.amazonaws.connect#SignInConfig", + "traits": { + "smithy.api#documentation": "The distribution of allowing signing in to the instance and its replica(s).
" + } + }, + "AgentConfig": { + "target": "com.amazonaws.connect#AgentConfig", + "traits": { + "smithy.api#documentation": "The distribution of agents between the instance and its replica(s).
" + } } }, "traits": { @@ -16031,7 +16209,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided\n TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions\n associated with traffic distribution group.
For more information about phone numbers, see Set Up Phone Numbers for Your\n Contact Center in the Amazon Connect Administrator\n Guide.
", + "smithy.api#documentation": "Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided\n TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions\n associated with traffic distribution group.
For more information about phone numbers, see Set Up Phone Numbers for Your\n Contact Center in the Amazon Connect Administrator\n Guide.
\nWhen given an instance ARN, ListPhoneNumbersV2 returns only the phone\n numbers claimed to the instance.
When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers\n claimed to the traffic distribution group.
Lists traffic distribution group users.
", + "smithy.api#http": { + "method": "GET", + "uri": "/traffic-distribution-group/{TrafficDistributionGroupId}/user", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrafficDistributionGroupUserSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListTrafficDistributionGroupUsersRequest": { + "type": "structure", + "members": { + "TrafficDistributionGroupId": { + "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult10", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "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" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#ListTrafficDistributionGroupUsersResponse": { + "type": "structure", + "members": { + "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.
" + } + }, + "TrafficDistributionGroupUserSummaryList": { + "target": "com.amazonaws.connect#TrafficDistributionGroupUserSummaryList", + "traits": { + "smithy.api#documentation": "A list of traffic distribution group users.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#ListTrafficDistributionGroups": { "type": "operation", "input": { @@ -21714,6 +21983,12 @@ "traits": { "smithy.api#documentation": "The number of associated users in routing profile.
" } + }, + "AgentAvailabilityTimer": { + "target": "com.amazonaws.connect#AgentAvailabilityTimer", + "traits": { + "smithy.api#documentation": "Whether agents with this routing profile will have their routing order calculated based on\n time since their last inbound contact or longest idle\n time.
" + } } }, "traits": { @@ -23666,6 +23941,50 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.connect#SignInConfig": { + "type": "structure", + "members": { + "Distributions": { + "target": "com.amazonaws.connect#SignInDistributionList", + "traits": { + "smithy.api#documentation": "Information about traffic distributions.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The distribution of allowing signing in to the instance and its replica(s).
" + } + }, + "com.amazonaws.connect#SignInDistribution": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.connect#AwsRegion", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region of the sign in distribution.
", + "smithy.api#required": {} + } + }, + "Enabled": { + "target": "com.amazonaws.connect#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Whether sign in distribution is enabled.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The distribution of sign in traffic between the instance and its replica(s).
" + } + }, + "com.amazonaws.connect#SignInDistributionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#SignInDistribution" + } + }, "com.amazonaws.connect#SingleSelectOptions": { "type": "list", "member": { @@ -25677,7 +25996,7 @@ "Id": { "target": "com.amazonaws.connect#TrafficDistributionGroupId", "traits": { - "smithy.api#documentation": "The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.
" + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
" } }, "Arn": { @@ -25715,6 +26034,13 @@ "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } + }, + "IsDefault": { + "target": "com.amazonaws.connect#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Whether this is the default traffic distribution group created during instance\n replication. The default traffic distribution group cannot be deleted by the\n DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as\n part of the process for deleting a replica.
You can change the SignInConfig only for a default TrafficDistributionGroup. If you call\n UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup,\n an InvalidRequestException is returned.
The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.
" + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
" } }, "Arn": { @@ -25812,6 +26138,13 @@ "traits": { "smithy.api#documentation": "The status of the traffic distribution group.
\n\n CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet\n completed.
\n ACTIVE means the previous CreateTrafficDistributionGroup operation has succeeded.
\n CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation has failed.
\n PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet\n completed.
\n DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed.
\n UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet\n completed.
Whether this is the default traffic distribution group created during instance\n replication. The default traffic distribution group cannot be deleted by the\n DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as\n part of the process for deleting a replica.
The identifier for the user. This can be the ID or the ARN of the user.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about a traffic distribution group user.
" + } + }, + "com.amazonaws.connect#TrafficDistributionGroupUserSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#TrafficDistributionGroupUserSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, "com.amazonaws.connect#TrafficType": { "type": "enum", "members": { @@ -25913,7 +26272,7 @@ "UserId": { "target": "com.amazonaws.connect#AgentResourceId", "traits": { - "smithy.api#documentation": "The identifier for the user.
" + "smithy.api#documentation": "The identifier for the user. This can be the ID or the ARN of the user.
" } }, "ContactFlowId": { @@ -27989,6 +28348,71 @@ "smithy.api#input": {} } }, + "com.amazonaws.connect#UpdateRoutingProfileAgentAvailabilityTimer": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateRoutingProfileAgentAvailabilityTimerRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Whether agents with this routing profile will have their routing order calculated based on\n time since their last inbound contact or longest idle\n time.
", + "smithy.api#http": { + "method": "POST", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/agent-availability-timer", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateRoutingProfileAgentAvailabilityTimerRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "The identifier of the routing profile.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AgentAvailabilityTimer": { + "target": "com.amazonaws.connect#AgentAvailabilityTimer", + "traits": { + "smithy.api#documentation": "Whether agents with this routing profile will have their routing order calculated based on\n time since their last inbound contact or longest idle\n time.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.connect#UpdateRoutingProfileConcurrency": { "type": "operation", "input": { @@ -28640,7 +29064,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the traffic distribution for a given traffic distribution group.
\nFor more information about updating a traffic distribution group, see Update telephony\n traffic distribution across Amazon Web Services Regions\n in the Amazon Connect Administrator Guide.
", + "smithy.api#documentation": "Updates the traffic distribution for a given traffic distribution group.
\nYou can change the SignInConfig only for a default TrafficDistributionGroup. If you call\n UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup,\n an InvalidRequestException is returned.
For more information about updating a traffic distribution group, see Update telephony\n traffic distribution across Amazon Web Services Regions\n in the Amazon Connect Administrator Guide.
", "smithy.api#http": { "method": "PUT", "uri": "/traffic-distribution/{Id}", @@ -28654,7 +29078,7 @@ "Id": { "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", "traits": { - "smithy.api#documentation": "The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.
", + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -28664,6 +29088,18 @@ "traits": { "smithy.api#documentation": "The distribution of traffic between the instance and its replica(s).
" } + }, + "SignInConfig": { + "target": "com.amazonaws.connect#SignInConfig", + "traits": { + "smithy.api#documentation": "The distribution of allowing signing in to the instance and its replica(s).
" + } + }, + "AgentConfig": { + "target": "com.amazonaws.connect#AgentConfig", + "traits": { + "smithy.api#documentation": "The distribution of agents between the instance and its replica(s).
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/database-migration-service.2016-01-01.json b/codegen/sdk-codegen/aws-models/database-migration-service.2016-01-01.json index 68c69bf0aea..bcd6926bc86 100644 --- a/codegen/sdk-codegen/aws-models/database-migration-service.2016-01-01.json +++ b/codegen/sdk-codegen/aws-models/database-migration-service.2016-01-01.json @@ -95,7 +95,23 @@ } ], "traits": { - "smithy.api#documentation": "Adds metadata tags to an DMS resource, including replication instance, endpoint,\n subnet group, and migration task. These tags can also be used with cost allocation\n reporting to track cost associated with DMS resources, or used in a Condition statement in\n an IAM policy for DMS. For more information, see \n Tag\n data type description.
Adds metadata tags to an DMS resource, including replication instance, endpoint,\n subnet group, and migration task. These tags can also be used with cost allocation\n reporting to track cost associated with DMS resources, or used in a Condition statement in\n an IAM policy for DMS. For more information, see \n Tag\n data type description.
Associates a set of tags with an DMS resource.
" + "smithy.api#documentation": "Associates a set of tags with an DMS resource.
", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#AddTagsToResourceResponse": { @@ -144,6 +161,9 @@ { "target": "com.amazonaws.databasemigrationservice#CancelReplicationTaskAssessmentRun" }, + { + "target": "com.amazonaws.databasemigrationservice#CreateDataProvider" + }, { "target": "com.amazonaws.databasemigrationservice#CreateEndpoint" }, @@ -153,6 +173,12 @@ { "target": "com.amazonaws.databasemigrationservice#CreateFleetAdvisorCollector" }, + { + "target": "com.amazonaws.databasemigrationservice#CreateInstanceProfile" + }, + { + "target": "com.amazonaws.databasemigrationservice#CreateMigrationProject" + }, { "target": "com.amazonaws.databasemigrationservice#CreateReplicationConfig" }, @@ -171,6 +197,9 @@ { "target": "com.amazonaws.databasemigrationservice#DeleteConnection" }, + { + "target": "com.amazonaws.databasemigrationservice#DeleteDataProvider" + }, { "target": "com.amazonaws.databasemigrationservice#DeleteEndpoint" }, @@ -183,6 +212,12 @@ { "target": "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorDatabases" }, + { + "target": "com.amazonaws.databasemigrationservice#DeleteInstanceProfile" + }, + { + "target": "com.amazonaws.databasemigrationservice#DeleteMigrationProject" + }, { "target": "com.amazonaws.databasemigrationservice#DeleteReplicationConfig" }, @@ -210,6 +245,12 @@ { "target": "com.amazonaws.databasemigrationservice#DescribeConnections" }, + { + "target": "com.amazonaws.databasemigrationservice#DescribeConversionConfiguration" + }, + { + "target": "com.amazonaws.databasemigrationservice#DescribeDataProviders" + }, { "target": "com.amazonaws.databasemigrationservice#DescribeEndpoints" }, @@ -231,6 +272,9 @@ { "target": "com.amazonaws.databasemigrationservice#DescribeEventSubscriptions" }, + { + "target": "com.amazonaws.databasemigrationservice#DescribeExtensionPackAssociations" + }, { "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorCollectors" }, @@ -246,6 +290,27 @@ { "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemas" }, + { + "target": "com.amazonaws.databasemigrationservice#DescribeInstanceProfiles" + }, + { + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelAssessments" + }, + { + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelConversions" + }, + { + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsAsScript" + }, + { + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsToTarget" + }, + { + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelImports" + }, + { + "target": "com.amazonaws.databasemigrationservice#DescribeMigrationProjects" + }, { "target": "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstances" }, @@ -297,18 +362,33 @@ { "target": "com.amazonaws.databasemigrationservice#DescribeTableStatistics" }, + { + "target": "com.amazonaws.databasemigrationservice#ExportMetadataModelAssessment" + }, { "target": "com.amazonaws.databasemigrationservice#ImportCertificate" }, { "target": "com.amazonaws.databasemigrationservice#ListTagsForResource" }, + { + "target": "com.amazonaws.databasemigrationservice#ModifyConversionConfiguration" + }, + { + "target": "com.amazonaws.databasemigrationservice#ModifyDataProvider" + }, { "target": "com.amazonaws.databasemigrationservice#ModifyEndpoint" }, { "target": "com.amazonaws.databasemigrationservice#ModifyEventSubscription" }, + { + "target": "com.amazonaws.databasemigrationservice#ModifyInstanceProfile" + }, + { + "target": "com.amazonaws.databasemigrationservice#ModifyMigrationProject" + }, { "target": "com.amazonaws.databasemigrationservice#ModifyReplicationConfig" }, @@ -342,6 +422,24 @@ { "target": "com.amazonaws.databasemigrationservice#RunFleetAdvisorLsaAnalysis" }, + { + "target": "com.amazonaws.databasemigrationservice#StartExtensionPackAssociation" + }, + { + "target": "com.amazonaws.databasemigrationservice#StartMetadataModelAssessment" + }, + { + "target": "com.amazonaws.databasemigrationservice#StartMetadataModelConversion" + }, + { + "target": "com.amazonaws.databasemigrationservice#StartMetadataModelExportAsScript" + }, + { + "target": "com.amazonaws.databasemigrationservice#StartMetadataModelExportToTarget" + }, + { + "target": "com.amazonaws.databasemigrationservice#StartMetadataModelImport" + }, { "target": "com.amazonaws.databasemigrationservice#StartRecommendations" }, @@ -447,52 +545,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -500,13 +602,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -516,92 +627,83 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://dms-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://dms-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] } ], @@ -610,205 +712,165 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, + "aws-us-gov", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] } ] } ], - "type": "tree", - "rules": [ + "endpoint": { + "url": "https://dms.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws-us-gov", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://dms.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws-iso", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://dms.{Region}.c2s.ic.gov", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, + "fn": "stringEquals", + "argv": [ + "aws-iso", { - "conditions": [ + "fn": "getAttr", + "argv": [ { - "fn": "stringEquals", - "argv": [ - "aws-iso-b", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://dms.{Region}.sc2s.sgov.gov", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://dms-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "ref": "PartitionResult" + }, + "name" + ] } ] } - ] + ], + "endpoint": { + "url": "https://dms.{Region}.c2s.ic.gov", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, + "aws-iso-b", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsDualStack" + "name" ] } ] } ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://dms.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] + "endpoint": { + "url": "https://dms.{Region}.sc2s.sgov.gov", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, { "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" + "endpoint": { + "url": "https://dms-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { "conditions": [], - "type": "tree", - "rules": [ - { + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { "conditions": [], "endpoint": { - "url": "https://dms.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://dms.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://dms.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -1548,7 +1610,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#ApplyPendingMaintenanceActionResponse": { @@ -1572,6 +1635,34 @@ "target": "com.amazonaws.databasemigrationservice#String" } }, + "com.amazonaws.databasemigrationservice#AssessmentReportType": { + "type": "enum", + "members": { + "PDF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pdf" + } + }, + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "csv" + } + } + } + }, + "com.amazonaws.databasemigrationservice#AssessmentReportTypesList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#AssessmentReportType" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.databasemigrationservice#AuthMechanismValue": { "type": "enum", "members": { @@ -1765,7 +1856,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#CancelReplicationTaskAssessmentRunResponse": { @@ -2245,6 +2337,83 @@ } } }, + "com.amazonaws.databasemigrationservice#CreateDataProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#CreateDataProviderMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#CreateDataProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "Creates a data provider using the provided settings. A data provider stores \n a data store type and location information about your database.
" + } + }, + "com.amazonaws.databasemigrationservice#CreateDataProviderMessage": { + "type": "structure", + "members": { + "DataProviderName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "A user-friendly name for the data provider.
" + } + }, + "Description": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "A user-friendly description of the data provider.
" + } + }, + "Engine": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The type of database engine for the data provider. Valid values include \"aurora\", \n \"aurora_postgresql\", \"mysql\", \"oracle\", \"postgres\", \n and \"sqlserver\". A value of \"aurora\" represents Amazon Aurora MySQL-Compatible Edition.
The settings in JSON format for a data provider.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.databasemigrationservice#TagList", + "traits": { + "smithy.api#documentation": "One or more tags to be assigned to the data provider.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#CreateDataProviderResponse": { + "type": "structure", + "members": { + "DataProvider": { + "target": "com.amazonaws.databasemigrationservice#DataProvider", + "traits": { + "smithy.api#documentation": "The data provider that was created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.databasemigrationservice#CreateEndpoint": { "type": "operation", "input": { @@ -2277,7 +2446,46 @@ } ], "traits": { - "smithy.api#documentation": "Creates an endpoint using the provided settings.
\nFor a MySQL source or target endpoint, don't explicitly specify the database using\n the DatabaseName request parameter on the CreateEndpoint API call.\n Specifying DatabaseName when you create a MySQL endpoint replicates all the\n task tables to this single database. For MySQL endpoints, you specify the database only when\n you specify the schema in the table-mapping rules of the DMS task.
Creates an endpoint using the provided settings.
\nFor a MySQL source or target endpoint, don't explicitly specify the database using\n the DatabaseName request parameter on the CreateEndpoint API call.\n Specifying DatabaseName when you create a MySQL endpoint replicates all the\n task tables to this single database. For MySQL endpoints, you specify the database only when\n you specify the schema in the table-mapping rules of the DMS task.
Creates a configuration that you can later provide to configure and start an DMS Serverless\n replication. You can also provide options to validate the configuration inputs before you start the\n replication.
" + "smithy.api#documentation": "Creates the instance profile using the specified parameters.
" } }, - "com.amazonaws.databasemigrationservice#CreateReplicationConfigMessage": { + "com.amazonaws.databasemigrationservice#CreateInstanceProfileMessage": { "type": "structure", "members": { - "ReplicationConfigIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "A unique identifier that you want to use to create a ReplicationConfigArn that is\n returned as part of the output from this action. You can then pass this output ReplicationConfigArn\n as the value of the ReplicationConfigArn option for other actions to identify both\n DMS Serverless replications and replication configurations that you want those actions to operate on.\n For some actions, you can also use either this unique identifier or a corresponding ARN in action filters to\n identify the specific replication and replication configuration to operate on.
The Amazon Resource Name (ARN) of the source endpoint for\n this DMS Serverless replication configuration.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Availability Zone where the instance profile will be created. The default\n value is a random, system-chosen Availability Zone in the Amazon Web Services Region where your \n data provider is created, for examplem us-east-1d.
The Amazon Resource Name (ARN) of the target endpoint for\n this DMS serverless replication configuration.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that is used to encrypt \n the connection parameters for the instance profile.
\nIf you don't specify a value for the KmsKeyArn parameter, then\n DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a\n different default encryption key for each Amazon Web Services Region.
" } }, - "ComputeConfig": { - "target": "com.amazonaws.databasemigrationservice#ComputeConfig", + "PubliclyAccessible": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "Configuration parameters for provisioning an DMS Serverless replication.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies the accessibility options for the instance profile. A value of\n true represents an instance profile with a public IP address. A value of\n false represents an instance profile with a private IP address. The default value\n is true.
The type of DMS Serverless replication to provision\n using this replication configuration.
\nPossible values:
\n\n \"full-load\"\n
\n \"cdc\"\n
\n \"full-load-and-cdc\"\n
One or more tags to be assigned to the instance profile.
" } }, - "TableMappings": { + "NetworkType": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "JSON table mappings for DMS Serverless replications that are provisioned\n using this replication configuration. For more information, see \n \n Specifying table selection and transformations rules using JSON.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies the network type for the instance profile. A value of IPV4 \n represents an instance profile with IPv4 network type and only supports IPv4 addressing. \n A value of IPV6 represents an instance profile with IPv6 network type \n and only supports IPv6 addressing. A value of DUAL represents an instance \n profile with dual network type that supports IPv4 and IPv6 addressing.
Optional JSON settings for DMS Serverless replications that are\n provisioned using this replication configuration. For example, see\n \n Change processing tuning settings.
" + "smithy.api#documentation": "A user-friendly name for the instance profile.
" } }, - "SupplementalSettings": { + "Description": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Optional JSON settings for specifying supplemental data. For more information, see\n \n Specifying supplemental data for task settings.
" + "smithy.api#documentation": "A user-friendly description of the instance profile.
" } }, - "ResourceIdentifier": { + "SubnetGroupIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Optional unique value or name that you set for a given resource\n that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see\n \n Fine-grained access control using resource names and tags.
" + "smithy.api#documentation": "A subnet group to associate with the instance profile.
" } }, - "Tags": { - "target": "com.amazonaws.databasemigrationservice#TagList", + "VpcSecurityGroups": { + "target": "com.amazonaws.databasemigrationservice#StringList", "traits": { - "smithy.api#documentation": "One or more optional tags associated with resources used by the DMS Serverless replication.\n For more information, see \n Tagging resources in Database Migration Service.
" + "smithy.api#documentation": "Specifies the VPC security group names to be used with the instance profile. \n The VPC security group must work with the VPC containing the instance profile.
" } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#CreateReplicationConfigResponse": { + "com.amazonaws.databasemigrationservice#CreateInstanceProfileResponse": { "type": "structure", "members": { - "ReplicationConfig": { - "target": "com.amazonaws.databasemigrationservice#ReplicationConfig", + "InstanceProfile": { + "target": "com.amazonaws.databasemigrationservice#InstanceProfile", "traits": { - "smithy.api#documentation": "Configuration parameters returned from the DMS Serverless replication after it is created.
" + "smithy.api#documentation": "The instance profile that was created.
" } } }, "traits": { - "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#CreateReplicationInstance": { + "com.amazonaws.databasemigrationservice#CreateMigrationProject": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#CreateReplicationInstanceMessage" + "target": "com.amazonaws.databasemigrationservice#CreateMigrationProjectMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#CreateReplicationInstanceResponse" + "target": "com.amazonaws.databasemigrationservice#CreateMigrationProjectResponse" }, "errors": [ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, - { - "target": "com.amazonaws.databasemigrationservice#InsufficientResourceCapacityFault" - }, - { - "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" - }, - { - "target": "com.amazonaws.databasemigrationservice#InvalidSubnet" - }, - { - "target": "com.amazonaws.databasemigrationservice#KMSKeyNotAccessibleFault" - }, - { - "target": "com.amazonaws.databasemigrationservice#ReplicationSubnetGroupDoesNotCoverEnoughAZs" - }, { "target": "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault" }, @@ -2887,149 +3069,110 @@ "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" }, { - "target": "com.amazonaws.databasemigrationservice#StorageQuotaExceededFault" + "target": "com.amazonaws.databasemigrationservice#S3AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#S3ResourceNotFoundFault" } ], "traits": { - "smithy.api#documentation": "Creates the replication instance using the specified parameters.
\nDMS requires that your account have certain roles with appropriate permissions\n before you can create a replication instance. For information on the required roles, see\n Creating the IAM Roles to Use With the CLI and DMS API. For\n information on the required permissions, see \n IAM Permissions Needed to Use DMS.
" + "smithy.api#documentation": "Creates the migration project using the specified parameters.
\nYou can run this action only after you create an instance profile and data providers \n using CreateInstanceProfile and CreateDataProvider.
" } }, - "com.amazonaws.databasemigrationservice#CreateReplicationInstanceMessage": { + "com.amazonaws.databasemigrationservice#CreateMigrationProjectMessage": { "type": "structure", "members": { - "ReplicationInstanceIdentifier": { + "MigrationProjectName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The replication instance identifier. This parameter is stored as a lowercase\n string.
\nConstraints:
\nMust contain 1-63 alphanumeric characters or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: myrepinstance\n
A user-friendly name for the migration project.
" + } + }, + "SourceDataProviderDescriptors": { + "target": "com.amazonaws.databasemigrationservice#DataProviderDescriptorDefinitionList", + "traits": { + "smithy.api#documentation": "Information about the source data provider, including the name, ARN, and Secrets Manager parameters.
", "smithy.api#required": {} } }, - "AllocatedStorage": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "TargetDataProviderDescriptors": { + "target": "com.amazonaws.databasemigrationservice#DataProviderDescriptorDefinitionList", "traits": { - "smithy.api#documentation": "The amount of storage (in gigabytes) to be initially allocated for the replication\n instance.
" + "smithy.api#documentation": "Information about the target data provider, including the name, ARN, and Amazon Web Services Secrets Manager parameters.
", + "smithy.api#required": {} } }, - "ReplicationInstanceClass": { + "InstanceProfileIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of the replication instance as defined for the specified\n replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\".
For more information on the settings and capacities for the available replication instance classes, see \n \n Choosing the right DMS replication instance; and, \n Selecting the best size for a replication instance.\n
", + "smithy.api#documentation": "The identifier of the associated instance profile. Identifiers must begin with a letter \n and must contain only ASCII letters, digits, and hyphens. They can't end with \n a hyphen, or contain two consecutive hyphens.
", "smithy.api#required": {} } }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.databasemigrationservice#VpcSecurityGroupIdList", + "TransformationRules": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Specifies the VPC security group to be used with the replication instance. The VPC\n security group must work with the VPC containing the replication instance.
" + "smithy.api#documentation": "The settings in JSON format for migration rules. Migration rules make it possible for you to change \n the object names according to the rules that you specify. For example, you can change an object name \n to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.
" } }, - "AvailabilityZone": { + "Description": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The Availability Zone where the replication instance will be created. The default\n value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, for\n example: us-east-1d.
A subnet group to associate with the replication instance.
" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).
\n Format: ddd:hh24:mi-ddd:hh24:mi\n
Default: A 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region,\n occurring on a random day of the week.
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
\nConstraints: Minimum 30-minute window.
" - } - }, - "MultiAZ": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": " Specifies whether the replication instance is a Multi-AZ deployment. You can't set the\n AvailabilityZone parameter if the Multi-AZ parameter is set to\n true.
The engine version number of the replication instance.
\nIf an engine version number is not specified when a replication \n instance is created, the default is the latest engine version available.
" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the\n replication instance during the maintenance window. This parameter defaults to\n true.
Default: true\n
When AutoMinorVersionUpgrade is enabled, DMS uses the current default\n engine version when you create a replication instance. For example, if you set\n EngineVersion to a lower version number than the current default version,\n DMS uses the default version.
If AutoMinorVersionUpgrade\n isn’t enabled when you create a replication instance, DMS uses the\n engine version specified by the EngineVersion parameter.
A user-friendly description of the migration project.
" } }, "Tags": { "target": "com.amazonaws.databasemigrationservice#TagList", "traits": { - "smithy.api#documentation": "One or more tags to be assigned to the replication instance.
" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "An KMS key identifier that is used to encrypt the data on the replication\n instance.
\nIf you don't specify a value for the KmsKeyId parameter, then\n DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a\n different default encryption key for each Amazon Web Services Region.
" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": " Specifies the accessibility options for the replication instance. A value of\n true represents an instance with a public IP address. A value of\n false represents an instance with a private IP address. The default value\n is true.
A list of custom DNS name servers supported for the replication instance to access your\n on-premise source or target database. This list overrides the default name servers\n supported by the replication instance. You can specify a comma-separated list of internet\n addresses for up to four on-premise DNS name servers. For example:\n \"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4\"\n
A friendly name for the resource identifier at the end of the EndpointArn\n response parameter that is returned in the created Endpoint object. The value\n for this parameter can have up to 31 characters. It can contain only ASCII letters, digits,\n and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens,\n and can only begin with a letter, such as Example-App-ARN1. For example, this\n value might result in the EndpointArn value\n arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't\n specify a ResourceIdentifier value, DMS generates a default identifier\n value for the end of EndpointArn.
One or more tags to be assigned to the migration project.
" } }, - "NetworkType": { - "target": "com.amazonaws.databasemigrationservice#String", + "SchemaConversionApplicationAttributes": { + "target": "com.amazonaws.databasemigrationservice#SCApplicationAttributes", "traits": { - "smithy.api#documentation": "The type of IP address protocol used by a replication instance, \n such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. \n IPv6 only is not yet supported.
" + "smithy.api#documentation": "The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
" } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#CreateReplicationInstanceResponse": { + "com.amazonaws.databasemigrationservice#CreateMigrationProjectResponse": { "type": "structure", "members": { - "ReplicationInstance": { - "target": "com.amazonaws.databasemigrationservice#ReplicationInstance", + "MigrationProject": { + "target": "com.amazonaws.databasemigrationservice#MigrationProject", "traits": { - "smithy.api#documentation": "The replication instance that was created.
" + "smithy.api#documentation": "The migration project that was created.
" } } }, "traits": { - "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroup": { + "com.amazonaws.databasemigrationservice#CreateReplicationConfig": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroupMessage" + "target": "com.amazonaws.databasemigrationservice#CreateReplicationConfigMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroupResponse" + "target": "com.amazonaws.databasemigrationservice#CreateReplicationConfigResponse" }, "errors": [ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, { "target": "com.amazonaws.databasemigrationservice#InvalidSubnet" }, + { + "target": "com.amazonaws.databasemigrationservice#KMSKeyNotAccessibleFault" + }, { "target": "com.amazonaws.databasemigrationservice#ReplicationSubnetGroupDoesNotCoverEnoughAZs" }, @@ -3044,51 +3187,91 @@ } ], "traits": { - "smithy.api#documentation": "Creates a replication subnet group given a list of the subnet IDs in a VPC.
\nThe VPC needs to have at least one subnet in at least two availability zones in the Amazon Web Services Region, otherwise the\n service will throw a ReplicationSubnetGroupDoesNotCoverEnoughAZs exception.
If a replication subnet group exists in your Amazon Web Services account, the CreateReplicationSubnetGroup action \n returns the following error message: The Replication Subnet Group already exists. In this case, delete \n the existing replication subnet group. To do so, use the DeleteReplicationSubnetGroup action. Optionally, choose Subnet groups in the DMS console, \n then choose your subnet group. Next, choose Delete from Actions.
" + "smithy.api#documentation": "Creates a configuration that you can later provide to configure and start an DMS Serverless\n replication. You can also provide options to validate the configuration inputs before you start the\n replication.
" } }, - "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroupMessage": { + "com.amazonaws.databasemigrationservice#CreateReplicationConfigMessage": { "type": "structure", "members": { - "ReplicationSubnetGroupIdentifier": { + "ReplicationConfigIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The name for the replication subnet group. This value is stored as a lowercase\n string.
\nConstraints: Must contain no more than 255 alphanumeric characters, periods, spaces,\n underscores, or hyphens. Must not be \"default\".
\nExample: mySubnetgroup\n
A unique identifier that you want to use to create a ReplicationConfigArn that is\n returned as part of the output from this action. You can then pass this output ReplicationConfigArn\n as the value of the ReplicationConfigArn option for other actions to identify both\n DMS Serverless replications and replication configurations that you want those actions to operate on.\n For some actions, you can also use either this unique identifier or a corresponding ARN in action filters to\n identify the specific replication and replication configuration to operate on.
The description for the subnet group.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source endpoint for\n this DMS Serverless replication configuration.
", "smithy.api#required": {} } }, - "SubnetIds": { - "target": "com.amazonaws.databasemigrationservice#SubnetIdentifierList", + "TargetEndpointArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "One or more subnet IDs to be assigned to the subnet group.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target endpoint for\n this DMS serverless replication configuration.
", + "smithy.api#required": {} + } + }, + "ComputeConfig": { + "target": "com.amazonaws.databasemigrationservice#ComputeConfig", + "traits": { + "smithy.api#documentation": "Configuration parameters for provisioning an DMS Serverless replication.
", + "smithy.api#required": {} + } + }, + "ReplicationType": { + "target": "com.amazonaws.databasemigrationservice#MigrationTypeValue", + "traits": { + "smithy.api#documentation": "The type of DMS Serverless replication to provision\n using this replication configuration.
\nPossible values:
\n\n \"full-load\"\n
\n \"cdc\"\n
\n \"full-load-and-cdc\"\n
JSON table mappings for DMS Serverless replications that are provisioned\n using this replication configuration. For more information, see \n \n Specifying table selection and transformations rules using JSON.
", "smithy.api#required": {} } }, + "ReplicationSettings": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Optional JSON settings for DMS Serverless replications that are\n provisioned using this replication configuration. For example, see\n \n Change processing tuning settings.
" + } + }, + "SupplementalSettings": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Optional JSON settings for specifying supplemental data. For more information, see\n \n Specifying supplemental data for task settings.
" + } + }, + "ResourceIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Optional unique value or name that you set for a given resource\n that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see\n \n Fine-grained access control using resource names and tags.
" + } + }, "Tags": { "target": "com.amazonaws.databasemigrationservice#TagList", "traits": { - "smithy.api#documentation": "One or more tags to be assigned to the subnet group.
" + "smithy.api#documentation": "One or more optional tags associated with resources used by the DMS Serverless replication.\n For more information, see \n Tagging resources in Database Migration Service.
" } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroupResponse": { + "com.amazonaws.databasemigrationservice#CreateReplicationConfigResponse": { "type": "structure", "members": { - "ReplicationSubnetGroup": { - "target": "com.amazonaws.databasemigrationservice#ReplicationSubnetGroup", + "ReplicationConfig": { + "target": "com.amazonaws.databasemigrationservice#ReplicationConfig", "traits": { - "smithy.api#documentation": "The replication subnet group that was created.
" + "smithy.api#documentation": "Configuration parameters returned from the DMS Serverless replication after it is created.
" } } }, @@ -3097,24 +3280,33 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#CreateReplicationTask": { + "com.amazonaws.databasemigrationservice#CreateReplicationInstance": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#CreateReplicationTaskMessage" + "target": "com.amazonaws.databasemigrationservice#CreateReplicationInstanceMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#CreateReplicationTaskResponse" + "target": "com.amazonaws.databasemigrationservice#CreateReplicationInstanceResponse" }, "errors": [ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, + { + "target": "com.amazonaws.databasemigrationservice#InsufficientResourceCapacityFault" + }, { "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidSubnet" + }, { "target": "com.amazonaws.databasemigrationservice#KMSKeyNotAccessibleFault" }, + { + "target": "com.amazonaws.databasemigrationservice#ReplicationSubnetGroupDoesNotCoverEnoughAZs" + }, { "target": "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault" }, @@ -3123,91 +3315,179 @@ }, { "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#StorageQuotaExceededFault" } ], "traits": { - "smithy.api#documentation": "Creates a replication task using the specified parameters.
" + "smithy.api#documentation": "Creates the replication instance using the specified parameters.
\nDMS requires that your account have certain roles with appropriate permissions\n before you can create a replication instance. For information on the required roles, see\n Creating the IAM Roles to Use With the CLI and DMS API. For\n information on the required permissions, see \n IAM Permissions Needed to Use DMS.
", + "smithy.api#examples": [ + { + "title": "Create replication instance", + "documentation": "Creates the replication instance using the specified parameters.", + "input": { + "ReplicationInstanceIdentifier": "", + "AllocatedStorage": 123, + "ReplicationInstanceClass": "", + "VpcSecurityGroupIds": [], + "AvailabilityZone": "", + "ReplicationSubnetGroupIdentifier": "", + "PreferredMaintenanceWindow": "", + "MultiAZ": true, + "EngineVersion": "", + "AutoMinorVersionUpgrade": true, + "Tags": [ + { + "Key": "string", + "Value": "string" + } + ], + "KmsKeyId": "", + "PubliclyAccessible": true + }, + "output": { + "ReplicationInstance": { + "PubliclyAccessible": true, + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationInstanceClass": "dms.t2.micro", + "ReplicationSubnetGroup": { + "ReplicationSubnetGroupDescription": "default", + "Subnets": [ + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-f6dd91af", + "SubnetAvailabilityZone": { + "Name": "us-east-1d" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-3605751d", + "SubnetAvailabilityZone": { + "Name": "us-east-1b" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-c2daefb5", + "SubnetAvailabilityZone": { + "Name": "us-east-1c" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-85e90cb8", + "SubnetAvailabilityZone": { + "Name": "us-east-1e" + } + } + ], + "VpcId": "vpc-6741a603", + "SubnetGroupStatus": "Complete", + "ReplicationSubnetGroupIdentifier": "default" + }, + "AutoMinorVersionUpgrade": true, + "ReplicationInstanceStatus": "creating", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "AllocatedStorage": 5, + "EngineVersion": "1.5.0", + "ReplicationInstanceIdentifier": "test-rep-1", + "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", + "PendingModifiedValues": {} + } + } + } + ] } }, - "com.amazonaws.databasemigrationservice#CreateReplicationTaskMessage": { + "com.amazonaws.databasemigrationservice#CreateReplicationInstanceMessage": { "type": "structure", "members": { - "ReplicationTaskIdentifier": { + "ReplicationInstanceIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "An identifier for the replication task.
\nConstraints:
\nMust contain 1-255 alphanumeric characters or hyphens.
\nFirst character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\nThe replication instance identifier. This parameter is stored as a lowercase\n string.
\nConstraints:
\nMust contain 1-63 alphanumeric characters or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: myrepinstance\n
An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
", - "smithy.api#required": {} + "smithy.api#documentation": "The amount of storage (in gigabytes) to be initially allocated for the replication\n instance.
" } }, - "TargetEndpointArn": { + "ReplicationInstanceClass": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
", + "smithy.api#documentation": "The compute and memory capacity of the replication instance as defined for the specified\n replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\".
For more information on the settings and capacities for the available replication instance classes, see \n \n Choosing the right DMS replication instance; and, \n Selecting the best size for a replication instance.\n
", "smithy.api#required": {} } }, - "ReplicationInstanceArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "VpcSecurityGroupIds": { + "target": "com.amazonaws.databasemigrationservice#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a replication instance.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies the VPC security group to be used with the replication instance. The VPC\n security group must work with the VPC containing the replication instance.
" } }, - "MigrationType": { - "target": "com.amazonaws.databasemigrationservice#MigrationTypeValue", + "AvailabilityZone": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The migration type. Valid values: full-load | cdc | full-load-and-cdc\n
The Availability Zone where the replication instance will be created. The default\n value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, for\n example: us-east-1d.
The table mappings for the task, in JSON format. For more information, see Using Table\n Mapping to Specify Task Settings in the Database Migration Service User\n Guide.\n
", - "smithy.api#required": {} + "smithy.api#documentation": "A subnet group to associate with the replication instance.
" } }, - "ReplicationTaskSettings": { + "PreferredMaintenanceWindow": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Overall settings for the task, in JSON format. For more information, see Specifying Task\n Settings for Database Migration Service Tasks in the Database Migration Service User Guide.\n
" + "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
Default: A 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region,\n occurring on a random day of the week.
\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
\nConstraints: Minimum 30-minute window.
" } }, - "CdcStartTime": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "MultiAZ": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "Indicates the start time for a change data capture (CDC) operation. Use either\n CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start.\n Specifying both values results in an error.
\nTimestamp Example: --cdc-start-time “2018-03-08T12:12:12”
" + "smithy.api#documentation": " Specifies whether the replication instance is a Multi-AZ deployment. You can't set the\n AvailabilityZone parameter if the Multi-AZ parameter is set to\n true.
Indicates when you want a change data capture (CDC) operation to start. Use either\n CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start.\n Specifying both values results in an error.
\nThe value can be in date, checkpoint, or LSN/SCN format.
\nDate Example: --cdc-start-position “2018-03-08T12:12:12”
\nCheckpoint Example: --cdc-start-position\n \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"
\nLSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
\nWhen you use this task setting with a source PostgreSQL database, a logical\n replication slot should already be created and associated with the source endpoint. You\n can verify this by setting the slotName extra connection attribute to the\n name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source\n for DMS.
The engine version number of the replication instance.
\nIf an engine version number is not specified when a replication \n instance is created, the default is the latest engine version available.
" } }, - "CdcStopPosition": { - "target": "com.amazonaws.databasemigrationservice#String", + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.
\nServer time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
\nCommit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12“
" + "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the\n replication instance during the maintenance window. This parameter defaults to\n true.
Default: true\n
When AutoMinorVersionUpgrade is enabled, DMS uses the current default\n engine version when you create a replication instance. For example, if you set\n EngineVersion to a lower version number than the current default version,\n DMS uses the default version.
If AutoMinorVersionUpgrade\n isn’t enabled when you create a replication instance, DMS uses the\n engine version specified by the EngineVersion parameter.
One or more tags to be assigned to the replication task.
" + "smithy.api#documentation": "One or more tags to be assigned to the replication instance.
" } }, - "TaskData": { + "KmsKeyId": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Supplemental information that the task requires to migrate the data for certain source and target endpoints. \n For more information, see Specifying Supplemental Data for Task Settings in the\n Database Migration Service User Guide.\n
" + "smithy.api#documentation": "An KMS key identifier that is used to encrypt the data on the replication\n instance.
\nIf you don't specify a value for the KmsKeyId parameter, then\n DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a\n different default encryption key for each Amazon Web Services Region.
" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": " Specifies the accessibility options for the replication instance. A value of\n true represents an instance with a public IP address. A value of\n false represents an instance with a private IP address. The default value\n is true.
A list of custom DNS name servers supported for the replication instance to access your\n on-premise source or target database. This list overrides the default name servers\n supported by the replication instance. You can specify a comma-separated list of internet\n addresses for up to four on-premise DNS name servers. For example:\n \"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4\"\n
A friendly name for the resource identifier at the end of the EndpointArn\n response parameter that is returned in the created Endpoint object. The value\n for this parameter can have up to 31 characters. It can contain only ASCII letters, digits,\n and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens,\n and can only begin with a letter, such as Example-App-ARN1. For example, this\n value might result in the EndpointArn value\n arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't\n specify a ResourceIdentifier value, DMS generates a default identifier\n value for the end of EndpointArn.
The type of IP address protocol used by a replication instance, \n such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. \n IPv6 only is not yet supported.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#CreateReplicationTaskResponse": { + "com.amazonaws.databasemigrationservice#CreateReplicationInstanceResponse": { "type": "structure", "members": { - "ReplicationTask": { - "target": "com.amazonaws.databasemigrationservice#ReplicationTask", + "ReplicationInstance": { + "target": "com.amazonaws.databasemigrationservice#ReplicationInstance", "traits": { - "smithy.api#documentation": "The replication task that was created.
" + "smithy.api#documentation": "The replication instance that was created.
" } } }, @@ -3236,420 +3523,689 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DataFormatValue": { - "type": "enum", - "members": { - "CSV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "csv" - } + "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroupMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, - "PARQUET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "parquet" - } + { + "target": "com.amazonaws.databasemigrationservice#InvalidSubnet" + }, + { + "target": "com.amazonaws.databasemigrationservice#ReplicationSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" } + ], + "traits": { + "smithy.api#documentation": "Creates a replication subnet group given a list of the subnet IDs in a VPC.
\nThe VPC needs to have at least one subnet in at least two availability zones in the Amazon Web Services Region, otherwise the\n service will throw a ReplicationSubnetGroupDoesNotCoverEnoughAZs exception.
If a replication subnet group exists in your Amazon Web Services account, the CreateReplicationSubnetGroup action \n returns the following error message: The Replication Subnet Group already exists. In this case, delete \n the existing replication subnet group. To do so, use the DeleteReplicationSubnetGroup action. Optionally, choose Subnet groups in the DMS console, \n then choose your subnet group. Next, choose Delete from Actions.
", + "smithy.api#examples": [ + { + "title": "Create replication subnet group", + "documentation": "Creates a replication subnet group given a list of the subnet IDs in a VPC.", + "input": { + "ReplicationSubnetGroupIdentifier": "us-west-2ab-vpc-215ds366", + "ReplicationSubnetGroupDescription": "US West subnet group", + "SubnetIds": [ + "subnet-e145356n", + "subnet-58f79200" + ], + "Tags": [ + { + "Key": "Acount", + "Value": "145235" + } + ] + }, + "output": { + "ReplicationSubnetGroup": {} + } + } + ] } }, - "com.amazonaws.databasemigrationservice#DatabaseInstanceSoftwareDetailsResponse": { + "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroupMessage": { "type": "structure", "members": { - "Engine": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "The database engine of a database in a Fleet Advisor collector inventory, for example Microsoft\n SQL Server.
The database engine version of a database in a Fleet Advisor collector inventory, for example\n 2019.
The database engine edition of a database in a Fleet Advisor collector inventory, for example\n Express.
The service pack level of the database.
" + "smithy.api#documentation": "The name for the replication subnet group. This value is stored as a lowercase\n string.
\nConstraints: Must contain no more than 255 alphanumeric characters, periods, spaces,\n underscores, or hyphens. Must not be \"default\".
\nExample: mySubnetgroup\n
The support level of the database, for example Mainstream support.
The description for the subnet group.
", + "smithy.api#required": {} } }, - "OsArchitecture": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "SubnetIds": { + "target": "com.amazonaws.databasemigrationservice#SubnetIdentifierList", "traits": { - "smithy.api#documentation": "The operating system architecture of the database.
" + "smithy.api#documentation": "One or more subnet IDs to be assigned to the subnet group.
", + "smithy.api#required": {} } }, - "Tooltip": { - "target": "com.amazonaws.databasemigrationservice#String", + "Tags": { + "target": "com.amazonaws.databasemigrationservice#TagList", "traits": { - "smithy.api#documentation": "Information about the database engine software, for example Mainstream support\n ends on November 14th, 2024.
One or more tags to be assigned to the subnet group.
" } } }, "traits": { - "smithy.api#documentation": "Describes an inventory database instance for a Fleet Advisor collector.
" - } - }, - "com.amazonaws.databasemigrationservice#DatabaseList": { - "type": "list", - "member": { - "target": "com.amazonaws.databasemigrationservice#DatabaseResponse" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DatabaseMode": { - "type": "enum", + "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroupResponse": { + "type": "structure", "members": { - "DEFAULT": { - "target": "smithy.api#Unit", + "ReplicationSubnetGroup": { + "target": "com.amazonaws.databasemigrationservice#ReplicationSubnetGroup", "traits": { - "smithy.api#enumValue": "default" + "smithy.api#documentation": "The replication subnet group that was created.
" } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#CreateReplicationTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#CreateReplicationTaskMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#CreateReplicationTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, - "BABELFISH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "babelfish" - } + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" } + ], + "traits": { + "smithy.api#documentation": "Creates a replication task using the specified parameters.
", + "smithy.api#examples": [ + { + "title": "Create replication task", + "documentation": "Creates a replication task using the specified parameters.", + "input": { + "ReplicationTaskIdentifier": "task1", + "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "MigrationType": "full-load", + "TableMappings": "file://mappingfile.json", + "ReplicationTaskSettings": "", + "CdcStartTime": "2016-12-14T18:25:43Z", + "Tags": [ + { + "Key": "Acount", + "Value": "24352226" + } + ] + }, + "output": { + "ReplicationTask": { + "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "ReplicationTaskIdentifier": "task1", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "TableMappings": "file://mappingfile.json", + "Status": "creating", + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM", + "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z", + "MigrationType": "full-load", + "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E", + "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}" + } + } + } + ] } }, - "com.amazonaws.databasemigrationservice#DatabaseResponse": { + "com.amazonaws.databasemigrationservice#CreateReplicationTaskMessage": { "type": "structure", "members": { - "DatabaseId": { + "ReplicationTaskIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The ID of a database in a Fleet Advisor collector inventory.
" + "smithy.api#documentation": "An identifier for the replication task.
\nConstraints:
\nMust contain 1-255 alphanumeric characters or hyphens.
\nFirst character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\nThe name of a database in a Fleet Advisor collector inventory.
" + "smithy.api#documentation": "An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
", + "smithy.api#required": {} } }, - "IpAddress": { + "TargetEndpointArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The IP address of a database in a Fleet Advisor collector inventory.
" + "smithy.api#documentation": "An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
", + "smithy.api#required": {} } }, - "NumberOfSchemas": { - "target": "com.amazonaws.databasemigrationservice#LongOptional", + "ReplicationInstanceArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The number of schemas in a Fleet Advisor collector inventory database.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a replication instance.
", + "smithy.api#required": {} } }, - "Server": { - "target": "com.amazonaws.databasemigrationservice#ServerShortInfoResponse", + "MigrationType": { + "target": "com.amazonaws.databasemigrationservice#MigrationTypeValue", "traits": { - "smithy.api#documentation": "The server name of a database in a Fleet Advisor collector inventory.
" + "smithy.api#documentation": "The migration type. Valid values: full-load | cdc | full-load-and-cdc\n
The software details of a database in a Fleet Advisor collector inventory, such as database engine and\n version.
" + "smithy.api#documentation": "The table mappings for the task, in JSON format. For more information, see Using Table\n Mapping to Specify Task Settings in the Database Migration Service User\n Guide.\n
", + "smithy.api#required": {} } }, - "Collectors": { - "target": "com.amazonaws.databasemigrationservice#CollectorsList", + "ReplicationTaskSettings": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "A list of collectors associated with the database.
" + "smithy.api#documentation": "Overall settings for the task, in JSON format. For more information, see Specifying Task\n Settings for Database Migration Service Tasks in the Database Migration Service User Guide.\n
" } - } - }, - "traits": { - "smithy.api#documentation": "Describes a database in a Fleet Advisor collector inventory.
" - } - }, - "com.amazonaws.databasemigrationservice#DatabaseShortInfoResponse": { - "type": "structure", - "members": { - "DatabaseId": { + }, + "CdcStartTime": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "Indicates the start time for a change data capture (CDC) operation. Use either\n CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start.\n Specifying both values results in an error.
\nTimestamp Example: --cdc-start-time “2018-03-08T12:12:12”
" + } + }, + "CdcStartPosition": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The ID of a database in a Fleet Advisor collector inventory.
" + "smithy.api#documentation": "Indicates when you want a change data capture (CDC) operation to start. Use either\n CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start.\n Specifying both values results in an error.
\nThe value can be in date, checkpoint, or LSN/SCN format.
\nDate Example: --cdc-start-position “2018-03-08T12:12:12”
\nCheckpoint Example: --cdc-start-position\n \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"
\nLSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
\nWhen you use this task setting with a source PostgreSQL database, a logical\n replication slot should already be created and associated with the source endpoint. You\n can verify this by setting the slotName extra connection attribute to the\n name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source\n for DMS.
The name of a database in a Fleet Advisor collector inventory.
" + "smithy.api#documentation": "Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.
\nServer time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
\nCommit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12“
" } }, - "DatabaseIpAddress": { + "Tags": { + "target": "com.amazonaws.databasemigrationservice#TagList", + "traits": { + "smithy.api#documentation": "One or more tags to be assigned to the replication task.
" + } + }, + "TaskData": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The IP address of a database in a Fleet Advisor collector inventory.
" + "smithy.api#documentation": "Supplemental information that the task requires to migrate the data for certain source and target endpoints. \n For more information, see Specifying Supplemental Data for Task Settings in the\n Database Migration Service User Guide.\n
" } }, - "DatabaseEngine": { + "ResourceIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The database engine of a database in a Fleet Advisor collector inventory, for example\n PostgreSQL.
A friendly name for the resource identifier at the end of the EndpointArn\n response parameter that is returned in the created Endpoint object. The value\n for this parameter can have up to 31 characters. It can contain only ASCII letters, digits,\n and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens,\n and can only begin with a letter, such as Example-App-ARN1. For example, this\n value might result in the EndpointArn value\n arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't\n specify a ResourceIdentifier value, DMS generates a default identifier\n value for the end of EndpointArn.
Describes a database in a Fleet Advisor collector inventory.
" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DatePartitionDelimiterValue": { - "type": "enum", + "com.amazonaws.databasemigrationservice#CreateReplicationTaskResponse": { + "type": "structure", "members": { - "SLASH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SLASH" - } - }, - "UNDERSCORE": { - "target": "smithy.api#Unit", + "ReplicationTask": { + "target": "com.amazonaws.databasemigrationservice#ReplicationTask", "traits": { - "smithy.api#enumValue": "UNDERSCORE" + "smithy.api#documentation": "The replication task that was created.
" } - }, - "DASH": { + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DataFormatValue": { + "type": "enum", + "members": { + "CSV": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DASH" + "smithy.api#enumValue": "csv" } }, - "NONE": { + "PARQUET": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#enumValue": "parquet" } } } }, - "com.amazonaws.databasemigrationservice#DatePartitionSequenceValue": { - "type": "enum", + "com.amazonaws.databasemigrationservice#DataProvider": { + "type": "structure", "members": { - "YYYYMMDD": { - "target": "smithy.api#Unit", + "DataProviderName": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#enumValue": "YYYYMMDD" + "smithy.api#documentation": "The name of the data provider.
" } }, - "YYYYMMDDHH": { - "target": "smithy.api#Unit", + "DataProviderArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#enumValue": "YYYYMMDDHH" + "smithy.api#documentation": "The Amazon Resource Name (ARN) string that uniquely identifies the data provider.
" } }, - "YYYYMM": { - "target": "smithy.api#Unit", + "DataProviderCreationTime": { + "target": "com.amazonaws.databasemigrationservice#Iso8601DateTime", "traits": { - "smithy.api#enumValue": "YYYYMM" + "smithy.api#documentation": "The time the data provider was created.
" } }, - "MMYYYYDD": { - "target": "smithy.api#Unit", + "Description": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#enumValue": "MMYYYYDD" + "smithy.api#documentation": "A description of the data provider. Descriptions can have up to 31 characters. \n A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't \n end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.
" } }, - "DDMMYYYY": { - "target": "smithy.api#Unit", + "Engine": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#enumValue": "DDMMYYYY" + "smithy.api#documentation": "The type of database engine for the data provider. Valid values include \"aurora\", \n \"aurora_postgresql\", \"mysql\", \"oracle\", \"postgres\", \n and \"sqlserver\". A value of \"aurora\" represents Amazon Aurora MySQL-Compatible Edition.
The settings in JSON format for a data provider.
" + } } - ], + }, "traits": { - "smithy.api#documentation": "Deletes the specified certificate.
" + "smithy.api#documentation": "Provides information that defines a data provider.
" } }, - "com.amazonaws.databasemigrationservice#DeleteCertificateMessage": { + "com.amazonaws.databasemigrationservice#DataProviderDescriptor": { "type": "structure", "members": { - "CertificateArn": { + "SecretsManagerSecretId": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the certificate.
", - "smithy.api#required": {} + "smithy.api#documentation": "The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.
" } - } - } - }, - "com.amazonaws.databasemigrationservice#DeleteCertificateResponse": { - "type": "structure", - "members": { - "Certificate": { - "target": "com.amazonaws.databasemigrationservice#Certificate", + }, + "SecretsManagerAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The Secure Sockets Layer (SSL) certificate.
" + "smithy.api#documentation": "The ARN of the role used to access Amazon Web Services Secrets Manager.
" + } + }, + "DataProviderName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The user-friendly name of the data provider.
" + } + }, + "DataProviderArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the data provider.
" } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "Information about a data provider.
" } }, - "com.amazonaws.databasemigrationservice#DeleteCollectorRequest": { + "com.amazonaws.databasemigrationservice#DataProviderDescriptorDefinition": { "type": "structure", "members": { - "CollectorReferencedId": { + "DataProviderIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The reference ID of the Fleet Advisor collector to delete.
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the data provider.
", "smithy.api#required": {} } + }, + "SecretsManagerSecretId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Web Services Secrets Manager Secret used to store access credentials for the data provider.
" + } + }, + "SecretsManagerAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The ARN of the role used to access Amazon Web Services Secrets Manager.
" + } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "Information about a data provider.
" } }, - "com.amazonaws.databasemigrationservice#DeleteConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.databasemigrationservice#DeleteConnectionMessage" - }, - "output": { - "target": "com.amazonaws.databasemigrationservice#DeleteConnectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + "com.amazonaws.databasemigrationservice#DataProviderDescriptorDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#DataProviderDescriptorDefinition" + } + }, + "com.amazonaws.databasemigrationservice#DataProviderDescriptorList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#DataProviderDescriptor" + } + }, + "com.amazonaws.databasemigrationservice#DataProviderList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#DataProvider", + "traits": { + "smithy.api#xmlName": "DataProvider" + } + } + }, + "com.amazonaws.databasemigrationservice#DataProviderSettings": { + "type": "union", + "members": { + "PostgreSqlSettings": { + "target": "com.amazonaws.databasemigrationservice#PostgreSqlDataProviderSettings" }, - { - "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + "MySqlSettings": { + "target": "com.amazonaws.databasemigrationservice#MySqlDataProviderSettings" }, - { - "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + "OracleSettings": { + "target": "com.amazonaws.databasemigrationservice#OracleDataProviderSettings" + }, + "MicrosoftSqlServerSettings": { + "target": "com.amazonaws.databasemigrationservice#MicrosoftSqlServerDataProviderSettings" } - ], + }, "traits": { - "smithy.api#documentation": "Deletes the connection between a replication instance and an endpoint.
" + "smithy.api#documentation": "Provides information that defines a data provider.
" } }, - "com.amazonaws.databasemigrationservice#DeleteConnectionMessage": { + "com.amazonaws.databasemigrationservice#DatabaseInstanceSoftwareDetailsResponse": { "type": "structure", "members": { - "EndpointArn": { + "Engine": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
", - "smithy.api#required": {} + "smithy.api#documentation": "The database engine of a database in a Fleet Advisor collector inventory, for example Microsoft\n SQL Server.
The Amazon Resource Name (ARN) of the replication instance.
", - "smithy.api#required": {} + "smithy.api#documentation": "The database engine version of a database in a Fleet Advisor collector inventory, for example\n 2019.
The connection that is being deleted.
" + "smithy.api#documentation": "The database engine edition of a database in a Fleet Advisor collector inventory, for example\n Express.
The service pack level of the database.
" + } + }, + "SupportLevel": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The support level of the database, for example Mainstream support.
The operating system architecture of the database.
" + } + }, + "Tooltip": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Information about the database engine software, for example Mainstream support\n ends on November 14th, 2024.
Describes an inventory database instance for a Fleet Advisor collector.
" } }, - "com.amazonaws.databasemigrationservice#DeleteEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.databasemigrationservice#DeleteEndpointMessage" - }, - "output": { - "target": "com.amazonaws.databasemigrationservice#DeleteEndpointResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" - }, - { - "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified endpoint.
\nAll tasks associated with the endpoint must be deleted before you can delete the\n endpoint.
\nThe Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
", - "smithy.api#required": {} + "smithy.api#enumValue": "default" + } + }, + "BABELFISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "babelfish" } } - }, - "traits": { - "smithy.api#documentation": "" } }, - "com.amazonaws.databasemigrationservice#DeleteEndpointResponse": { + "com.amazonaws.databasemigrationservice#DatabaseResponse": { "type": "structure", "members": { - "Endpoint": { - "target": "com.amazonaws.databasemigrationservice#Endpoint", - "traits": { - "smithy.api#documentation": "The endpoint that was deleted.
" + "DatabaseId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The ID of a database in a Fleet Advisor collector inventory.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The name of a database in a Fleet Advisor collector inventory.
" + } + }, + "IpAddress": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The IP address of a database in a Fleet Advisor collector inventory.
" + } + }, + "NumberOfSchemas": { + "target": "com.amazonaws.databasemigrationservice#LongOptional", + "traits": { + "smithy.api#documentation": "The number of schemas in a Fleet Advisor collector inventory database.
" + } + }, + "Server": { + "target": "com.amazonaws.databasemigrationservice#ServerShortInfoResponse", + "traits": { + "smithy.api#documentation": "The server name of a database in a Fleet Advisor collector inventory.
" + } + }, + "SoftwareDetails": { + "target": "com.amazonaws.databasemigrationservice#DatabaseInstanceSoftwareDetailsResponse", + "traits": { + "smithy.api#documentation": "The software details of a database in a Fleet Advisor collector inventory, such as database engine and\n version.
" + } + }, + "Collectors": { + "target": "com.amazonaws.databasemigrationservice#CollectorsList", + "traits": { + "smithy.api#documentation": "A list of collectors associated with the database.
" } } }, "traits": { - "smithy.api#documentation": "", - "smithy.api#output": {} + "smithy.api#documentation": "Describes a database in a Fleet Advisor collector inventory.
" } }, - "com.amazonaws.databasemigrationservice#DeleteEventSubscription": { + "com.amazonaws.databasemigrationservice#DatabaseShortInfoResponse": { + "type": "structure", + "members": { + "DatabaseId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The ID of a database in a Fleet Advisor collector inventory.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The name of a database in a Fleet Advisor collector inventory.
" + } + }, + "DatabaseIpAddress": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The IP address of a database in a Fleet Advisor collector inventory.
" + } + }, + "DatabaseEngine": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The database engine of a database in a Fleet Advisor collector inventory, for example\n PostgreSQL.
Describes a database in a Fleet Advisor collector inventory.
" + } + }, + "com.amazonaws.databasemigrationservice#DatePartitionDelimiterValue": { + "type": "enum", + "members": { + "SLASH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SLASH" + } + }, + "UNDERSCORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNDERSCORE" + } + }, + "DASH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DASH" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.databasemigrationservice#DatePartitionSequenceValue": { + "type": "enum", + "members": { + "YYYYMMDD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YYYYMMDD" + } + }, + "YYYYMMDDHH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YYYYMMDDHH" + } + }, + "YYYYMM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YYYYMM" + } + }, + "MMYYYYDD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MMYYYYDD" + } + }, + "DDMMYYYY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DDMMYYYY" + } + } + } + }, + "com.amazonaws.databasemigrationservice#DefaultErrorDetails": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The error message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides error information about a schema conversion operation.
" + } + }, + "com.amazonaws.databasemigrationservice#DeleteCertificate": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DeleteEventSubscriptionMessage" + "target": "com.amazonaws.databasemigrationservice#DeleteCertificateMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DeleteEventSubscriptionResponse" + "target": "com.amazonaws.databasemigrationservice#DeleteCertificateResponse" }, "errors": [ { @@ -3660,115 +4216,146 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an DMS event subscription.
" + "smithy.api#documentation": "Deletes the specified certificate.
", + "smithy.api#examples": [ + { + "title": "Delete Certificate", + "documentation": "Deletes the specified certificate.", + "input": { + "CertificateArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUSM457DE6XFJCJQ" + }, + "output": { + "Certificate": {} + } + } + ] } }, - "com.amazonaws.databasemigrationservice#DeleteEventSubscriptionMessage": { + "com.amazonaws.databasemigrationservice#DeleteCertificateMessage": { "type": "structure", "members": { - "SubscriptionName": { + "CertificateArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The name of the DMS event notification subscription to be deleted.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the certificate.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DeleteEventSubscriptionResponse": { + "com.amazonaws.databasemigrationservice#DeleteCertificateResponse": { "type": "structure", "members": { - "EventSubscription": { - "target": "com.amazonaws.databasemigrationservice#EventSubscription", + "Certificate": { + "target": "com.amazonaws.databasemigrationservice#Certificate", "traits": { - "smithy.api#documentation": "The event subscription that was deleted.
" + "smithy.api#documentation": "The Secure Sockets Layer (SSL) certificate.
" } } }, "traits": { - "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorCollector": { - "type": "operation", - "input": { - "target": "com.amazonaws.databasemigrationservice#DeleteCollectorRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.databasemigrationservice#CollectorNotFoundFault" - }, - { - "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + "com.amazonaws.databasemigrationservice#DeleteCollectorRequest": { + "type": "structure", + "members": { + "CollectorReferencedId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The reference ID of the Fleet Advisor collector to delete.
", + "smithy.api#required": {} + } } - ], + }, "traits": { - "smithy.api#documentation": "Deletes the specified Fleet Advisor collector.
" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorDatabases": { + "com.amazonaws.databasemigrationservice#DeleteConnection": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorDatabasesRequest" + "target": "com.amazonaws.databasemigrationservice#DeleteConnectionMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorDatabasesResponse" + "target": "com.amazonaws.databasemigrationservice#DeleteConnectionResponse" }, "errors": [ { - "target": "com.amazonaws.databasemigrationservice#InvalidOperationFault" + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, { "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } ], "traits": { - "smithy.api#documentation": "Deletes the specified Fleet Advisor collector databases.
" + "smithy.api#documentation": "Deletes the connection between a replication instance and an endpoint.
", + "smithy.api#examples": [ + { + "title": "Delete Connection", + "documentation": "Deletes the connection between the replication instance and the endpoint.", + "input": { + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM" + }, + "output": { + "Connection": {} + } + } + ] } }, - "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorDatabasesRequest": { + "com.amazonaws.databasemigrationservice#DeleteConnectionMessage": { "type": "structure", "members": { - "DatabaseIds": { - "target": "com.amazonaws.databasemigrationservice#StringList", + "EndpointArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The IDs of the Fleet Advisor collector databases to delete.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
", + "smithy.api#required": {} + } + }, + "ReplicationInstanceArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replication instance.
", "smithy.api#required": {} } } }, "traits": { + "smithy.api#documentation": "", "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorDatabasesResponse": { + "com.amazonaws.databasemigrationservice#DeleteConnectionResponse": { "type": "structure", "members": { - "DatabaseIds": { - "target": "com.amazonaws.databasemigrationservice#StringList", + "Connection": { + "target": "com.amazonaws.databasemigrationservice#Connection", "traits": { - "smithy.api#documentation": "The IDs of the databases that the operation deleted.
" + "smithy.api#documentation": "The connection that is being deleted.
" } } }, "traits": { + "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationConfig": { + "com.amazonaws.databasemigrationservice#DeleteDataProvider": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationConfigMessage" + "target": "com.amazonaws.databasemigrationservice#DeleteDataProviderMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationConfigResponse" + "target": "com.amazonaws.databasemigrationservice#DeleteDataProviderResponse" }, "errors": [ { @@ -3782,46 +4369,45 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an DMS Serverless replication configuration. This effectively deprovisions any and all\n replications that use this configuration. You can't delete the configuration for an DMS Serverless replication\n that is ongoing. You can delete the configuration when the replication is in a non-RUNNING and non-STARTING state.
" + "smithy.api#documentation": "Deletes the specified data provider.
\nAll migration projects associated with the data provider must be deleted or modified \n before you can delete the data provider.
\nThe replication config to delete.
", + "smithy.api#documentation": "The identifier of the data provider to delete.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationConfigResponse": { + "com.amazonaws.databasemigrationservice#DeleteDataProviderResponse": { "type": "structure", "members": { - "ReplicationConfig": { - "target": "com.amazonaws.databasemigrationservice#ReplicationConfig", + "DataProvider": { + "target": "com.amazonaws.databasemigrationservice#DataProvider", "traits": { - "smithy.api#documentation": "Configuration parameters returned for the DMS Serverless replication after it is deleted.
" + "smithy.api#documentation": "The data provider that was deleted.
" } } }, "traits": { - "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationInstance": { + "com.amazonaws.databasemigrationservice#DeleteEndpoint": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationInstanceMessage" + "target": "com.amazonaws.databasemigrationservice#DeleteEndpointMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationInstanceResponse" + "target": "com.amazonaws.databasemigrationservice#DeleteEndpointResponse" }, "errors": [ { @@ -3832,31 +4418,54 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified replication instance.
\nYou must delete any migration tasks that are associated with the replication instance\n before you can delete it.
\nDeletes the specified endpoint.
\nAll tasks associated with the endpoint must be deleted before you can delete the\n endpoint.
\nThe Amazon Resource Name (ARN) of the replication instance to be deleted.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationInstanceResponse": { + "com.amazonaws.databasemigrationservice#DeleteEndpointResponse": { "type": "structure", "members": { - "ReplicationInstance": { - "target": "com.amazonaws.databasemigrationservice#ReplicationInstance", + "Endpoint": { + "target": "com.amazonaws.databasemigrationservice#Endpoint", "traits": { - "smithy.api#documentation": "The replication instance that was deleted.
" + "smithy.api#documentation": "The endpoint that was deleted.
" } } }, @@ -3865,13 +4474,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroup": { + "com.amazonaws.databasemigrationservice#DeleteEventSubscription": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroupMessage" + "target": "com.amazonaws.databasemigrationservice#DeleteEventSubscriptionMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroupResponse" + "target": "com.amazonaws.databasemigrationservice#DeleteEventSubscriptionResponse" }, "errors": [ { @@ -3882,182 +4491,220 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a subnet group.
" + "smithy.api#documentation": "Deletes an DMS event subscription.
" } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroupMessage": { + "com.amazonaws.databasemigrationservice#DeleteEventSubscriptionMessage": { "type": "structure", "members": { - "ReplicationSubnetGroupIdentifier": { + "SubscriptionName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The subnet group name of the replication instance.
", + "smithy.api#documentation": "The name of the DMS event notification subscription to be deleted.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroupResponse": { + "com.amazonaws.databasemigrationservice#DeleteEventSubscriptionResponse": { "type": "structure", - "members": {}, + "members": { + "EventSubscription": { + "target": "com.amazonaws.databasemigrationservice#EventSubscription", + "traits": { + "smithy.api#documentation": "The event subscription that was deleted.
" + } + } + }, "traits": { "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationTask": { + "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorCollector": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationTaskMessage" + "target": "com.amazonaws.databasemigrationservice#DeleteCollectorRequest" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationTaskResponse" + "target": "smithy.api#Unit" }, "errors": [ { - "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + "target": "com.amazonaws.databasemigrationservice#CollectorNotFoundFault" }, { - "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" } ], "traits": { - "smithy.api#documentation": "Deletes the specified replication task.
" + "smithy.api#documentation": "Deletes the specified Fleet Advisor collector.
" } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationTaskAssessmentRun": { + "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorDatabases": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationTaskAssessmentRunMessage" + "target": "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorDatabasesRequest" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationTaskAssessmentRunResponse" + "target": "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorDatabasesResponse" }, "errors": [ { - "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" - }, - { - "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + "target": "com.amazonaws.databasemigrationservice#InvalidOperationFault" }, { "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } ], "traits": { - "smithy.api#documentation": "Deletes the record of a single premigration assessment run.
\nThis operation removes all metadata that DMS maintains about this assessment run.\n However, the operation leaves untouched all information about this assessment run that is\n stored in your Amazon S3 bucket.
" + "smithy.api#documentation": "Deletes the specified Fleet Advisor collector databases.
" } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationTaskAssessmentRunMessage": { + "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorDatabasesRequest": { "type": "structure", "members": { - "ReplicationTaskAssessmentRunArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "DatabaseIds": { + "target": "com.amazonaws.databasemigrationservice#StringList", "traits": { - "smithy.api#documentation": "Amazon Resource Name (ARN) of the premigration assessment run to be deleted.
", + "smithy.api#documentation": "The IDs of the Fleet Advisor collector databases to delete.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationTaskAssessmentRunResponse": { + "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorDatabasesResponse": { "type": "structure", "members": { - "ReplicationTaskAssessmentRun": { - "target": "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentRun", + "DatabaseIds": { + "target": "com.amazonaws.databasemigrationservice#StringList", "traits": { - "smithy.api#documentation": "The ReplicationTaskAssessmentRun object for the deleted assessment\n run.
The IDs of the databases that the operation deleted.
" } } }, "traits": { - "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationTaskMessage": { + "com.amazonaws.databasemigrationservice#DeleteInstanceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DeleteInstanceProfileMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DeleteInstanceProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified instance profile.
\nAll migration projects associated with the instance profile must be deleted or modified \n before you can delete the instance profile.
\nThe Amazon Resource Name (ARN) of the replication task to be deleted.
", + "smithy.api#documentation": "The identifier of the instance profile to delete.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationTaskResponse": { + "com.amazonaws.databasemigrationservice#DeleteInstanceProfileResponse": { "type": "structure", "members": { - "ReplicationTask": { - "target": "com.amazonaws.databasemigrationservice#ReplicationTask", + "InstanceProfile": { + "target": "com.amazonaws.databasemigrationservice#InstanceProfile", "traits": { - "smithy.api#documentation": "The deleted replication task.
" + "smithy.api#documentation": "The instance profile that was deleted.
" } } }, "traits": { - "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeAccountAttributes": { + "com.amazonaws.databasemigrationservice#DeleteMigrationProject": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeAccountAttributesMessage" + "target": "com.amazonaws.databasemigrationservice#DeleteMigrationProjectMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeAccountAttributesResponse" + "target": "com.amazonaws.databasemigrationservice#DeleteMigrationProjectResponse" }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], "traits": { - "smithy.api#documentation": "Lists all of the DMS attributes for a customer account. These attributes include DMS\n quotas for the account and a unique account identifier in a particular DMS region. DMS\n quotas include a list of resource quotas supported by the account, such as the number of\n replication instances allowed. The description for each resource quota, includes the quota\n name, current usage toward that quota, and the quota's maximum value. DMS uses the unique\n account identifier to name each artifact used by DMS in the given region.
\nThis command does not take any parameters.
" + "smithy.api#documentation": "Deletes the specified migration project.
\nThe migration project must be closed before you can delete it.
\nThe name or Amazon Resource Name (ARN) of the migration project to delete.
", + "smithy.api#required": {} + } + } + }, "traits": { - "smithy.api#documentation": "" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeAccountAttributesResponse": { + "com.amazonaws.databasemigrationservice#DeleteMigrationProjectResponse": { "type": "structure", "members": { - "AccountQuotas": { - "target": "com.amazonaws.databasemigrationservice#AccountQuotaList", - "traits": { - "smithy.api#documentation": "Account quota information.
" - } - }, - "UniqueAccountIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", + "MigrationProject": { + "target": "com.amazonaws.databasemigrationservice#MigrationProject", "traits": { - "smithy.api#documentation": "A unique DMS identifier for an account in a particular Amazon Web Services Region. The value of this\n identifier has the following format: c99999999999. DMS uses this identifier to\n name artifacts. For example, DMS uses this identifier to name the default Amazon S3 bucket\n for storing task assessment reports in a given Amazon Web Services Region. The format of this S3 bucket\n name is the following:\n dms-AccountNumber-UniqueAccountIdentifier.\n Here is an example name for this default S3 bucket:\n dms-111122223333-c44445555666.
DMS supports the UniqueAccountIdentifier parameter in\n versions 3.1.4 and later.
The migration project that was deleted.
" } } }, "traits": { - "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeApplicableIndividualAssessments": { + "com.amazonaws.databasemigrationservice#DeleteReplicationConfig": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeApplicableIndividualAssessmentsMessage" + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationConfigMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeApplicableIndividualAssessmentsResponse" + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationConfigResponse" }, "errors": [ { @@ -4071,77 +4718,32 @@ } ], "traits": { - "smithy.api#documentation": "Provides a list of individual assessments that you can specify for a new premigration\n assessment run, given one or more parameters.
\nIf you specify an existing migration task, this operation provides the default individual\n assessments you can specify for that task. Otherwise, the specified parameters model elements\n of a possible migration task on which to base a premigration assessment run.
\nTo use these migration task modeling parameters, you must specify an existing replication instance,\n a source database engine, a target database engine, and a migration type. This combination of\n parameters potentially limits the default individual assessments available for an assessment run\n created for a corresponding migration task.
\nIf you specify no parameters, this operation provides a list of all possible individual assessments\n that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must\n specify all of them or the operation cannot provide a list of individual assessments.\n The only parameter that you can specify alone is for an existing migration task. The specified task\n definition then determines the default list of individual assessments that you can specify in an\n assessment run for the task.
", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "pageSize": "MaxRecords" - } + "smithy.api#documentation": "Deletes an DMS Serverless replication configuration. This effectively deprovisions any and all\n replications that use this configuration. You can't delete the configuration for an DMS Serverless replication\n that is ongoing. You can delete the configuration when the replication is in a non-RUNNING and non-STARTING state.
" } }, - "com.amazonaws.databasemigrationservice#DescribeApplicableIndividualAssessmentsMessage": { + "com.amazonaws.databasemigrationservice#DeleteReplicationConfigMessage": { "type": "structure", "members": { - "ReplicationTaskArn": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "Amazon Resource Name (ARN) of a migration task on which you want to base \n the default list of individual assessments.
" - } - }, - "ReplicationInstanceArn": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "ARN of a replication instance on which you want to base the default list of individual\n assessments.
" - } - }, - "SourceEngineName": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "Name of a database engine that the specified replication instance supports as a source.
" - } - }, - "TargetEngineName": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "Name of a database engine that the specified replication instance supports as a target.
" - } - }, - "MigrationType": { - "target": "com.amazonaws.databasemigrationservice#MigrationTypeValue", - "traits": { - "smithy.api#documentation": "Name of the migration type that each provided individual assessment must support.
" - } - }, - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", - "traits": { - "smithy.api#documentation": "Maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in\n the response so that the remaining results can be retrieved.
Optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
The replication config to delete.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeApplicableIndividualAssessmentsResponse": { + "com.amazonaws.databasemigrationservice#DeleteReplicationConfigResponse": { "type": "structure", "members": { - "IndividualAssessmentNames": { - "target": "com.amazonaws.databasemigrationservice#IndividualAssessmentNameList", - "traits": { - "smithy.api#documentation": "List of names for the individual assessments supported by the premigration assessment\n run that you start based on the specified request parameters. For more information on the\n available individual assessments, including compatibility with different migration task\n configurations, see Working with premigration assessment runs in the\n Database Migration Service User Guide.\n
" - } - }, - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", + "ReplicationConfig": { + "target": "com.amazonaws.databasemigrationservice#ReplicationConfig", "traits": { - "smithy.api#documentation": "Pagination token returned for you to pass to a subsequent request. If you pass this\n token as the Marker value in a subsequent request, the response includes only\n records beyond the marker, up to the value specified in the request by\n MaxRecords.
Configuration parameters returned for the DMS Serverless replication after it is deleted.
" } } }, @@ -4150,285 +4752,291 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeCertificates": { + "com.amazonaws.databasemigrationservice#DeleteReplicationInstance": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeCertificatesMessage" + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationInstanceMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeCertificatesResponse" + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationInstanceResponse" }, "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, { "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } ], "traits": { - "smithy.api#documentation": "Provides a description of the certificate.
", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.databasemigrationservice#DescribeCertificatesMessage": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", - "traits": { - "smithy.api#documentation": "Filters applied to the certificates described in the form of key-value pairs. \n Valid values are certificate-arn and certificate-id.
The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 10
" + "smithy.api#documentation": "Deletes the specified replication instance.
\nYou must delete any migration tasks that are associated with the replication instance\n before you can delete it.
\n An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
The Amazon Resource Name (ARN) of the replication instance to be deleted.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeCertificatesResponse": { + "com.amazonaws.databasemigrationservice#DeleteReplicationInstanceResponse": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "The pagination token.
" - } - }, - "Certificates": { - "target": "com.amazonaws.databasemigrationservice#CertificateList", + "ReplicationInstance": { + "target": "com.amazonaws.databasemigrationservice#ReplicationInstance", "traits": { - "smithy.api#documentation": "The Secure Sockets Layer (SSL) certificates associated with the replication\n instance.
" + "smithy.api#documentation": "The replication instance that was deleted.
" } } }, "traits": { + "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeConnections": { + "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroup": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeConnectionsMessage" + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroupMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeConnectionsResponse" + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroupResponse" }, "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, { "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } ], "traits": { - "smithy.api#documentation": "Describes the status of the connections that have been made between the replication\n instance and an endpoint. Connections are created when you test an endpoint.
", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "pageSize": "MaxRecords" - }, - "smithy.waiters#waitable": { - "TestConnectionSucceeds": { - "documentation": "Wait until testing connection succeeds.", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Connections[].Status", - "expected": "successful", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Connections[].Status", - "expected": "failed", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 5 + "smithy.api#documentation": "Deletes a subnet group.
", + "smithy.api#examples": [ + { + "title": "Delete Replication Subnet Group", + "documentation": "Deletes a replication subnet group.", + "input": { + "ReplicationSubnetGroupIdentifier": "us-west-2ab-vpc-215ds366" + }, + "output": {} } - } + ] } }, - "com.amazonaws.databasemigrationservice#DescribeConnectionsMessage": { + "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroupMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", - "traits": { - "smithy.api#documentation": "The filters applied to the connection.
\nValid filter names: endpoint-arn | replication-instance-arn
" - } - }, - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", - "traits": { - "smithy.api#documentation": " The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" - } - }, - "Marker": { + "ReplicationSubnetGroupIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
The subnet group name of the replication instance.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeConnectionsResponse": { + "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroupResponse": { "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
A description of the connections.
" - } - } - }, + "members": {}, "traits": { "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeEndpointSettings": { + "com.amazonaws.databasemigrationservice#DeleteReplicationTask": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeEndpointSettingsMessage" + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationTaskMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeEndpointSettingsResponse" + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationTaskResponse" }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], "traits": { - "smithy.api#documentation": "Returns information about the possible endpoint settings available \n when you create an endpoint for a specific database engine.
", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "pageSize": "MaxRecords" + "smithy.api#documentation": "Deletes the specified replication task.
", + "smithy.api#examples": [ + { + "title": "Delete Replication Task", + "documentation": "Deletes the specified replication task.", + "input": { + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ" + }, + "output": { + "ReplicationTask": { + "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "ReplicationTaskIdentifier": "task1", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "TableMappings": "file://mappingfile.json", + "Status": "creating", + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM", + "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z", + "MigrationType": "full-load", + "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E", + "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}" + } + } + } + ] + } + }, + "com.amazonaws.databasemigrationservice#DeleteReplicationTaskAssessmentRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationTaskAssessmentRunMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationTaskAssessmentRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } + ], + "traits": { + "smithy.api#documentation": "Deletes the record of a single premigration assessment run.
\nThis operation removes all metadata that DMS maintains about this assessment run.\n However, the operation leaves untouched all information about this assessment run that is\n stored in your Amazon S3 bucket.
" } }, - "com.amazonaws.databasemigrationservice#DescribeEndpointSettingsMessage": { + "com.amazonaws.databasemigrationservice#DeleteReplicationTaskAssessmentRunMessage": { "type": "structure", "members": { - "EngineName": { + "ReplicationTaskAssessmentRunArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The database engine used for your source or target endpoint.
", + "smithy.api#documentation": "Amazon Resource Name (ARN) of the premigration assessment run to be deleted.
", "smithy.api#required": {} } - }, - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", - "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than \n the specified MaxRecords value, a pagination token called a marker is included in the response \n so that the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.
Descriptions of the endpoint settings available for your source or target database engine.
" + "smithy.api#documentation": "The ReplicationTaskAssessmentRun object for the deleted assessment\n run.
Returns information about the type of endpoints available.
", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.databasemigrationservice#DescribeEndpointTypesMessage": { + "com.amazonaws.databasemigrationservice#DeleteReplicationTaskMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", - "traits": { - "smithy.api#documentation": "Filters applied to the endpoint types.
\nValid filter names: engine-name | endpoint-type
" - } - }, - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", - "traits": { - "smithy.api#documentation": " The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" - } - }, - "Marker": { + "ReplicationTaskArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
The Amazon Resource Name (ARN) of the replication task to be deleted.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeEndpointTypesResponse": { + "com.amazonaws.databasemigrationservice#DeleteReplicationTaskResponse": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", + "ReplicationTask": { + "target": "com.amazonaws.databasemigrationservice#ReplicationTask", "traits": { - "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
The types of endpoints that are supported.
" + "smithy.api#documentation": "The deleted replication task.
" } } }, @@ -4437,101 +5045,64 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeEndpoints": { + "com.amazonaws.databasemigrationservice#DescribeAccountAttributes": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeEndpointsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeAccountAttributesMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeEndpointsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeAccountAttributesResponse" }, - "errors": [ - { - "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" - } - ], "traits": { - "smithy.api#documentation": "Returns information about the endpoints for your account in the current region.
", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "pageSize": "MaxRecords" - }, - "smithy.waiters#waitable": { - "EndpointDeleted": { - "documentation": "Wait until testing endpoint is deleted.", - "acceptors": [ - { - "state": "success", - "matcher": { - "errorType": "ResourceNotFoundFault" - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Endpoints[].Status", - "expected": "active", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Endpoints[].Status", - "expected": "creating", - "comparator": "anyStringEquals" - } + "smithy.api#documentation": "Lists all of the DMS attributes for a customer account. These attributes include DMS\n quotas for the account and a unique account identifier in a particular DMS region. DMS\n quotas include a list of resource quotas supported by the account, such as the number of\n replication instances allowed. The description for each resource quota, includes the quota\n name, current usage toward that quota, and the quota's maximum value. DMS uses the unique\n account identifier to name each artifact used by DMS in the given region.
\nThis command does not take any parameters.
", + "smithy.api#examples": [ + { + "title": "Describe acount attributes", + "documentation": "Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This operation does not take any parameters.", + "output": { + "AccountQuotas": [ + { + "Max": 20, + "AccountQuotaName": "ReplicationInstances", + "Used": 0 + }, + { + "Max": 20, + "AccountQuotaName": "AllocatedStorage", + "Used": 0 + }, + { + "Max": 20, + "AccountQuotaName": "Endpoints", + "Used": 0 } - } - ], - "minDelay": 5 + ] + } } - } + ] } }, - "com.amazonaws.databasemigrationservice#DescribeEndpointsMessage": { + "com.amazonaws.databasemigrationservice#DescribeAccountAttributesMessage": { "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", - "traits": { - "smithy.api#documentation": "Filters applied to the endpoints.
\nValid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
" - } - }, - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", - "traits": { - "smithy.api#documentation": " The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" - } - }, - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
Account quota information.
" } }, - "Endpoints": { - "target": "com.amazonaws.databasemigrationservice#EndpointList", + "UniqueAccountIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Endpoint description.
" + "smithy.api#documentation": "A unique DMS identifier for an account in a particular Amazon Web Services Region. The value of this\n identifier has the following format: c99999999999. DMS uses this identifier to\n name artifacts. For example, DMS uses this identifier to name the default Amazon S3 bucket\n for storing task assessment reports in a given Amazon Web Services Region. The format of this S3 bucket\n name is the following:\n dms-AccountNumber-UniqueAccountIdentifier.\n Here is an example name for this default S3 bucket:\n dms-111122223333-c44445555666.
DMS supports the UniqueAccountIdentifier parameter in\n versions 3.1.4 and later.
Returns information about the replication instance versions used in the project.
", + "smithy.api#documentation": "Provides a list of individual assessments that you can specify for a new premigration\n assessment run, given one or more parameters.
\nIf you specify an existing migration task, this operation provides the default individual\n assessments you can specify for that task. Otherwise, the specified parameters model elements\n of a possible migration task on which to base a premigration assessment run.
\nTo use these migration task modeling parameters, you must specify an existing replication instance,\n a source database engine, a target database engine, and a migration type. This combination of\n parameters potentially limits the default individual assessments available for an assessment run\n created for a corresponding migration task.
\nIf you specify no parameters, this operation provides a list of all possible individual assessments\n that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must\n specify all of them or the operation cannot provide a list of individual assessments.\n The only parameter that you can specify alone is for an existing migration task. The specified task\n definition then determines the default list of individual assessments that you can specify in an\n assessment run for the task.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -4557,82 +5139,70 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeEngineVersionsMessage": { + "com.amazonaws.databasemigrationservice#DescribeApplicableIndividualAssessmentsMessage": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "ReplicationTaskArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the specified \n MaxRecords value, a pagination token called a marker is included in the response so that \n the remaining results can be retrieved.
Amazon Resource Name (ARN) of a migration task on which you want to base \n the default list of individual assessments.
" } }, - "Marker": { + "ReplicationInstanceArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.
ARN of a replication instance on which you want to base the default list of individual\n assessments.
" } - } - } - }, - "com.amazonaws.databasemigrationservice#DescribeEngineVersionsResponse": { - "type": "structure", - "members": { - "EngineVersions": { - "target": "com.amazonaws.databasemigrationservice#EngineVersionList", + }, + "SourceEngineName": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Returned EngineVersion objects that describe the replication instance engine versions used in the project.
Name of a database engine that the specified replication instance supports as a source.
" } }, - "Marker": { + "TargetEngineName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "An optional pagination token provided by a previous request. If this parameter is specified, the response \n includes only records beyond the marker, up to the value specified by MaxRecords.
Name of a database engine that the specified replication instance supports as a target.
" } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.databasemigrationservice#DescribeEventCategories": { - "type": "operation", - "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeEventCategoriesMessage" - }, - "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeEventCategoriesResponse" - }, - "traits": { - "smithy.api#documentation": "Lists categories for all event source types, or, if specified, for a specified source\n type. You can see a list of the event categories and source types in Working with Events\n and Notifications in the Database Migration Service User\n Guide.\n
" - } - }, - "com.amazonaws.databasemigrationservice#DescribeEventCategoriesMessage": { - "type": "structure", - "members": { - "SourceType": { - "target": "com.amazonaws.databasemigrationservice#String", + }, + "MigrationType": { + "target": "com.amazonaws.databasemigrationservice#MigrationTypeValue", "traits": { - "smithy.api#documentation": "The type of DMS resource that generates events.
\nValid values: replication-instance | replication-task
" + "smithy.api#documentation": "Name of the migration type that each provided individual assessment must support.
" } }, - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "Filters applied to the event categories.
" + "smithy.api#documentation": "Maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in\n the response so that the remaining results can be retrieved.
Optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
A list of event categories.
" + "smithy.api#documentation": "List of names for the individual assessments supported by the premigration assessment\n run that you start based on the specified request parameters. For more information on the\n available individual assessments, including compatibility with different migration task\n configurations, see Working with premigration assessment runs in the\n Database Migration Service User Guide.\n
" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Pagination token returned for you to pass to a subsequent request. If you pass this\n token as the Marker value in a subsequent request, the response includes only\n records beyond the marker, up to the value specified in the request by\n MaxRecords.
Lists all the event subscriptions for a customer account. The description of a\n subscription includes SubscriptionName, SNSTopicARN,\n CustomerID, SourceType, SourceID,\n CreationTime, and Status.
If you specify SubscriptionName, this action lists the description for that\n subscription.
Provides a description of the certificate.
", + "smithy.api#examples": [ + { + "title": "Describe certificates", + "documentation": "Provides a description of the certificate.", + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "MaxRecords": 123, + "Marker": "" + }, + "output": { + "Marker": "", + "Certificates": [] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -4663,25 +5256,19 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeEventSubscriptionsMessage": { + "com.amazonaws.databasemigrationservice#DescribeCertificatesMessage": { "type": "structure", "members": { - "SubscriptionName": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "The name of the DMS event subscription to be described.
" - } - }, "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "Filters applied to event subscriptions.
\nValid filter names: event-subscription-arn | event-subscription-id
" + "smithy.api#documentation": "Filters applied to the certificates described in the form of key-value pairs. \n Valid values are certificate-arn and certificate-id.
The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": " The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 10
" } }, "Marker": { @@ -4692,90 +5279,117 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeEventSubscriptionsResponse": { + "com.amazonaws.databasemigrationservice#DescribeCertificatesResponse": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
The pagination token.
" } }, - "EventSubscriptionsList": { - "target": "com.amazonaws.databasemigrationservice#EventSubscriptionsList", + "Certificates": { + "target": "com.amazonaws.databasemigrationservice#CertificateList", "traits": { - "smithy.api#documentation": "A list of event subscriptions.
" + "smithy.api#documentation": "The Secure Sockets Layer (SSL) certificates associated with the replication\n instance.
" } } }, "traits": { - "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeEvents": { + "com.amazonaws.databasemigrationservice#DescribeConnections": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeEventsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeConnectionsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeEventsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeConnectionsResponse" }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], "traits": { - "smithy.api#documentation": "Lists events for a given source identifier and source type. You can also specify a\n start and end time. For more information on DMS events, see Working with Events and\n Notifications in the Database Migration Service User\n Guide.\n
", + "smithy.api#documentation": "Describes the status of the connections that have been made between the replication\n instance and an endpoint. Connections are created when you test an endpoint.
", + "smithy.api#examples": [ + { + "title": "Describe connections", + "documentation": "Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.", + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "MaxRecords": 123, + "Marker": "" + }, + "output": { + "Marker": "", + "Connections": [ + { + "Status": "successful", + "ReplicationInstanceIdentifier": "test", + "EndpointArn": "arn:aws:dms:us-east-arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "EndpointIdentifier": "testsrc1", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", "pageSize": "MaxRecords" + }, + "smithy.waiters#waitable": { + "TestConnectionSucceeds": { + "documentation": "Wait until testing connection succeeds.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Connections[].Status", + "expected": "successful", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Connections[].Status", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 5 + } } } }, - "com.amazonaws.databasemigrationservice#DescribeEventsMessage": { + "com.amazonaws.databasemigrationservice#DescribeConnectionsMessage": { "type": "structure", "members": { - "SourceIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "The identifier of an event source.
" - } - }, - "SourceType": { - "target": "com.amazonaws.databasemigrationservice#SourceType", - "traits": { - "smithy.api#documentation": "The type of DMS resource that generates events.
\nValid values: replication-instance | replication-task
" - } - }, - "StartTime": { - "target": "com.amazonaws.databasemigrationservice#TStamp", - "traits": { - "smithy.api#documentation": "The start time for the events to be listed.
" - } - }, - "EndTime": { - "target": "com.amazonaws.databasemigrationservice#TStamp", - "traits": { - "smithy.api#documentation": "The end time for the events to be listed.
" - } - }, - "Duration": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", - "traits": { - "smithy.api#documentation": "The duration of the events to be listed.
" - } - }, - "EventCategories": { - "target": "com.amazonaws.databasemigrationservice#EventCategoriesList", - "traits": { - "smithy.api#documentation": "A list of event categories for the source type that you've chosen.
" - } - }, "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "Filters applied to events. The only valid filter is replication-instance-id.
The filters applied to the connection.
\nValid filter names: endpoint-arn | replication-instance-arn
" } }, "MaxRecords": { @@ -4792,10 +5406,11 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeEventsResponse": { + "com.amazonaws.databasemigrationservice#DescribeConnectionsResponse": { "type": "structure", "members": { "Marker": { @@ -4804,10 +5419,10 @@ "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
The events described.
" + "smithy.api#documentation": "A description of the connections.
" } } }, @@ -4816,47 +5431,31 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorCollectors": { + "com.amazonaws.databasemigrationservice#DescribeConversionConfiguration": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorCollectorsRequest" + "target": "com.amazonaws.databasemigrationservice#DescribeConversionConfigurationMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorCollectorsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeConversionConfigurationResponse" }, "errors": [ { - "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } ], "traits": { - "smithy.api#documentation": "Returns a list of the Fleet Advisor collectors in your account.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxRecords" - } + "smithy.api#documentation": "Returns configuration parameters for a schema conversion project.
" } }, - "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorCollectorsRequest": { + "com.amazonaws.databasemigrationservice#DescribeConversionConfigurationMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", - "traits": { - "smithy.api#documentation": "If you specify any of the following filters, the output includes information for only\n those collectors that meet the filter criteria:
\n\n collector-referenced-id – The ID of the collector agent,\n for example d4610ac5-e323-4ad9-bc50-eaf7249dfe9d.
\n collector-name – The name of the collector agent.
An example is: describe-fleet-advisor-collectors --filter\n Name=\"collector-referenced-id\",Values=\"d4610ac5-e323-4ad9-bc50-eaf7249dfe9d\"\n
Sets the maximum number of records returned in the response.
" - } - }, - "NextToken": { + "MigrationProjectIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "If NextToken is returned by a previous response, there are more results\n available. The value of NextToken is a unique pagination token for each\n page. Make the call again using the returned token to retrieve the next page. Keep all\n other arguments unchanged.
The name or Amazon Resource Name (ARN) for the schema conversion project to describe.
", + "smithy.api#required": {} } } }, @@ -4864,19 +5463,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorCollectorsResponse": { + "com.amazonaws.databasemigrationservice#DescribeConversionConfigurationResponse": { "type": "structure", "members": { - "Collectors": { - "target": "com.amazonaws.databasemigrationservice#CollectorResponses", + "MigrationProjectIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Provides descriptions of the Fleet Advisor collectors, including the collectors' name\n and ID, and the latest inventory data.
" + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) for the schema conversion project.
" } }, - "NextToken": { + "ConversionConfiguration": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "If NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page. Keep all other arguments\n unchanged.
The configuration parameters for the schema conversion project.
" } } }, @@ -4884,47 +5483,50 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorDatabases": { + "com.amazonaws.databasemigrationservice#DescribeDataProviders": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorDatabasesRequest" + "target": "com.amazonaws.databasemigrationservice#DescribeDataProvidersMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorDatabasesResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeDataProvidersResponse" }, "errors": [ { - "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } ], "traits": { - "smithy.api#documentation": "Returns a list of Fleet Advisor databases in your account.
", + "smithy.api#documentation": "Returns a paginated list of data providers for your account in the current region.
", "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", + "inputToken": "Marker", + "outputToken": "Marker", "pageSize": "MaxRecords" } } }, - "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorDatabasesRequest": { + "com.amazonaws.databasemigrationservice#DescribeDataProvidersMessage": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "If you specify any of the following filters, the output includes information for only\n those databases that meet the filter criteria:
\n\n database-id – The ID of the database.
\n database-name – The name of the database.
\n database-engine – The name of the database engine.
\n server-ip-address – The IP address of the database\n server.
\n database-ip-address – The IP address of the\n database.
\n collector-name – The name of the associated Fleet Advisor collector.
An example is: describe-fleet-advisor-databases --filter\n Name=\"database-id\",Values=\"45\"\n
Filters applied to the data providers described in the form of key-value pairs.
" } }, "MaxRecords": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "Sets the maximum number of records returned in the response.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than \n the specified MaxRecords value, DMS includes a pagination token \n in the response so that you can retrieve the remaining results.
If NextToken is returned by a previous response, there are more results\n available. The value of NextToken is a unique pagination token for each\n page. Make the call again using the returned token to retrieve the next page. Keep all\n other arguments unchanged.
Specifies the unique pagination token that makes it possible to display the next page of results. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. \n The value of Marker is a unique pagination token for each page. To retrieve the next page, \n make the call again using the returned token and keeping all other arguments unchanged.
Provides descriptions of the Fleet Advisor collector databases, including the database's collector, ID,\n and name.
" + "smithy.api#documentation": "Specifies the unique pagination token that makes it possible to display the next page of results. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. \n The value of Marker is a unique pagination token for each page. To retrieve the next page, \n make the call again using the returned token and keeping all other arguments unchanged.
If NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page. Keep all other arguments\n unchanged.
A description of data providers.
" } } }, @@ -4952,41 +5554,43 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorLsaAnalysis": { + "com.amazonaws.databasemigrationservice#DescribeEndpointSettings": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorLsaAnalysisRequest" + "target": "com.amazonaws.databasemigrationservice#DescribeEndpointSettingsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorLsaAnalysisResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeEndpointSettingsResponse" }, - "errors": [ - { - "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" - } - ], "traits": { - "smithy.api#documentation": "Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet\n Advisor collectors.
", + "smithy.api#documentation": "Returns information about the possible endpoint settings available \n when you create an endpoint for a specific database engine.
", "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", + "inputToken": "Marker", + "outputToken": "Marker", "pageSize": "MaxRecords" } } }, - "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorLsaAnalysisRequest": { + "com.amazonaws.databasemigrationservice#DescribeEndpointSettingsMessage": { "type": "structure", "members": { + "EngineName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The database engine used for your source or target endpoint.
", + "smithy.api#required": {} + } + }, "MaxRecords": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "Sets the maximum number of records returned in the response.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than \n the specified MaxRecords value, a pagination token called a marker is included in the response \n so that the remaining results can be retrieved.
If NextToken is returned by a previous response, there are more results\n available. The value of NextToken is a unique pagination token for each\n page. Make the call again using the returned token to retrieve the next page. Keep all\n other arguments unchanged.
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.
A list of FleetAdvisorLsaAnalysisResponse objects.
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.
If NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page. Keep all other arguments\n unchanged.
Descriptions of the endpoint settings available for your source or target database engine.
" } } }, @@ -5014,152 +5618,231 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemaObjectSummary": { + "com.amazonaws.databasemigrationservice#DescribeEndpointTypes": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemaObjectSummaryRequest" + "target": "com.amazonaws.databasemigrationservice#DescribeEndpointTypesMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemaObjectSummaryResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeEndpointTypesResponse" }, - "errors": [ - { - "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" - } - ], "traits": { - "smithy.api#documentation": "Provides descriptions of the schemas discovered by your Fleet Advisor\n collectors.
", + "smithy.api#documentation": "Returns information about the type of endpoints available.
", + "smithy.api#examples": [ + { + "title": "Describe endpoint types", + "documentation": "Returns information about the type of endpoints available.", + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "MaxRecords": 123, + "Marker": "" + }, + "output": { + "Marker": "", + "SupportedEndpointTypes": [] + } + } + ], "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", + "inputToken": "Marker", + "outputToken": "Marker", "pageSize": "MaxRecords" } } }, - "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemaObjectSummaryRequest": { + "com.amazonaws.databasemigrationservice#DescribeEndpointTypesMessage": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "If you specify any of the following filters, the output includes information for only\n those schema objects that meet the filter criteria:
\n\n schema-id – The ID of the schema, for example\n d4610ac5-e323-4ad9-bc50-eaf7249dfe9d.
Example: describe-fleet-advisor-schema-object-summary --filter\n Name=\"schema-id\",Values=\"50\"\n
Filters applied to the endpoint types.
\nValid filter names: engine-name | endpoint-type
" } }, "MaxRecords": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "Sets the maximum number of records returned in the response.
" + "smithy.api#documentation": " The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, - "NextToken": { + "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "If NextToken is returned by a previous response, there are more results\n available. The value of NextToken is a unique pagination token for each\n page. Make the call again using the returned token to retrieve the next page. Keep all\n other arguments unchanged.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
A collection of FleetAdvisorSchemaObjectResponse objects.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
If NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page. Keep all other arguments\n unchanged.
The types of endpoints that are supported.
" } } }, "traits": { + "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemas": { + "com.amazonaws.databasemigrationservice#DescribeEndpoints": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemasRequest" + "target": "com.amazonaws.databasemigrationservice#DescribeEndpointsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemasResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeEndpointsResponse" }, "errors": [ { - "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } ], "traits": { - "smithy.api#documentation": "Returns a list of schemas detected by Fleet Advisor Collectors in your account.
", + "smithy.api#documentation": "Returns information about the endpoints for your account in the current region.
", + "smithy.api#examples": [ + { + "title": "Describe endpoints", + "documentation": "Returns information about the endpoints for your account in the current region.", + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "MaxRecords": 123, + "Marker": "" + }, + "output": { + "Marker": "", + "Endpoints": [] + } + } + ], "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", + "inputToken": "Marker", + "outputToken": "Marker", "pageSize": "MaxRecords" + }, + "smithy.waiters#waitable": { + "EndpointDeleted": { + "documentation": "Wait until testing endpoint is deleted.", + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundFault" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Endpoints[].Status", + "expected": "active", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Endpoints[].Status", + "expected": "creating", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 5 + } } } }, - "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemasRequest": { + "com.amazonaws.databasemigrationservice#DescribeEndpointsMessage": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "If you specify any of the following filters, the output includes information for only\n those schemas that meet the filter criteria:
\n\n complexity – The schema's complexity, for example\n Simple.
\n database-id – The ID of the schema's database.
\n database-ip-address – The IP address of the schema's\n database.
\n database-name – The name of the schema's database.
\n database-engine – The name of the schema database's\n engine.
\n original-schema-name – The name of the schema's database's\n main schema.
\n schema-id – The ID of the schema, for example\n 15.
\n schema-name – The name of the schema.
\n server-ip-address – The IP address of the schema\n database's server.
An example is: describe-fleet-advisor-schemas --filter\n Name=\"schema-id\",Values=\"50\"\n
Filters applied to the endpoints.
\nValid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
" } }, "MaxRecords": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "Sets the maximum number of records returned in the response.
" + "smithy.api#documentation": " The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, - "NextToken": { + "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "If NextToken is returned by a previous response, there are more results\n available. The value of NextToken is a unique pagination token for each\n page. Make the call again using the returned token to retrieve the next page. Keep all\n other arguments unchanged.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
A collection of SchemaResponse objects.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
If NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page. Keep all other arguments\n unchanged.
Endpoint description.
" } } }, "traits": { + "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstances": { + "com.amazonaws.databasemigrationservice#DescribeEngineVersions": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstancesMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeEngineVersionsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstancesResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeEngineVersionsResponse" }, "traits": { - "smithy.api#documentation": "Returns information about the replication instance types that can be created in the\n specified region.
", + "smithy.api#documentation": "Returns information about the replication instance versions used in the project.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5167,114 +5850,86 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstancesMessage": { + "com.amazonaws.databasemigrationservice#DescribeEngineVersionsMessage": { "type": "structure", "members": { "MaxRecords": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": " The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the specified \n MaxRecords value, a pagination token called a marker is included in the response so that \n the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.
The order-able replication instances available.
" + "smithy.api#documentation": "Returned EngineVersion objects that describe the replication instance engine versions used in the project.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response \n includes only records beyond the marker, up to the value specified by MaxRecords.
For internal use only
", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "pageSize": "MaxRecords" - } + "smithy.api#documentation": "Lists categories for all event source types, or, if specified, for a specified source\n type. You can see a list of the event categories and source types in Working with Events\n and Notifications in the Database Migration Service User\n Guide.\n
" } }, - "com.amazonaws.databasemigrationservice#DescribePendingMaintenanceActionsMessage": { + "com.amazonaws.databasemigrationservice#DescribeEventCategoriesMessage": { "type": "structure", "members": { - "ReplicationInstanceArn": { + "SourceType": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replication instance.
" + "smithy.api#documentation": "The type of DMS resource that generates events.
\nValid values: replication-instance | replication-task
" } }, "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "" - } - }, - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "Filters applied to the event categories.
" } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribePendingMaintenanceActionsResponse": { + "com.amazonaws.databasemigrationservice#DescribeEventCategoriesResponse": { "type": "structure", "members": { - "PendingMaintenanceActions": { - "target": "com.amazonaws.databasemigrationservice#PendingMaintenanceActions", - "traits": { - "smithy.api#documentation": "The pending maintenance action.
" - } - }, - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", + "EventCategoryGroupList": { + "target": "com.amazonaws.databasemigrationservice#EventCategoryGroupList", "traits": { - "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
A list of event categories.
" } } }, @@ -5283,335 +5938,444 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeRecommendationLimitations": { + "com.amazonaws.databasemigrationservice#DescribeEventSubscriptions": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeRecommendationLimitationsRequest" + "target": "com.amazonaws.databasemigrationservice#DescribeEventSubscriptionsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeRecommendationLimitationsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeEventSubscriptionsResponse" }, "errors": [ { - "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" - }, - { - "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } ], "traits": { - "smithy.api#documentation": "Returns a paginated list of limitations for recommendations of target Amazon Web Services\n engines.
", + "smithy.api#documentation": "Lists all the event subscriptions for a customer account. The description of a\n subscription includes SubscriptionName, SNSTopicARN,\n CustomerID, SourceType, SourceID,\n CreationTime, and Status.
If you specify SubscriptionName, this action lists the description for that\n subscription.
The name of the DMS event subscription to be described.
" + } + }, "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "Filters applied to the limitations described in the form of key-value pairs.
" + "smithy.api#documentation": "Filters applied to event subscriptions.
\nValid filter names: event-subscription-arn | event-subscription-id
" } }, "MaxRecords": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, Fleet Advisor includes a pagination token\n in the response so that you can retrieve the remaining results.
The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" } }, - "NextToken": { + "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Specifies the unique pagination token that makes it possible to display the next page\n of results. If this parameter is specified, the response includes only records beyond\n the marker, up to the value specified by MaxRecords.
If NextToken is returned by a previous response, there are more results\n available. The value of NextToken is a unique pagination token for each\n page. Make the call again using the returned token to retrieve the next page. Keep all\n other arguments unchanged.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
The unique pagination token returned for you to pass to a subsequent request. Fleet\n Advisor returns this token when the number of records in the response is greater than\n the MaxRecords value. To retrieve the next page, make the call again using\n the returned token and keeping all other arguments unchanged.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
The list of limitations for recommendations of target Amazon Web Services engines.
" + "smithy.api#documentation": "A list of event subscriptions.
" } } }, "traits": { + "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeRecommendations": { + "com.amazonaws.databasemigrationservice#DescribeEvents": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeRecommendationsRequest" + "target": "com.amazonaws.databasemigrationservice#DescribeEventsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeRecommendationsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeEventsResponse" }, - "errors": [ - { - "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" - }, - { - "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" - } - ], "traits": { - "smithy.api#documentation": "Returns a paginated list of target engine recommendations for your source\n databases.
", + "smithy.api#documentation": "Lists events for a given source identifier and source type. You can also specify a\n start and end time. For more information on DMS events, see Working with Events and\n Notifications in the Database Migration Service User\n Guide.\n
", "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", + "inputToken": "Marker", + "outputToken": "Marker", "pageSize": "MaxRecords" } } }, - "com.amazonaws.databasemigrationservice#DescribeRecommendationsRequest": { + "com.amazonaws.databasemigrationservice#DescribeEventsMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", + "SourceIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Filters applied to the target engine recommendations described in the form of\n key-value pairs.
" + "smithy.api#documentation": "The identifier of an event source.
" } }, - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "SourceType": { + "target": "com.amazonaws.databasemigrationservice#SourceType", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, Fleet Advisor includes a pagination token\n in the response so that you can retrieve the remaining results.
The type of DMS resource that generates events.
\nValid values: replication-instance | replication-task
" } }, - "NextToken": { - "target": "com.amazonaws.databasemigrationservice#String", + "StartTime": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "Specifies the unique pagination token that makes it possible to display the next page\n of results. If this parameter is specified, the response includes only records beyond\n the marker, up to the value specified by MaxRecords.
If NextToken is returned by a previous response, there are more results\n available. The value of NextToken is a unique pagination token for each\n page. Make the call again using the returned token to retrieve the next page. Keep all\n other arguments unchanged.
The start time for the events to be listed.
" } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.databasemigrationservice#DescribeRecommendationsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.databasemigrationservice#String", + }, + "EndTime": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "The unique pagination token returned for you to pass to a subsequent request. Fleet\n Advisor returns this token when the number of records in the response is greater than\n the MaxRecords value. To retrieve the next page, make the call again using\n the returned token and keeping all other arguments unchanged.
The end time for the events to be listed.
" } }, - "Recommendations": { - "target": "com.amazonaws.databasemigrationservice#RecommendationList", + "Duration": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "The list of recommendations of target engines that Fleet Advisor created for the\n source database.
" + "smithy.api#documentation": "The duration of the events to be listed.
" + } + }, + "EventCategories": { + "target": "com.amazonaws.databasemigrationservice#EventCategoriesList", + "traits": { + "smithy.api#documentation": "A list of event categories for the source type that you've chosen.
" + } + }, + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "Filters applied to events. The only valid filter is replication-instance-id.
The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
The events described.
" } } }, "traits": { + "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeRefreshSchemasStatus": { + "com.amazonaws.databasemigrationservice#DescribeExtensionPackAssociations": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeRefreshSchemasStatusMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeExtensionPackAssociationsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeRefreshSchemasStatusResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeExtensionPackAssociationsResponse" }, - "errors": [ - { - "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" - }, - { - "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" - } - ], "traits": { - "smithy.api#documentation": "Returns the status of the RefreshSchemas operation.
" + "smithy.api#documentation": "Returns a paginated list of extension pack associations for the specified migration project.\n An extension pack is an add-on module \n that emulates functions present in a source database that are required when converting objects \n to the target database.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } } }, - "com.amazonaws.databasemigrationservice#DescribeRefreshSchemasStatusMessage": { + "com.amazonaws.databasemigrationservice#DescribeExtensionPackAssociationsMessage": { "type": "structure", "members": { - "EndpointArn": { + "MigrationProjectIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) for the migration project.
", "smithy.api#required": {} } + }, + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "Filters applied to the extension pack associations described in the form of key-value pairs.
" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Specifies the unique pagination token that makes it possible to display the next page of results. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. \n The value of Marker is a unique pagination token for each page. To retrieve the next page, \n make the call again using the returned token and keeping all other arguments unchanged.
The maximum number of records to include in the response. If more records exist than \n the specified MaxRecords value, DMS includes a pagination token \n in the response so that you can retrieve the remaining results.
The status of the schema.
" + "smithy.api#documentation": "Specifies the unique pagination token that makes it possible to display the next page of results. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. \n The value of Marker is a unique pagination token for each page. To retrieve the next page, \n make the call again using the returned token and keeping all other arguments unchanged.
A paginated list of extension pack associations for the specified migration project.
" } } }, "traits": { - "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationConfigs": { + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorCollectors": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationConfigsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorCollectorsRequest" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationConfigsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorCollectorsResponse" }, "errors": [ { - "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" } ], "traits": { - "smithy.api#documentation": "Returns one or more existing DMS Serverless replication configurations as a list of structures.
", + "smithy.api#documentation": "Returns a list of the Fleet Advisor collectors in your account.
", "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", + "inputToken": "NextToken", + "outputToken": "NextToken", "pageSize": "MaxRecords" } } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationConfigsMessage": { + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorCollectorsRequest": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "Filters applied to the replication configs.
" + "smithy.api#documentation": "If you specify any of the following filters, the output includes information for only\n those collectors that meet the filter criteria:
\n\n collector-referenced-id – The ID of the collector agent,\n for example d4610ac5-e323-4ad9-bc50-eaf7249dfe9d.
\n collector-name – The name of the collector agent.
An example is: describe-fleet-advisor-collectors --filter\n Name=\"collector-referenced-id\",Values=\"d4610ac5-e323-4ad9-bc50-eaf7249dfe9d\"\n
The maximum number of records to include in the response. If more records exist than the specified \n MaxRecords value, a pagination token called a marker is included in the response so that \n the remaining results can be retrieved.
Sets the maximum number of records returned in the response.
" } }, - "Marker": { + "NextToken": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.
If NextToken is returned by a previous response, there are more results\n available. The value of NextToken is a unique pagination token for each\n page. Make the call again using the returned token to retrieve the next page. Keep all\n other arguments unchanged.
An optional pagination token provided by a previous request. If this parameter is specified, the response \n includes only records beyond the marker, up to the value specified by MaxRecords.
Provides descriptions of the Fleet Advisor collectors, including the collectors' name\n and ID, and the latest inventory data.
" } }, - "ReplicationConfigs": { - "target": "com.amazonaws.databasemigrationservice#ReplicationConfigList", + "NextToken": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Returned configuration parameters that describe each provisioned DMS Serverless replication.
" + "smithy.api#documentation": "If NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page. Keep all other arguments\n unchanged.
Returns information about the task logs for the specified task.
", + "smithy.api#documentation": "Returns a list of Fleet Advisor databases in your account.
", "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", + "inputToken": "NextToken", + "outputToken": "NextToken", "pageSize": "MaxRecords" } } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationInstanceTaskLogsMessage": { + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorDatabasesRequest": { "type": "structure", "members": { - "ReplicationInstanceArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replication instance.
", - "smithy.api#required": {} + "smithy.api#documentation": "If you specify any of the following filters, the output includes information for only\n those databases that meet the filter criteria:
\n\n database-id – The ID of the database.
\n database-name – The name of the database.
\n database-engine – The name of the database engine.
\n server-ip-address – The IP address of the database\n server.
\n database-ip-address – The IP address of the\n database.
\n collector-name – The name of the associated Fleet Advisor collector.
An example is: describe-fleet-advisor-databases --filter\n Name=\"database-id\",Values=\"45\"\n
The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "Sets the maximum number of records returned in the response.
" } }, - "Marker": { + "NextToken": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
If NextToken is returned by a previous response, there are more results\n available. The value of NextToken is a unique pagination token for each\n page. Make the call again using the returned token to retrieve the next page. Keep all\n other arguments unchanged.
Provides descriptions of the Fleet Advisor collector databases, including the database's collector, ID,\n and name.
" + } + }, + "NextToken": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replication instance.
" + "smithy.api#documentation": "If NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page. Keep all other arguments\n unchanged.
Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet\n Advisor collectors.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorLsaAnalysisRequest": { + "type": "structure", + "members": { + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "Sets the maximum number of records returned in the response.
" } }, - "ReplicationInstanceTaskLogs": { - "target": "com.amazonaws.databasemigrationservice#ReplicationInstanceTaskLogsList", + "NextToken": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "An array of replication task log metadata. Each member of the array contains the\n replication task name, ARN, and task log size (in bytes).
" + "smithy.api#documentation": "If NextToken is returned by a previous response, there are more results\n available. The value of NextToken is a unique pagination token for each\n page. Make the call again using the returned token to retrieve the next page. Keep all\n other arguments unchanged.
A list of FleetAdvisorLsaAnalysisResponse objects.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
If NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page. Keep all other arguments\n unchanged.
Returns information about replication instances for your account in the current\n region.
", + "smithy.api#documentation": "Provides descriptions of the schemas discovered by your Fleet Advisor\n collectors.
", "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", + "inputToken": "NextToken", + "outputToken": "NextToken", "pageSize": "MaxRecords" - }, - "smithy.waiters#waitable": { - "ReplicationInstanceAvailable": { - "documentation": "Wait until DMS replication instance is available.", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "ReplicationInstances[].ReplicationInstanceStatus", - "expected": "available", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationInstances[].ReplicationInstanceStatus", - "expected": "deleting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationInstances[].ReplicationInstanceStatus", - "expected": "incompatible-credentials", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationInstances[].ReplicationInstanceStatus", - "expected": "incompatible-network", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationInstances[].ReplicationInstanceStatus", - "expected": "inaccessible-encryption-credentials", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 60 - }, - "ReplicationInstanceDeleted": { - "documentation": "Wait until DMS replication instance is deleted.", - "acceptors": [ - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationInstances[].ReplicationInstanceStatus", - "expected": "available", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "errorType": "ResourceNotFoundFault" - } - } - ], - "minDelay": 15 - } } } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationInstancesMessage": { + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemaObjectSummaryRequest": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "Filters applied to replication instances.
\nValid filter names: replication-instance-arn | replication-instance-id |\n replication-instance-class | engine-version
" + "smithy.api#documentation": "If you specify any of the following filters, the output includes information for only\n those schema objects that meet the filter criteria:
\n\n schema-id – The ID of the schema, for example\n d4610ac5-e323-4ad9-bc50-eaf7249dfe9d.
Example: describe-fleet-advisor-schema-object-summary --filter\n Name=\"schema-id\",Values=\"50\"\n
The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "Sets the maximum number of records returned in the response.
" } }, - "Marker": { + "NextToken": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
If NextToken is returned by a previous response, there are more results\n available. The value of NextToken is a unique pagination token for each\n page. Make the call again using the returned token to retrieve the next page. Keep all\n other arguments unchanged.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
A collection of FleetAdvisorSchemaObjectResponse objects.
The replication instances described.
" + "smithy.api#documentation": "If NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page. Keep all other arguments\n unchanged.
Returns information about the replication subnet groups.
", + "smithy.api#documentation": "Returns a list of schemas detected by Fleet Advisor Collectors in your account.
", "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", + "inputToken": "NextToken", + "outputToken": "NextToken", "pageSize": "MaxRecords" } } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationSubnetGroupsMessage": { + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemasRequest": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "Filters applied to replication subnet groups.
\nValid filter names: replication-subnet-group-id
" + "smithy.api#documentation": "If you specify any of the following filters, the output includes information for only\n those schemas that meet the filter criteria:
\n\n complexity – The schema's complexity, for example\n Simple.
\n database-id – The ID of the schema's database.
\n database-ip-address – The IP address of the schema's\n database.
\n database-name – The name of the schema's database.
\n database-engine – The name of the schema database's\n engine.
\n original-schema-name – The name of the schema's database's\n main schema.
\n schema-id – The ID of the schema, for example\n 15.
\n schema-name – The name of the schema.
\n server-ip-address – The IP address of the schema\n database's server.
An example is: describe-fleet-advisor-schemas --filter\n Name=\"schema-id\",Values=\"50\"\n
The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "Sets the maximum number of records returned in the response.
" } }, - "Marker": { + "NextToken": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
If NextToken is returned by a previous response, there are more results\n available. The value of NextToken is a unique pagination token for each\n page. Make the call again using the returned token to retrieve the next page. Keep all\n other arguments unchanged.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
A collection of SchemaResponse objects.
A description of the replication subnet groups.
" + "smithy.api#documentation": "If NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page. Keep all other arguments\n unchanged.
Returns table and schema statistics for one or more provisioned replications that use a\n given DMS Serverless replication configuration.
", + "smithy.api#documentation": "Returns a paginated list of instance profiles for your account in the current region.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5862,73 +6544,59 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatisticsMessage": { + "com.amazonaws.databasemigrationservice#DescribeInstanceProfilesMessage": { "type": "structure", "members": { - "ReplicationConfigArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "The replication config to describe.
", - "smithy.api#required": {} + "smithy.api#documentation": "Filters applied to the instance profiles described in the form of key-value pairs.
" } }, "MaxRecords": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the specified \n MaxRecords value, a pagination token called a marker is included in the response so that \n the remaining results can be retrieved.
The maximum number of records to include in the response. If more records exist than \n the specified MaxRecords value, DMS includes a pagination token \n in the response so that you can retrieve the remaining results.
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.
Filters applied to the replication table statistics.
" + "smithy.api#documentation": "Specifies the unique pagination token that makes it possible to display the next page of results. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. \n The value of Marker is a unique pagination token for each page. To retrieve the next page, \n make the call again using the returned token and keeping all other arguments unchanged.
The Amazon Resource Name of the replication config.
" - } - }, "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.
Specifies the unique pagination token that makes it possible to display the next page of results. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. \n The value of Marker is a unique pagination token for each page. To retrieve the next page, \n make the call again using the returned token and keeping all other arguments unchanged.
Returns table statistics on the replication, including table name, rows inserted, rows updated, and rows deleted.
" + "smithy.api#documentation": "A description of instance profiles.
" } } }, "traits": { - "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResults": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelAssessments": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelAssessmentsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelAssessmentsResponse" }, "errors": [ { @@ -5936,7 +6604,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the task assessment results from the Amazon S3 bucket that DMS creates in your\n Amazon Web Services account. This action always returns the\n latest results.
\nFor more information about DMS task assessments, see \n Creating a task assessment report\n in the Database Migration Service User Guide.
", + "smithy.api#documentation": "Returns a paginated list of metadata model assessments for your account in the current region.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5944,66 +6612,66 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsMessage": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelAssessmentsMessage": { "type": "structure", "members": { - "ReplicationTaskArn": { + "MigrationProjectIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input\n parameter is specified, the API returns only one result and ignore the values of the\n MaxRecords and Marker parameters.
The name or Amazon Resource Name (ARN) of the migration project.
", + "smithy.api#required": {} } }, - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": " The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + "smithy.api#documentation": "Filters applied to the metadata model assessments described in the form of key-value pairs.
" } }, "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
Specifies the unique pagination token that makes it possible to display the next page of results. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. \n The value of Marker is a unique pagination token for each page. To retrieve the next page, \n make the call again using the returned token and keeping all other arguments unchanged.
The maximum number of records to include in the response. If more records exist than \n the specified MaxRecords value, DMS includes a pagination token \n in the response so that you can retrieve the remaining results.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
- The Amazon S3 bucket where the task assessment report is located.
" + "smithy.api#documentation": "Specifies the unique pagination token that makes it possible to display the next page of results. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. \n The value of Marker is a unique pagination token for each page. To retrieve the next page, \n make the call again using the returned token and keeping all other arguments unchanged.
The task assessment report.
" + "smithy.api#documentation": "A paginated list of metadata model assessments for the specified migration project.
" } } }, "traits": { - "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentRuns": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelConversions": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentRunsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelConversionsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentRunsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelConversionsResponse" }, "errors": [ { @@ -6011,7 +6679,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a paginated list of premigration assessment runs based on filter\n settings.
\nThese filter settings can specify a combination of premigration assessment runs,\n migration tasks, replication instances, and assessment run status values.
\nThis operation doesn't return information about individual assessments. For this\n information, see the DescribeReplicationTaskIndividualAssessments\n operation.
Returns a paginated list of metadata model conversions for a migration project.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -6019,60 +6687,66 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentRunsMessage": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelConversionsMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", + "MigrationProjectIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Filters applied to the premigration assessment runs described in the form of key-value pairs.
\nValid filter names: replication-task-assessment-run-arn, replication-task-arn,\n replication-instance-arn, status\n
The migration project name or Amazon Resource Name (ARN).
", + "smithy.api#required": {} } }, - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in\n the response so that the remaining results can be retrieved.
Filters applied to the metadata model conversions described in the form of key-value pairs.
" } }, "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
Specifies the unique pagination token that makes it possible to display the next page of results. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. \n The value of Marker is a unique pagination token for each page. To retrieve the next page, \n make the call again using the returned token and keeping all other arguments unchanged.
The maximum number of records to include in the response. If more records exist than \n the specified MaxRecords value, DMS includes a pagination token \n in the response so that you can retrieve the remaining results.
A pagination token returned for you to pass to a subsequent request. If you pass this\n token as the Marker value in a subsequent request, the response includes only\n records beyond the marker, up to the value specified in the request by\n MaxRecords.
Specifies the unique pagination token that makes it possible to display the next page of results. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. \n The value of Marker is a unique pagination token for each page. To retrieve the next page, \n make the call again using the returned token and keeping all other arguments unchanged.
One or more premigration assessment runs as specified by Filters.
A paginated list of metadata model conversions.
" } } }, "traits": { - "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTaskIndividualAssessments": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsAsScript": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskIndividualAssessmentsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsAsScriptMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskIndividualAssessmentsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsAsScriptResponse" }, "errors": [ { @@ -6080,7 +6754,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a paginated list of individual assessments based on filter settings.
\nThese filter settings can specify a combination of premigration assessment runs,\n migration tasks, and assessment status values.
", + "smithy.api#documentation": "Returns a paginated list of metadata model exports.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -6088,30 +6762,1327 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTaskIndividualAssessmentsMessage": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsAsScriptMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", + "MigrationProjectIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Filters applied to the individual assessments described in the form of key-value\n pairs.
\nValid filter names: replication-task-assessment-run-arn,\n replication-task-arn, status\n
The migration project name or Amazon Resource Name (ARN).
", + "smithy.api#required": {} } }, - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in\n the response so that the remaining results can be retrieved.
Filters applied to the metadata model exports described in the form of key-value pairs.
" } }, "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
Specifies the unique pagination token that makes it possible to display the next page of results. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. \n The value of Marker is a unique pagination token for each page. To retrieve the next page, \n make the call again using the returned token and keeping all other arguments unchanged.
The maximum number of records to include in the response. If more records exist than \n the specified MaxRecords value, DMS includes a pagination token \n in the response so that you can retrieve the remaining results.
Specifies the unique pagination token that makes it possible to display the next page of results. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. \n The value of Marker is a unique pagination token for each page. To retrieve the next page, \n make the call again using the returned token and keeping all other arguments unchanged.
A paginated list of metadata model exports.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsToTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsToTargetMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsToTargetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Returns a paginated list of metadata model exports.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsToTargetMessage": { + "type": "structure", + "members": { + "MigrationProjectIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "Filters applied to the metadata model exports described in the form of key-value pairs.
" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Specifies the unique pagination token that makes it possible to display the next page of results. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. \n The value of Marker is a unique pagination token for each page. To retrieve the next page, \n make the call again using the returned token and keeping all other arguments unchanged.
The maximum number of records to include in the response. If more records exist than \n the specified MaxRecords value, DMS includes a pagination token \n in the response so that you can retrieve the remaining results.
Specifies the unique pagination token that makes it possible to display the next page of results. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. \n The value of Marker is a unique pagination token for each page. To retrieve the next page, \n make the call again using the returned token and keeping all other arguments unchanged.
A paginated list of metadata model exports.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeMetadataModelImports": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelImportsMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelImportsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Returns a paginated list of metadata model imports.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeMetadataModelImportsMessage": { + "type": "structure", + "members": { + "MigrationProjectIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "Filters applied to the metadata model imports described in the form of key-value pairs.
" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Specifies the unique pagination token that makes it possible to display the next page of results. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. \n The value of Marker is a unique pagination token for each page. To retrieve the next page, \n make the call again using the returned token and keeping all other arguments unchanged.
A paginated list of metadata model imports.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeMetadataModelImportsResponse": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Specifies the unique pagination token that makes it possible to display the next page of results. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. \n The value of Marker is a unique pagination token for each page. To retrieve the next page, \n make the call again using the returned token and keeping all other arguments unchanged.
A paginated list of metadata model imports.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeMigrationProjects": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeMigrationProjectsMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeMigrationProjectsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Returns a paginated list of migration projects for your account in the current region.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeMigrationProjectsMessage": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "Filters applied to the migration projects described in the form of key-value pairs.
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than \n the specified MaxRecords value, DMS includes a pagination token \n in the response so that you can retrieve the remaining results.
Specifies the unique pagination token that makes it possible to display the next page of results. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. \n The value of Marker is a unique pagination token for each page. To retrieve the next page, \n make the call again using the returned token and keeping all other arguments unchanged.
Specifies the unique pagination token that makes it possible to display the next page of results. \n If this parameter is specified, the response includes only records beyond the marker, up to the \n value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. \n The value of Marker is a unique pagination token for each page. To retrieve the next page, \n make the call again using the returned token and keeping all other arguments unchanged.
A description of migration projects.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstancesMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstancesResponse" + }, + "traits": { + "smithy.api#documentation": "Returns information about the replication instance types that can be created in the\n specified region.
", + "smithy.api#examples": [ + { + "title": "Describe orderable replication instances", + "documentation": "Returns information about the replication instance types that can be created in the specified region.", + "input": { + "MaxRecords": 123, + "Marker": "" + }, + "output": { + "OrderableReplicationInstances": [], + "Marker": "" + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstancesMessage": { + "type": "structure", + "members": { + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": " The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
The order-able replication instances available.
" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
For internal use only
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribePendingMaintenanceActionsMessage": { + "type": "structure", + "members": { + "ReplicationInstanceArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replication instance.
" + } + }, + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribePendingMaintenanceActionsResponse": { + "type": "structure", + "members": { + "PendingMaintenanceActions": { + "target": "com.amazonaws.databasemigrationservice#PendingMaintenanceActions", + "traits": { + "smithy.api#documentation": "The pending maintenance action.
" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
Returns a paginated list of limitations for recommendations of target Amazon Web Services\n engines.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeRecommendationLimitationsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "Filters applied to the limitations described in the form of key-value pairs.
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, Fleet Advisor includes a pagination token\n in the response so that you can retrieve the remaining results.
Specifies the unique pagination token that makes it possible to display the next page\n of results. If this parameter is specified, the response includes only records beyond\n the marker, up to the value specified by MaxRecords.
If NextToken is returned by a previous response, there are more results\n available. The value of NextToken is a unique pagination token for each\n page. Make the call again using the returned token to retrieve the next page. Keep all\n other arguments unchanged.
The unique pagination token returned for you to pass to a subsequent request. Fleet\n Advisor returns this token when the number of records in the response is greater than\n the MaxRecords value. To retrieve the next page, make the call again using\n the returned token and keeping all other arguments unchanged.
The list of limitations for recommendations of target Amazon Web Services engines.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeRecommendations": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeRecommendationsRequest" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeRecommendationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "Returns a paginated list of target engine recommendations for your source\n databases.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeRecommendationsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "Filters applied to the target engine recommendations described in the form of\n key-value pairs.
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, Fleet Advisor includes a pagination token\n in the response so that you can retrieve the remaining results.
Specifies the unique pagination token that makes it possible to display the next page\n of results. If this parameter is specified, the response includes only records beyond\n the marker, up to the value specified by MaxRecords.
If NextToken is returned by a previous response, there are more results\n available. The value of NextToken is a unique pagination token for each\n page. Make the call again using the returned token to retrieve the next page. Keep all\n other arguments unchanged.
The unique pagination token returned for you to pass to a subsequent request. Fleet\n Advisor returns this token when the number of records in the response is greater than\n the MaxRecords value. To retrieve the next page, make the call again using\n the returned token and keeping all other arguments unchanged.
The list of recommendations of target engines that Fleet Advisor created for the\n source database.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeRefreshSchemasStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeRefreshSchemasStatusMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeRefreshSchemasStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Returns the status of the RefreshSchemas operation.
", + "smithy.api#examples": [ + { + "title": "Describe refresh schema status", + "documentation": "Returns the status of the refresh-schemas operation.", + "input": { + "EndpointArn": "" + }, + "output": { + "RefreshSchemasStatus": {} + } + } + ] + } + }, + "com.amazonaws.databasemigrationservice#DescribeRefreshSchemasStatusMessage": { + "type": "structure", + "members": { + "EndpointArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeRefreshSchemasStatusResponse": { + "type": "structure", + "members": { + "RefreshSchemasStatus": { + "target": "com.amazonaws.databasemigrationservice#RefreshSchemasStatus", + "traits": { + "smithy.api#documentation": "The status of the schema.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationConfigsMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Returns one or more existing DMS Serverless replication configurations as a list of structures.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationConfigsMessage": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "Filters applied to the replication configs.
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the specified \n MaxRecords value, a pagination token called a marker is included in the response so that \n the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response \n includes only records beyond the marker, up to the value specified by MaxRecords.
Returned configuration parameters that describe each provisioned DMS Serverless replication.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationInstanceTaskLogs": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationInstanceTaskLogsMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationInstanceTaskLogsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about the task logs for the specified task.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationInstanceTaskLogsMessage": { + "type": "structure", + "members": { + "ReplicationInstanceArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replication instance.
", + "smithy.api#required": {} + } + }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": " The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
The Amazon Resource Name (ARN) of the replication instance.
" + } + }, + "ReplicationInstanceTaskLogs": { + "target": "com.amazonaws.databasemigrationservice#ReplicationInstanceTaskLogsList", + "traits": { + "smithy.api#documentation": "An array of replication task log metadata. Each member of the array contains the\n replication task name, ARN, and task log size (in bytes).
" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
Returns information about replication instances for your account in the current\n region.
", + "smithy.api#examples": [ + { + "title": "Describe replication instances", + "documentation": "Returns the status of the refresh-schemas operation.", + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "MaxRecords": 123, + "Marker": "" + }, + "output": { + "Marker": "", + "ReplicationInstances": [] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + }, + "smithy.waiters#waitable": { + "ReplicationInstanceAvailable": { + "documentation": "Wait until DMS replication instance is available.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ReplicationInstances[].ReplicationInstanceStatus", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationInstances[].ReplicationInstanceStatus", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationInstances[].ReplicationInstanceStatus", + "expected": "incompatible-credentials", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationInstances[].ReplicationInstanceStatus", + "expected": "incompatible-network", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationInstances[].ReplicationInstanceStatus", + "expected": "inaccessible-encryption-credentials", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 60 + }, + "ReplicationInstanceDeleted": { + "documentation": "Wait until DMS replication instance is deleted.", + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationInstances[].ReplicationInstanceStatus", + "expected": "available", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundFault" + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationInstancesMessage": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "Filters applied to replication instances.
\nValid filter names: replication-instance-arn | replication-instance-id |\n replication-instance-class | engine-version
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": " The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
The replication instances described.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationSubnetGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationSubnetGroupsMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationSubnetGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about the replication subnet groups.
", + "smithy.api#examples": [ + { + "title": "Describe replication subnet groups", + "documentation": "Returns information about the replication subnet groups.", + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "MaxRecords": 123, + "Marker": "" + }, + "output": { + "Marker": "", + "ReplicationSubnetGroups": [] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationSubnetGroupsMessage": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "Filters applied to replication subnet groups.
\nValid filter names: replication-subnet-group-id
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": " The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
A description of the replication subnet groups.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatistics": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatisticsMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatisticsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Returns table and schema statistics for one or more provisioned replications that use a\n given DMS Serverless replication configuration.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatisticsMessage": { + "type": "structure", + "members": { + "ReplicationConfigArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The replication config to describe.
", + "smithy.api#required": {} + } + }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the specified \n MaxRecords value, a pagination token called a marker is included in the response so that \n the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.
Filters applied to the replication table statistics.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatisticsResponse": { + "type": "structure", + "members": { + "ReplicationConfigArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of the replication config.
" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.
Returns table statistics on the replication, including table name, rows inserted, rows updated, and rows deleted.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Returns the task assessment results from the Amazon S3 bucket that DMS creates in your\n Amazon Web Services account. This action always returns the\n latest results.
\nFor more information about DMS task assessments, see \n Creating a task assessment report\n in the Database Migration Service User Guide.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsMessage": { + "type": "structure", + "members": { + "ReplicationTaskArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input\n parameter is specified, the API returns only one result and ignore the values of the\n MaxRecords and Marker parameters.
The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.
Default: 100
\nConstraints: Minimum 20, maximum 100.
" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": " An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
- The Amazon S3 bucket where the task assessment report is located.
" + } + }, + "ReplicationTaskAssessmentResults": { + "target": "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentResultList", + "traits": { + "smithy.api#documentation": "The task assessment report.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentRuns": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentRunsMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentRunsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Returns a paginated list of premigration assessment runs based on filter\n settings.
\nThese filter settings can specify a combination of premigration assessment runs,\n migration tasks, replication instances, and assessment run status values.
\nThis operation doesn't return information about individual assessments. For this\n information, see the DescribeReplicationTaskIndividualAssessments\n operation.
Filters applied to the premigration assessment runs described in the form of key-value pairs.
\nValid filter names: replication-task-assessment-run-arn, replication-task-arn,\n replication-instance-arn, status\n
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in\n the response so that the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
A pagination token returned for you to pass to a subsequent request. If you pass this\n token as the Marker value in a subsequent request, the response includes only\n records beyond the marker, up to the value specified in the request by\n MaxRecords.
One or more premigration assessment runs as specified by Filters.
Returns a paginated list of individual assessments based on filter settings.
\nThese filter settings can specify a combination of premigration assessment runs,\n migration tasks, and assessment status values.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationTaskIndividualAssessmentsMessage": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "Filters applied to the individual assessments described in the form of key-value\n pairs.
\nValid filter names: replication-task-assessment-run-arn,\n replication-task-arn, status\n
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a pagination token called a marker is included in\n the response so that the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.
Returns information about replication tasks for your account in the current\n region.
", + "smithy.api#examples": [ + { + "title": "Describe replication tasks", + "documentation": "Returns information about replication tasks for your account in the current region.", + "input": { + "Filters": [ + { + "Name": "string", + "Values": [ + "string", + "string" + ] + } + ], + "MaxRecords": 123, + "Marker": "" + }, + "output": { + "Marker": "", + "ReplicationTasks": [] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -6528,7 +8522,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#DescribeReplicationTasksResponse": { @@ -6597,7 +8592,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#DescribeReplicationsResponse": { @@ -6639,6 +8635,21 @@ ], "traits": { "smithy.api#documentation": "Returns information about the schema for the specified endpoint.
\n ", + "smithy.api#examples": [ + { + "title": "Describe schemas", + "documentation": "Returns information about the schema for the specified endpoint.", + "input": { + "EndpointArn": "", + "MaxRecords": 123, + "Marker": "" + }, + "output": { + "Marker": "", + "Schemas": [] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -6670,7 +8681,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#DescribeSchemasResponse": { @@ -6712,6 +8724,22 @@ ], "traits": { "smithy.api#documentation": "Returns table statistics on the database migration task, including table name, rows\n inserted, rows updated, and rows deleted.
\nNote that the \"last updated\" column the DMS console only indicates the time that DMS\n last updated the table statistics record for a table. It does not indicate the time of the\n last update to the table.
", + "smithy.api#examples": [ + { + "title": "Describe table statistics", + "documentation": "Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.", + "input": { + "ReplicationTaskArn": "", + "MaxRecords": 123, + "Marker": "" + }, + "output": { + "ReplicationTaskArn": "", + "TableStatistics": [], + "Marker": "" + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -6749,7 +8777,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#DescribeTableStatisticsResponse": { @@ -7410,6 +9439,20 @@ } } }, + "com.amazonaws.databasemigrationservice#ErrorDetails": { + "type": "union", + "members": { + "defaultErrorDetails": { + "target": "com.amazonaws.databasemigrationservice#DefaultErrorDetails", + "traits": { + "smithy.api#documentation": "Error information about a project.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides error information about a project.
" + } + }, "com.amazonaws.databasemigrationservice#Event": { "type": "structure", "members": { @@ -7576,6 +9619,117 @@ "target": "com.amazonaws.databasemigrationservice#String" } }, + "com.amazonaws.databasemigrationservice#ExportMetadataModelAssessment": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#ExportMetadataModelAssessmentMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#ExportMetadataModelAssessmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Saves a copy of a database migration assessment report to your Amazon S3 bucket. DMS can save \n your assessment report as a comma-separated value (CSV) or a PDF file.
" + } + }, + "com.amazonaws.databasemigrationservice#ExportMetadataModelAssessmentMessage": { + "type": "structure", + "members": { + "MigrationProjectIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "SelectionRules": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "A value that specifies the database objects to assess.
", + "smithy.api#required": {} + } + }, + "FileName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The name of the assessment file to create in your Amazon S3 bucket.
" + } + }, + "AssessmentReportTypes": { + "target": "com.amazonaws.databasemigrationservice#AssessmentReportTypesList", + "traits": { + "smithy.api#documentation": "The file format of the assessment file.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#ExportMetadataModelAssessmentResponse": { + "type": "structure", + "members": { + "PdfReport": { + "target": "com.amazonaws.databasemigrationservice#ExportMetadataModelAssessmentResultEntry", + "traits": { + "smithy.api#documentation": "The Amazon S3 details for an assessment exported in PDF format.
" + } + }, + "CsvReport": { + "target": "com.amazonaws.databasemigrationservice#ExportMetadataModelAssessmentResultEntry", + "traits": { + "smithy.api#documentation": "The Amazon S3 details for an assessment exported in CSV format.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#ExportMetadataModelAssessmentResultEntry": { + "type": "structure", + "members": { + "S3ObjectKey": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The object key for the object containing the exported metadata model assessment.
" + } + }, + "ObjectURL": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The URL for the object containing the exported metadata model assessment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about an exported metadata model assessment.
" + } + }, + "com.amazonaws.databasemigrationservice#ExportSqlDetails": { + "type": "structure", + "members": { + "S3ObjectKey": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Amazon S3 object key for the object containing the exported metadata model assessment.
" + } + }, + "ObjectURL": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The URL for the object containing the exported metadata model assessment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about a metadata model assessment exported to SQL.
" + } + }, "com.amazonaws.databasemigrationservice#Filter": { "type": "structure", "members": { @@ -7872,7 +10026,20 @@ } ], "traits": { - "smithy.api#documentation": "Uploads the specified certificate.
" + "smithy.api#documentation": "Uploads the specified certificate.
", + "smithy.api#examples": [ + { + "title": "Import certificate", + "documentation": "Uploads the specified certificate.", + "input": { + "CertificateIdentifier": "", + "CertificatePem": "" + }, + "output": { + "Certificate": {} + } + } + ] } }, "com.amazonaws.databasemigrationservice#ImportCertificateMessage": { @@ -7902,33 +10069,113 @@ "traits": { "smithy.api#documentation": "The tags associated with the certificate.
" } - } - } - }, - "com.amazonaws.databasemigrationservice#ImportCertificateResponse": { - "type": "structure", - "members": { - "Certificate": { - "target": "com.amazonaws.databasemigrationservice#Certificate", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#ImportCertificateResponse": { + "type": "structure", + "members": { + "Certificate": { + "target": "com.amazonaws.databasemigrationservice#Certificate", + "traits": { + "smithy.api#documentation": "The certificate to be uploaded.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#IncludeTestList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#String" + } + }, + "com.amazonaws.databasemigrationservice#IndividualAssessmentNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#String" + } + }, + "com.amazonaws.databasemigrationservice#InstanceProfile": { + "type": "structure", + "members": { + "InstanceProfileArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) string that uniquely identifies the instance profile.
" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Availability Zone where the instance profile runs.
" + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that is used to encrypt \n the connection parameters for the instance profile.
\nIf you don't specify a value for the KmsKeyArn parameter, then\n DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account \n has a different default encryption key for each Amazon Web Services Region.
" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "Specifies the accessibility options for the instance profile. A value of\n true represents an instance profile with a public IP address. A value of\n false represents an instance profile with a private IP address. The default value\n is true.
Specifies the network type for the instance profile. A value of IPV4 \n represents an instance profile with IPv4 network type and only supports IPv4 addressing. \n A value of IPV6 represents an instance profile with IPv6 network type \n and only supports IPv6 addressing. A value of DUAL represents an instance \n profile with dual network type that supports IPv4 and IPv6 addressing.
The user-friendly name for the instance profile.
" + } + }, + "Description": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "A description of the instance profile. Descriptions can have up to 31 characters. \n A description can contain only ASCII letters, digits, and hyphens ('-'). Also, it can't \n end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.
" + } + }, + "InstanceProfileCreationTime": { + "target": "com.amazonaws.databasemigrationservice#Iso8601DateTime", + "traits": { + "smithy.api#documentation": "The time the instance profile was created.
" + } + }, + "SubnetGroupIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The identifier of the subnet group that is associated with the instance profile.
" + } + }, + "VpcSecurityGroups": { + "target": "com.amazonaws.databasemigrationservice#StringList", "traits": { - "smithy.api#documentation": "The certificate to be uploaded.
" + "smithy.api#documentation": "The VPC security groups that are used with the instance profile. \n The VPC security group must work with the VPC containing the instance profile.
" } } }, "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.databasemigrationservice#IncludeTestList": { - "type": "list", - "member": { - "target": "com.amazonaws.databasemigrationservice#String" + "smithy.api#documentation": "Provides information that defines an instance profile.
" } }, - "com.amazonaws.databasemigrationservice#IndividualAssessmentNameList": { + "com.amazonaws.databasemigrationservice#InstanceProfileList": { "type": "list", "member": { - "target": "com.amazonaws.databasemigrationservice#String" + "target": "com.amazonaws.databasemigrationservice#InstanceProfile", + "traits": { + "smithy.api#xmlName": "InstanceProfile" + } } }, "com.amazonaws.databasemigrationservice#InsufficientResourceCapacityFault": { @@ -8035,6 +10282,12 @@ "smithy.api#documentation": "Describes a Fleet Advisor collector inventory.
" } }, + "com.amazonaws.databasemigrationservice#Iso8601DateTime": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, "com.amazonaws.databasemigrationservice#KMSAccessDeniedFault": { "type": "structure", "members": { @@ -8451,7 +10704,19 @@ } ], "traits": { - "smithy.api#documentation": "Lists all metadata tags attached to an DMS resource, including \n replication instance, endpoint, subnet group, and migration task. \n For more information, see \n Tag\n data type description.
Lists all metadata tags attached to an DMS resource, including \n replication instance, endpoint, subnet group, and migration task. \n For more information, see \n Tag\n data type description.
Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the\n output of DescribeDBInstances,\n in the \n Endpoint.Address field.
Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the\n output of DescribeDBInstances,\n in the \n Endpoint.Address field.
Endpoint connection user name.
" + } + }, + "UseBcpFullLoad": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "Use this to attribute to transfer data for full-load operations\n using BCP. When the target table contains an identity\n column that does not exist in the source table, you must\n disable the use BCP for loading table option.
" + } + }, + "UseThirdPartyBackupDevice": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "When this attribute is set to Y, DMS processes third-party \n transaction log backups if they are created in native format.
The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the\n trusted entity and grants the required permissions to access the value in\n SecretsManagerSecret. The role must allow the iam:PassRole action.\n SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager\n secret that allows access to the SQL Server endpoint.
You can specify one of two sets of values for these permissions. You can specify the\n values for this setting and SecretsManagerSecretId. Or you can specify\n clear-text values for UserName, Password,\n ServerName, and Port. You can't specify both. For more\n information on creating this SecretsManagerSecret and the\n SecretsManagerAccessRoleArn and SecretsManagerSecretId\n required to access it, see Using secrets to access Database Migration Service\n resources in the Database Migration Service User\n Guide.
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SQL Server endpoint connection details.
Use the TrimSpaceInChar source endpoint setting to trim data \n on CHAR and NCHAR data types during migration. The default value is true.
Indicates the mode used to fetch CDC data.
" + } + }, + "ForceLobLookup": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "Forces LOB lookup on inline LOB.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information that defines a Microsoft SQL Server endpoint.
" + } + }, + "com.amazonaws.databasemigrationservice#MicrosoftSqlServerDataProviderSettings": { + "type": "structure", + "members": { + "ServerName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The name of the Microsoft SQL Server server.
" + } + }, + "Port": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "The port value for the Microsoft SQL Server data provider.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The database name on the Microsoft SQL Server data provider.
" + } + }, + "SslMode": { + "target": "com.amazonaws.databasemigrationservice#DmsSslModeValue", + "traits": { + "smithy.api#documentation": "The SSL mode used to connect to the Microsoft SQL Server data provider. \n The default value is none.
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information that defines a Microsoft SQL Server data provider.
" + } + }, + "com.amazonaws.databasemigrationservice#MigrationProject": { + "type": "structure", + "members": { + "MigrationProjectName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The name of the migration project.
" + } + }, + "MigrationProjectArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The ARN string that uniquely identifies the migration project.
" + } + }, + "MigrationProjectCreationTime": { + "target": "com.amazonaws.databasemigrationservice#Iso8601DateTime", + "traits": { + "smithy.api#documentation": "The time when the migration project was created.
" + } + }, + "SourceDataProviderDescriptors": { + "target": "com.amazonaws.databasemigrationservice#DataProviderDescriptorList", + "traits": { + "smithy.api#documentation": "Information about the source data provider, including the name or ARN, and Secrets Manager parameters.
" + } + }, + "TargetDataProviderDescriptors": { + "target": "com.amazonaws.databasemigrationservice#DataProviderDescriptorList", + "traits": { + "smithy.api#documentation": "Information about the target data provider, including the name or ARN, and Secrets Manager parameters.
" + } + }, + "InstanceProfileArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the instance profile for your migration project.
" + } + }, + "InstanceProfileName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The name of the associated instance profile.
" + } + }, + "TransformationRules": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The settings in JSON format for migration rules. Migration rules make it possible for you to change \n the object names according to the rules that you specify. For example, you can change an object name \n to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.
" + } + }, + "Description": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "A user-friendly description of the migration project.
" + } + }, + "SchemaConversionApplicationAttributes": { + "target": "com.amazonaws.databasemigrationservice#SCApplicationAttributes", + "traits": { + "smithy.api#documentation": "The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information that defines a migration project.
" + } + }, + "com.amazonaws.databasemigrationservice#MigrationProjectList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#MigrationProject", + "traits": { + "smithy.api#xmlName": "MigrationProject" + } + } + }, + "com.amazonaws.databasemigrationservice#MigrationTypeValue": { + "type": "enum", + "members": { + "FULL_LOAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "full-load" + } + }, + "CDC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cdc" + } + }, + "FULL_LOAD_AND_CDC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "full-load-and-cdc" + } + } + } + }, + "com.amazonaws.databasemigrationservice#ModifyConversionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#ModifyConversionConfigurationMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#ModifyConversionConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the specified schema conversion configuration using the provided parameters.
" + } + }, + "com.amazonaws.databasemigrationservice#ModifyConversionConfigurationMessage": { + "type": "structure", + "members": { + "MigrationProjectIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "ConversionConfiguration": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The new conversion configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#ModifyConversionConfigurationResponse": { + "type": "structure", + "members": { + "MigrationProjectIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the modified configuration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#ModifyDataProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#ModifyDataProviderMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#ModifyDataProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the specified data provider using the provided settings.
\nYou must remove the data provider from all migration projects before you can modify it.
\nThe identifier of the data provider. Identifiers must begin with a letter \n and must contain only ASCII letters, digits, and hyphens. They can't end with \n a hyphen, or contain two consecutive hyphens.
", + "smithy.api#required": {} } }, - "Username": { + "DataProviderName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Endpoint connection user name.
" - } - }, - "UseBcpFullLoad": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": "Use this to attribute to transfer data for full-load operations\n using BCP. When the target table contains an identity\n column that does not exist in the source table, you must\n disable the use BCP for loading table option.
" - } - }, - "UseThirdPartyBackupDevice": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": "When this attribute is set to Y, DMS processes third-party \n transaction log backups if they are created in native format.
The name of the data provider.
" } }, - "SecretsManagerAccessRoleArn": { + "Description": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the\n trusted entity and grants the required permissions to access the value in\n SecretsManagerSecret. The role must allow the iam:PassRole action.\n SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager\n secret that allows access to the SQL Server endpoint.
You can specify one of two sets of values for these permissions. You can specify the\n values for this setting and SecretsManagerSecretId. Or you can specify\n clear-text values for UserName, Password,\n ServerName, and Port. You can't specify both. For more\n information on creating this SecretsManagerSecret and the\n SecretsManagerAccessRoleArn and SecretsManagerSecretId\n required to access it, see Using secrets to access Database Migration Service\n resources in the Database Migration Service User\n Guide.
A user-friendly description of the data provider.
" } }, - "SecretsManagerSecretId": { + "Engine": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the SQL Server endpoint connection details.
The type of database engine for the data provider. Valid values include \"aurora\", \n \"aurora_postgresql\", \"mysql\", \"oracle\", \"postgres\", \n and \"sqlserver\". A value of \"aurora\" represents Amazon Aurora MySQL-Compatible Edition.
Use the TrimSpaceInChar source endpoint setting to trim data \n on CHAR and NCHAR data types during migration. The default value is true.
Indicates the mode used to fetch CDC data.
" + "smithy.api#documentation": "If this attribute is Y, the current call to ModifyDataProvider replaces all\n existing data provider settings with the exact settings that you specify in this call. If this\n attribute is N, the current call to ModifyDataProvider does two things:
It replaces any data provider settings that already exist with new values, \n for settings with the same names.
\nIt creates new data provider settings that you specify in the call, \n for settings with different names.
\nForces LOB lookup on inline LOB.
" + "smithy.api#documentation": "The settings in JSON format for a data provider.
" } } }, "traits": { - "smithy.api#documentation": "Provides information that defines a Microsoft SQL Server endpoint.
" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#MigrationTypeValue": { - "type": "enum", + "com.amazonaws.databasemigrationservice#ModifyDataProviderResponse": { + "type": "structure", "members": { - "FULL_LOAD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "full-load" - } - }, - "CDC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cdc" - } - }, - "FULL_LOAD_AND_CDC": { - "target": "smithy.api#Unit", + "DataProvider": { + "target": "com.amazonaws.databasemigrationservice#DataProvider", "traits": { - "smithy.api#enumValue": "full-load-and-cdc" + "smithy.api#documentation": "The data provider that was modified.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.databasemigrationservice#ModifyEndpoint": { @@ -8697,7 +11216,30 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the specified endpoint.
\nFor a MySQL source or target endpoint, don't explicitly specify the database using\n the DatabaseName request parameter on the ModifyEndpoint API call.\n Specifying DatabaseName when you modify a MySQL endpoint replicates all the\n task tables to this single database. For MySQL endpoints, you specify the database only when\n you specify the schema in the table-mapping rules of the DMS task.
Modifies the specified endpoint.
\nFor a MySQL source or target endpoint, don't explicitly specify the database using\n the DatabaseName request parameter on the ModifyEndpoint API call.\n Specifying DatabaseName when you modify a MySQL endpoint replicates all the\n task tables to this single database. For MySQL endpoints, you specify the database only when\n you specify the schema in the table-mapping rules of the DMS task.
Settings in JSON format for the source and target PostgreSQL endpoint. For information\n about other available settings, see Extra connection\n attributes when using PostgreSQL as a source for DMS and \n Extra connection attributes when using PostgreSQL as a target for DMS in the\n Database Migration Service User Guide.\n
" } }, - "MySQLSettings": { - "target": "com.amazonaws.databasemigrationservice#MySQLSettings", - "traits": { - "smithy.api#documentation": "Settings in JSON format for the source and target MySQL endpoint. For information about\n other available settings, see Extra connection\n attributes when using MySQL as a source for DMS and Extra\n connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User\n Guide.\n
" - } + "MySQLSettings": { + "target": "com.amazonaws.databasemigrationservice#MySQLSettings", + "traits": { + "smithy.api#documentation": "Settings in JSON format for the source and target MySQL endpoint. For information about\n other available settings, see Extra connection\n attributes when using MySQL as a source for DMS and Extra\n connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User\n Guide.\n
" + } + }, + "OracleSettings": { + "target": "com.amazonaws.databasemigrationservice#OracleSettings", + "traits": { + "smithy.api#documentation": "Settings in JSON format for the source and target Oracle endpoint. For information about\n other available settings, see Extra connection\n attributes when using Oracle as a source for DMS and \n Extra connection attributes when using Oracle as a target for DMS in the\n Database Migration Service User Guide.\n
" + } + }, + "SybaseSettings": { + "target": "com.amazonaws.databasemigrationservice#SybaseSettings", + "traits": { + "smithy.api#documentation": "Settings in JSON format for the source and target SAP ASE endpoint. For information\n about other available settings, see Extra connection attributes\n when using SAP ASE as a source for DMS and Extra connection attributes\n when using SAP ASE as a target for DMS in the Database Migration Service\n User Guide.\n
" + } + }, + "MicrosoftSQLServerSettings": { + "target": "com.amazonaws.databasemigrationservice#MicrosoftSQLServerSettings", + "traits": { + "smithy.api#documentation": "Settings in JSON format for the source and target Microsoft SQL Server endpoint. For\n information about other available settings, see Extra connection\n attributes when using SQL Server as a source for DMS and \n Extra connection attributes when using SQL Server as a target for DMS in the\n Database Migration Service User Guide.\n
" + } + }, + "IBMDb2Settings": { + "target": "com.amazonaws.databasemigrationservice#IBMDb2Settings", + "traits": { + "smithy.api#documentation": "Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other\n available settings, see Extra connection attributes\n when using Db2 LUW as a source for DMS in the Database Migration Service\n User Guide.\n
" + } + }, + "DocDbSettings": { + "target": "com.amazonaws.databasemigrationservice#DocDbSettings", + "traits": { + "smithy.api#documentation": "Settings in JSON format for the source DocumentDB endpoint. For more information about the\n available settings, see the configuration properties section in Using DocumentDB as a Target for Database Migration Service\n in the Database Migration Service User\n Guide.\n
" + } + }, + "RedisSettings": { + "target": "com.amazonaws.databasemigrationservice#RedisSettings", + "traits": { + "smithy.api#documentation": "Settings in JSON format for the Redis target endpoint.
" + } + }, + "ExactSettings": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "If this attribute is Y, the current call to ModifyEndpoint replaces all\n existing endpoint settings with the exact settings that you specify in this call. If this\n attribute is N, the current call to ModifyEndpoint does two things:
It replaces any endpoint settings that already exist with new values, for settings with the\n same names.
\nIt creates new endpoint settings that you specify in the call, for settings with different\n names.
\nFor example, if you call create-endpoint ... --endpoint-settings '{\"a\":1}'\n ..., the endpoint has the following endpoint settings: '{\"a\":1}'. If\n you then call modify-endpoint ... --endpoint-settings '{\"b\":2}' ... for the\n same endpoint, the endpoint has the following settings: '{\"a\":1,\"b\":2}'.
However, suppose that you follow this with a call to modify-endpoint ...\n --endpoint-settings '{\"b\":2}' --exact-settings ... for that same endpoint again.\n Then the endpoint has the following settings: '{\"b\":2}'. All existing settings\n are replaced with the exact settings that you specify.
Settings in JSON format for the source GCP MySQL endpoint.
" + } + }, + "TimestreamSettings": { + "target": "com.amazonaws.databasemigrationservice#TimestreamSettings", + "traits": { + "smithy.api#documentation": "Settings in JSON format for the target Amazon Timestream endpoint.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#ModifyEndpointResponse": { + "type": "structure", + "members": { + "Endpoint": { + "target": "com.amazonaws.databasemigrationservice#Endpoint", + "traits": { + "smithy.api#documentation": "The modified endpoint.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#ModifyEventSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#ModifyEventSubscriptionMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#ModifyEventSubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#KMSAccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#KMSDisabledFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#KMSInvalidStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#KMSNotFoundFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#KMSThrottlingFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#SNSInvalidTopicFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#SNSNoAuthorizationFault" + } + ], + "traits": { + "smithy.api#documentation": "Modifies an existing DMS event notification subscription.
" + } + }, + "com.amazonaws.databasemigrationservice#ModifyEventSubscriptionMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The name of the DMS event notification subscription to be modified.
", + "smithy.api#required": {} + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification.\n The ARN is created by Amazon SNS when you create a topic and subscribe to it.
" + } + }, + "SourceType": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The type of DMS resource that generates the events you want to subscribe to.
\nValid values: replication-instance | replication-task
" + } + }, + "EventCategories": { + "target": "com.amazonaws.databasemigrationservice#EventCategoriesList", + "traits": { + "smithy.api#documentation": " A list of event categories for a source type that you want to subscribe to. Use the\n DescribeEventCategories action to see a list of event categories.
A Boolean value; set to true to activate the\n subscription.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#ModifyEventSubscriptionResponse": { + "type": "structure", + "members": { + "EventSubscription": { + "target": "com.amazonaws.databasemigrationservice#EventSubscription", + "traits": { + "smithy.api#documentation": "The modified event subscription.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#ModifyInstanceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#ModifyInstanceProfileMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#ModifyInstanceProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#S3AccessDeniedFault" }, - "OracleSettings": { - "target": "com.amazonaws.databasemigrationservice#OracleSettings", + { + "target": "com.amazonaws.databasemigrationservice#S3ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the specified instance profile using the provided parameters.
\nAll migration projects associated with the instance profile must be deleted \n or modified before you can modify the instance profile.
\nSettings in JSON format for the source and target Oracle endpoint. For information about\n other available settings, see Extra connection\n attributes when using Oracle as a source for DMS and \n Extra connection attributes when using Oracle as a target for DMS in the\n Database Migration Service User Guide.\n
" + "smithy.api#documentation": "The identifier of the instance profile. Identifiers must begin with a letter and must contain \n only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive \n hyphens.
", + "smithy.api#required": {} } }, - "SybaseSettings": { - "target": "com.amazonaws.databasemigrationservice#SybaseSettings", + "AvailabilityZone": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Settings in JSON format for the source and target SAP ASE endpoint. For information\n about other available settings, see Extra connection attributes\n when using SAP ASE as a source for DMS and Extra connection attributes\n when using SAP ASE as a target for DMS in the Database Migration Service\n User Guide.\n
" + "smithy.api#documentation": "The Availability Zone where the instance profile runs.
" } }, - "MicrosoftSQLServerSettings": { - "target": "com.amazonaws.databasemigrationservice#MicrosoftSQLServerSettings", + "KmsKeyArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Settings in JSON format for the source and target Microsoft SQL Server endpoint. For\n information about other available settings, see Extra connection\n attributes when using SQL Server as a source for DMS and \n Extra connection attributes when using SQL Server as a target for DMS in the\n Database Migration Service User Guide.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that is used to encrypt \n the connection parameters for the instance profile.
\nIf you don't specify a value for the KmsKeyArn parameter, then\n DMS uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a\n different default encryption key for each Amazon Web Services Region.
" } }, - "IBMDb2Settings": { - "target": "com.amazonaws.databasemigrationservice#IBMDb2Settings", + "PubliclyAccessible": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other\n available settings, see Extra connection attributes\n when using Db2 LUW as a source for DMS in the Database Migration Service\n User Guide.\n
" + "smithy.api#documentation": "Specifies the accessibility options for the instance profile. A value of\n true represents an instance profile with a public IP address. A value of\n false represents an instance profile with a private IP address. The default value\n is true.
Settings in JSON format for the source DocumentDB endpoint. For more information about the\n available settings, see the configuration properties section in Using DocumentDB as a Target for Database Migration Service\n in the Database Migration Service User\n Guide.\n
" + "smithy.api#documentation": "Specifies the network type for the instance profile. A value of IPV4 \n represents an instance profile with IPv4 network type and only supports IPv4 addressing. \n A value of IPV6 represents an instance profile with IPv6 network type \n and only supports IPv6 addressing. A value of DUAL represents an instance \n profile with dual network type that supports IPv4 and IPv6 addressing.
Settings in JSON format for the Redis target endpoint.
" + "smithy.api#documentation": "A user-friendly name for the instance profile.
" } }, - "ExactSettings": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "Description": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "If this attribute is Y, the current call to ModifyEndpoint replaces all\n existing endpoint settings with the exact settings that you specify in this call. If this\n attribute is N, the current call to ModifyEndpoint does two things:
It replaces any endpoint settings that already exist with new values, for settings with the\n same names.
\nIt creates new endpoint settings that you specify in the call, for settings with different\n names.
\nFor example, if you call create-endpoint ... --endpoint-settings '{\"a\":1}'\n ..., the endpoint has the following endpoint settings: '{\"a\":1}'. If\n you then call modify-endpoint ... --endpoint-settings '{\"b\":2}' ... for the\n same endpoint, the endpoint has the following settings: '{\"a\":1,\"b\":2}'.
However, suppose that you follow this with a call to modify-endpoint ...\n --endpoint-settings '{\"b\":2}' --exact-settings ... for that same endpoint again.\n Then the endpoint has the following settings: '{\"b\":2}'. All existing settings\n are replaced with the exact settings that you specify.
A user-friendly description for the instance profile.
" } }, - "GcpMySQLSettings": { - "target": "com.amazonaws.databasemigrationservice#GcpMySQLSettings", + "SubnetGroupIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Settings in JSON format for the source GCP MySQL endpoint.
" + "smithy.api#documentation": "A subnet group to associate with the instance profile.
" } }, - "TimestreamSettings": { - "target": "com.amazonaws.databasemigrationservice#TimestreamSettings", + "VpcSecurityGroups": { + "target": "com.amazonaws.databasemigrationservice#StringList", "traits": { - "smithy.api#documentation": "Settings in JSON format for the target Amazon Timestream endpoint.
" + "smithy.api#documentation": "Specifies the VPC security groups to be used with the instance profile. \n The VPC security group must work with the VPC containing the instance profile.
" } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#ModifyEndpointResponse": { + "com.amazonaws.databasemigrationservice#ModifyInstanceProfileResponse": { "type": "structure", "members": { - "Endpoint": { - "target": "com.amazonaws.databasemigrationservice#Endpoint", + "InstanceProfile": { + "target": "com.amazonaws.databasemigrationservice#InstanceProfile", "traits": { - "smithy.api#documentation": "The modified endpoint.
" + "smithy.api#documentation": "The instance profile that was modified.
" } } }, "traits": { - "smithy.api#documentation": "", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#ModifyEventSubscription": { + "com.amazonaws.databasemigrationservice#ModifyMigrationProject": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#ModifyEventSubscriptionMessage" + "target": "com.amazonaws.databasemigrationservice#ModifyMigrationProjectMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#ModifyEventSubscriptionResponse" + "target": "com.amazonaws.databasemigrationservice#ModifyMigrationProjectResponse" }, "errors": [ { - "target": "com.amazonaws.databasemigrationservice#KMSAccessDeniedFault" - }, - { - "target": "com.amazonaws.databasemigrationservice#KMSDisabledFault" - }, - { - "target": "com.amazonaws.databasemigrationservice#KMSInvalidStateFault" - }, - { - "target": "com.amazonaws.databasemigrationservice#KMSNotFoundFault" + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, { - "target": "com.amazonaws.databasemigrationservice#KMSThrottlingFault" + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, { "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" }, { - "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" - }, - { - "target": "com.amazonaws.databasemigrationservice#SNSInvalidTopicFault" + "target": "com.amazonaws.databasemigrationservice#S3AccessDeniedFault" }, { - "target": "com.amazonaws.databasemigrationservice#SNSNoAuthorizationFault" + "target": "com.amazonaws.databasemigrationservice#S3ResourceNotFoundFault" } ], "traits": { - "smithy.api#documentation": "Modifies an existing DMS event notification subscription.
" + "smithy.api#documentation": "Modifies the specified migration project using the provided parameters.
\nThe migration project must be closed before you can modify it.
\nThe name of the DMS event notification subscription to be modified.
", + "smithy.api#documentation": "The identifier of the migration project. Identifiers must begin with a letter \n and must contain only ASCII letters, digits, and hyphens. They can't end with \n a hyphen, or contain two consecutive hyphens.
", "smithy.api#required": {} } }, - "SnsTopicArn": { + "MigrationProjectName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification.\n The ARN is created by Amazon SNS when you create a topic and subscribe to it.
" + "smithy.api#documentation": "A user-friendly name for the migration project.
" } }, - "SourceType": { + "SourceDataProviderDescriptors": { + "target": "com.amazonaws.databasemigrationservice#DataProviderDescriptorDefinitionList", + "traits": { + "smithy.api#documentation": "Information about the source data provider, including the name, ARN, and Amazon Web Services Secrets Manager parameters.
" + } + }, + "TargetDataProviderDescriptors": { + "target": "com.amazonaws.databasemigrationservice#DataProviderDescriptorDefinitionList", + "traits": { + "smithy.api#documentation": "Information about the target data provider, including the name, ARN, and Amazon Web Services Secrets Manager parameters.
" + } + }, + "InstanceProfileIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The type of DMS resource that generates the events you want to subscribe to.
\nValid values: replication-instance | replication-task
" + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) for the instance profile.
" } }, - "EventCategories": { - "target": "com.amazonaws.databasemigrationservice#EventCategoriesList", + "TransformationRules": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": " A list of event categories for a source type that you want to subscribe to. Use the\n DescribeEventCategories action to see a list of event categories.
The settings in JSON format for migration rules. Migration rules make it possible for you to change \n the object names according to the rules that you specify. For example, you can change an object name \n to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.
" } }, - "Enabled": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "Description": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "A Boolean value; set to true to activate the\n subscription.
" + "smithy.api#documentation": "A user-friendly description of the migration project.
" + } + }, + "SchemaConversionApplicationAttributes": { + "target": "com.amazonaws.databasemigrationservice#SCApplicationAttributes", + "traits": { + "smithy.api#documentation": "The schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
" } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#ModifyEventSubscriptionResponse": { + "com.amazonaws.databasemigrationservice#ModifyMigrationProjectResponse": { "type": "structure", "members": { - "EventSubscription": { - "target": "com.amazonaws.databasemigrationservice#EventSubscription", + "MigrationProject": { + "target": "com.amazonaws.databasemigrationservice#MigrationProject", "traits": { - "smithy.api#documentation": "The modified event subscription.
" + "smithy.api#documentation": "The migration project that was modified.
" } } }, "traits": { - "smithy.api#documentation": "", "smithy.api#output": {} } }, @@ -9112,7 +11865,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#ModifyReplicationConfigResponse": { @@ -9161,7 +11915,77 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the replication instance to apply new settings. You can change one or more\n parameters by specifying these parameters and the new values in the request.
\nSome settings are applied during the maintenance window.
\n " + "smithy.api#documentation": "Modifies the replication instance to apply new settings. You can change one or more\n parameters by specifying these parameters and the new values in the request.
\nSome settings are applied during the maintenance window.
\n ", + "smithy.api#examples": [ + { + "title": "Modify replication instance", + "documentation": "Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request. Some settings are applied during the maintenance window.", + "input": { + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "AllocatedStorage": 123, + "ApplyImmediately": true, + "ReplicationInstanceClass": "dms.t2.micro", + "VpcSecurityGroupIds": [], + "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", + "MultiAZ": true, + "EngineVersion": "1.5.0", + "AllowMajorVersionUpgrade": true, + "AutoMinorVersionUpgrade": true, + "ReplicationInstanceIdentifier": "test-rep-1" + }, + "output": { + "ReplicationInstance": { + "PubliclyAccessible": true, + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "ReplicationInstanceClass": "dms.t2.micro", + "ReplicationSubnetGroup": { + "ReplicationSubnetGroupDescription": "default", + "Subnets": [ + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-f6dd91af", + "SubnetAvailabilityZone": { + "Name": "us-east-1d" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-3605751d", + "SubnetAvailabilityZone": { + "Name": "us-east-1b" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-c2daefb5", + "SubnetAvailabilityZone": { + "Name": "us-east-1c" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-85e90cb8", + "SubnetAvailabilityZone": { + "Name": "us-east-1e" + } + } + ], + "VpcId": "vpc-6741a603", + "SubnetGroupStatus": "Complete", + "ReplicationSubnetGroupIdentifier": "default" + }, + "AutoMinorVersionUpgrade": true, + "ReplicationInstanceStatus": "available", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "AllocatedStorage": 5, + "EngineVersion": "1.5.0", + "ReplicationInstanceIdentifier": "test-rep-1", + "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", + "PendingModifiedValues": {} + } + } + } + ] } }, "com.amazonaws.databasemigrationservice#ModifyReplicationInstanceMessage": { @@ -9244,7 +12068,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#ModifyReplicationInstanceResponse": { @@ -9291,7 +12116,21 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the settings for the specified replication subnet group.
" + "smithy.api#documentation": "Modifies the settings for the specified replication subnet group.
", + "smithy.api#examples": [ + { + "title": "Modify replication subnet group", + "documentation": "Modifies the settings for the specified replication subnet group.", + "input": { + "ReplicationSubnetGroupIdentifier": "", + "ReplicationSubnetGroupDescription": "", + "SubnetIds": [] + }, + "output": { + "ReplicationSubnetGroup": {} + } + } + ] } }, "com.amazonaws.databasemigrationservice#ModifyReplicationSubnetGroupMessage": { @@ -9319,7 +12158,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#ModifyReplicationSubnetGroupResponse": { @@ -9423,7 +12263,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#ModifyReplicationTaskResponse": { @@ -9593,7 +12434,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#MoveReplicationTaskResponse": { @@ -9703,6 +12545,38 @@ "smithy.api#documentation": "Provides information that defines a MySQL endpoint.
" } }, + "com.amazonaws.databasemigrationservice#MySqlDataProviderSettings": { + "type": "structure", + "members": { + "ServerName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The name of the MySQL server.
" + } + }, + "Port": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "The port value for the MySQL data provider.
" + } + }, + "SslMode": { + "target": "com.amazonaws.databasemigrationservice#DmsSslModeValue", + "traits": { + "smithy.api#documentation": "The SSL mode used to connect to the MySQL data provider. \n The default value is none.
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information that defines a MySQL data provider.
" + } + }, "com.amazonaws.databasemigrationservice#NeptuneSettings": { "type": "structure", "members": { @@ -9772,6 +12646,74 @@ } } }, + "com.amazonaws.databasemigrationservice#OracleDataProviderSettings": { + "type": "structure", + "members": { + "ServerName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The name of the Oracle server.
" + } + }, + "Port": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "The port value for the Oracle data provider.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The database name on the Oracle data provider.
" + } + }, + "SslMode": { + "target": "com.amazonaws.databasemigrationservice#DmsSslModeValue", + "traits": { + "smithy.api#documentation": "The SSL mode used to connect to the Oracle data provider. \n The default value is none.
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
" + } + }, + "AsmServer": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The address of your Oracle Automatic Storage Management (ASM) server. You can set \n this value from the asm_server value. You set asm_server as part \n of the extra connection attribute string to access an Oracle server with Binary Reader that \n uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.
The identifier of the secret in Secrets Manager that contains the Oracle ASM connection details.
\nRequired only if your data provider uses the Oracle ASM server.
" + } + }, + "SecretsManagerOracleAsmAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that provides access to the secret in Secrets Manager \n that contains the Oracle ASM connection details.
" + } + }, + "SecretsManagerSecurityDbEncryptionSecretId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The identifier of the secret in Secrets Manager that contains the transparent data encryption (TDE) \n password. DMS requires this password to access Oracle redo logs encrypted by TDE \n using Binary Reader.
" + } + }, + "SecretsManagerSecurityDbEncryptionAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that provides access to the secret in Secrets Manager \n that contains the TDE password.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information that defines an Oracle data provider.
" + } + }, "com.amazonaws.databasemigrationservice#OracleSettings": { "type": "structure", "members": { @@ -10099,18 +13041,35 @@ "smithy.api#documentation": "The value returned when the specified EngineVersion of the replication \n instance is in Beta or test mode. This indicates some features might not work as expected.
DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.
In response to the DescribeOrderableReplicationInstances operation, this\n object describes an available replication instance. This description includes the\n replication instance's type, engine version, and allocated storage.
In response to the DescribeOrderableReplicationInstances operation, this\n object describes an available replication instance. This description includes the\n replication instance's type, engine version, and allocated storage.
Provides information that defines a PostgreSQL endpoint.
" } }, + "com.amazonaws.databasemigrationservice#PostgreSqlDataProviderSettings": { + "type": "structure", + "members": { + "ServerName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The name of the PostgreSQL server.
" + } + }, + "Port": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "The port value for the PostgreSQL data provider.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The database name on the PostgreSQL data provider.
" + } + }, + "SslMode": { + "target": "com.amazonaws.databasemigrationservice#DmsSslModeValue", + "traits": { + "smithy.api#documentation": "The SSL mode used to connect to the PostgreSQL data provider. \n The default value is none.
The Amazon Resource Name (ARN) of the certificate used for SSL connection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information that defines a PostgreSQL data provider.
" + } + }, "com.amazonaws.databasemigrationservice#ProvisionData": { "type": "structure", "members": { @@ -10587,6 +13584,9 @@ "smithy.api#documentation": "If this parameter is true, the reboot is conducted through a planned Multi-AZ failover \n where resources are released and cleaned up prior to conducting the failover. \n If the instance isn''t configured for Multi-AZ, then you can't specify true. \n ( --force-planned-failover and --force-failover can't both be set to true.)
Populates the schema for the specified endpoint. This is an asynchronous operation and\n can take several minutes. You can check the status of this operation by calling the\n DescribeRefreshSchemasStatus operation.
" + "smithy.api#documentation": "Populates the schema for the specified endpoint. This is an asynchronous operation and\n can take several minutes. You can check the status of this operation by calling the\n DescribeRefreshSchemasStatus operation.
", + "smithy.api#examples": [ + { + "title": "Refresh schema", + "documentation": "Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the describe-refresh-schemas-status operation.", + "input": { + "EndpointArn": "", + "ReplicationInstanceArn": "" + }, + "output": { + "RefreshSchemasStatus": {} + } + } + ] } }, "com.amazonaws.databasemigrationservice#RefreshSchemasMessage": { @@ -11010,7 +14023,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#RefreshSchemasResponse": { @@ -11168,7 +14182,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#ReloadReplicationTablesResponse": { @@ -11229,6 +14244,9 @@ "smithy.api#documentation": "Options for reload. Specify data-reload to reload the data and re-validate\n it if validation is enabled. Specify validate-only to re-validate the table.\n This option applies only when validation is enabled for the task.
Valid values: data-reload, validate-only
\nDefault value is data-reload.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#ReloadTablesResponse": { @@ -11259,7 +14277,18 @@ } ], "traits": { - "smithy.api#documentation": "Removes metadata tags from an DMS resource, including replication instance, \n endpoint, subnet group, and migration task. For more information, see \n \n Tag\n \n data type description.
Removes metadata tags from an DMS resource, including replication instance, \n endpoint, subnet group, and migration task. For more information, see \n \n Tag\n \n data type description.
Removes one or more tags from an DMS resource.
" + "smithy.api#documentation": "Removes one or more tags from an DMS resource.
", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#RemoveTagsFromResourceResponse": { @@ -11851,1125 +14881,1653 @@ "FullLoadFinishDate": { "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "The date the replication full load was finished.
" + "smithy.api#documentation": "The date the replication full load was finished.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This object provides a collection of statistics about a serverless replication.
" + } + }, + "com.amazonaws.databasemigrationservice#ReplicationSubnetGroup": { + "type": "structure", + "members": { + "ReplicationSubnetGroupIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The identifier of the replication instance subnet group.
" + } + }, + "ReplicationSubnetGroupDescription": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "A description for the replication subnet group.
" + } + }, + "VpcId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The ID of the VPC.
" + } + }, + "SubnetGroupStatus": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The status of the subnet group.
" + } + }, + "Subnets": { + "target": "com.amazonaws.databasemigrationservice#SubnetList", + "traits": { + "smithy.api#documentation": "The subnets that are in the subnet group.
" + } + }, + "SupportedNetworkTypes": { + "target": "com.amazonaws.databasemigrationservice#StringList", + "traits": { + "smithy.api#documentation": "The IP addressing protocol supported by the subnet group. This is used by a \n replication instance with values such as IPv4 only or Dual-stack that supports \n both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a subnet group in response to a request by the\n DescribeReplicationSubnetGroups operation.
The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.databasemigrationservice#ReplicationSubnetGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#ReplicationSubnetGroup", + "traits": { + "smithy.api#xmlName": "ReplicationSubnetGroup" + } + } + }, + "com.amazonaws.databasemigrationservice#ReplicationTableStatisticsList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#TableStatistics" + } + }, + "com.amazonaws.databasemigrationservice#ReplicationTask": { + "type": "structure", + "members": { + "ReplicationTaskIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The user-assigned replication task identifier or name.
\nConstraints:
\nMust contain 1-255 alphanumeric characters or hyphens.
\nFirst character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\nThe Amazon Resource Name (ARN) that uniquely identifies the endpoint.
" + } + }, + "TargetEndpointArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The ARN that uniquely identifies the endpoint.
" + } + }, + "ReplicationInstanceArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The ARN of the replication instance.
" + } + }, + "MigrationType": { + "target": "com.amazonaws.databasemigrationservice#MigrationTypeValue", + "traits": { + "smithy.api#documentation": "The type of migration.
" + } + }, + "TableMappings": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Table mappings specified in the task.
" + } + }, + "ReplicationTaskSettings": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The settings for the replication task.
" + } + }, + "Status": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The status of the replication task. This response parameter can return one of\n the following values:
\n\n \"moving\" – The task is being moved in response to running the\n \n MoveReplicationTask\n operation.
\n \"creating\" – The task is being created in response to running\n the \n CreateReplicationTask\n operation.
\n \"deleting\" – The task is being deleted in response to running\n the \n DeleteReplicationTask\n operation.
\n \"failed\" – The task failed to successfully complete the database\n migration in response to running the \n StartReplicationTask\n operation.
\n \"failed-move\" – The task failed to move in response to running\n the \n MoveReplicationTask\n operation.
\n \"modifying\" – The task definition is being modified in response\n to running the \n ModifyReplicationTask\n operation.
\n \"ready\" – The task is in a ready state where it can\n respond to other task operations, such as \n StartReplicationTask\n or \n DeleteReplicationTask\n .
\n \"running\" – The task is performing a database migration in\n response to running the \n StartReplicationTask\n operation.
\n \"starting\" – The task is preparing to perform a database\n migration in response to running the \n StartReplicationTask\n operation.
\n \"stopped\" – The task has stopped in response to running the\n \n StopReplicationTask\n operation.
\n \"stopping\" – The task is preparing to stop in response to\n running the \n StopReplicationTask\n operation.
\n \"testing\" – The database migration specified for this task is\n being tested in response to running either the \n StartReplicationTaskAssessmentRun\n or the\n \n StartReplicationTaskAssessment\n \n operation.
\n \n StartReplicationTaskAssessmentRun\n is\n an improved premigration task assessment operation. The \n StartReplicationTaskAssessment\n \n operation assesses data type compatibility only between the source and target\n database of a given migration task. In contrast, \n StartReplicationTaskAssessmentRun\n \n enables you to specify a variety of premigration task assessments in addition to\n data type compatibility. These assessments include ones for the validity of primary key definitions and\n likely issues with database migration performance, among others.
The last error (failure) message generated for the replication task.
" + } + }, + "StopReason": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The reason the replication task was stopped. This response parameter can return one of\n the following values:
\n\n \"Stop Reason NORMAL\"\n
\n \"Stop Reason RECOVERABLE_ERROR\"\n
\n \"Stop Reason FATAL_ERROR\"\n
\n \"Stop Reason FULL_LOAD_ONLY_FINISHED\"\n
\n \"Stop Reason STOPPED_AFTER_FULL_LOAD\" – Full load completed, with cached changes not applied
\n \"Stop Reason STOPPED_AFTER_CACHED_EVENTS\" – Full load completed, with cached changes applied
\n \"Stop Reason EXPRESS_LICENSE_LIMITS_REACHED\"\n
\n \"Stop Reason STOPPED_AFTER_DDL_APPLY\" – User-defined stop task after DDL applied
\n \"Stop Reason STOPPED_DUE_TO_LOW_MEMORY\"\n
\n \"Stop Reason STOPPED_DUE_TO_LOW_DISK\"\n
\n \"Stop Reason STOPPED_AT_SERVER_TIME\" – User-defined server time for stopping task
\n \"Stop Reason STOPPED_AT_COMMIT_TIME\" – User-defined commit time for stopping task
\n \"Stop Reason RECONFIGURATION_RESTART\"\n
\n \"Stop Reason RECYCLE_TASK\"\n
The date the replication task was created.
" + } + }, + "ReplicationTaskStartDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "The date the replication task is scheduled to start.
" + } + }, + "CdcStartPosition": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Indicates when you want a change data capture (CDC) operation to start. Use either\n CdcStartPosition or CdcStartTime to specify when you want the CDC operation to start.\n Specifying both values results in an error.
The value can be in date, checkpoint, or LSN/SCN format.
\nDate Example: --cdc-start-position “2018-03-08T12:12:12”
\nCheckpoint Example: --cdc-start-position\n \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"
\nLSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
" + } + }, + "CdcStopPosition": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.
\nServer time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
\nCommit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12“
" + } + }, + "RecoveryCheckpoint": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Indicates the last checkpoint that occurred during a change data capture (CDC)\n operation. You can provide this value to the CdcStartPosition parameter to\n start a CDC operation that begins at that checkpoint.
The Amazon Resource Name (ARN) of the replication task.
" + } + }, + "ReplicationTaskStats": { + "target": "com.amazonaws.databasemigrationservice#ReplicationTaskStats", + "traits": { + "smithy.api#documentation": "The statistics for the task, including elapsed time, tables loaded, and table\n errors.
" + } + }, + "TaskData": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "Supplemental information that the task requires to migrate the data for certain source and target endpoints. \n For more information, see Specifying Supplemental Data for Task Settings in the\n Database Migration Service User Guide.\n
" + } + }, + "TargetReplicationInstanceArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The ARN of the replication instance to which this task is moved in response to running\n the \n MoveReplicationTask\n operation. Otherwise, this response\n parameter isn't a member of the ReplicationTask object.
This object provides a collection of statistics about a serverless replication.
" + "smithy.api#documentation": "Provides information that describes a replication task created by the\n CreateReplicationTask operation.
The identifier of the replication instance subnet group.
" + "smithy.api#documentation": "The replication task identifier of the task on which the task assessment was run.\n
" } }, - "ReplicationSubnetGroupDescription": { + "ReplicationTaskArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "A description for the replication subnet group.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replication task.
" } }, - "VpcId": { - "target": "com.amazonaws.databasemigrationservice#String", + "ReplicationTaskLastAssessmentDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "The ID of the VPC.
" + "smithy.api#documentation": "The date the task assessment was completed.
" } }, - "SubnetGroupStatus": { + "AssessmentStatus": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The status of the subnet group.
" + "smithy.api#documentation": "The status of the task assessment.
" } }, - "Subnets": { - "target": "com.amazonaws.databasemigrationservice#SubnetList", + "AssessmentResultsFile": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The subnets that are in the subnet group.
" + "smithy.api#documentation": "The file containing the results of the task assessment.
" } }, - "SupportedNetworkTypes": { - "target": "com.amazonaws.databasemigrationservice#StringList", + "AssessmentResults": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The IP addressing protocol supported by the subnet group. This is used by a \n replication instance with values such as IPv4 only or Dual-stack that supports \n both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
" + "smithy.api#documentation": "The task assessment results in JSON format.
\nThe response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn\n in the request.
" } - } - }, - "traits": { - "smithy.api#documentation": "Describes a subnet group in response to a request by the\n DescribeReplicationSubnetGroups operation.
The URL of the S3 object containing the task assessment results.
\nThe response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn\n in the request.
" } } }, "traits": { - "smithy.api#documentation": "The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.
", - "smithy.api#error": "client" + "smithy.api#documentation": "The task assessment report in JSON format.
" } }, - "com.amazonaws.databasemigrationservice#ReplicationSubnetGroups": { + "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentResultList": { "type": "list", "member": { - "target": "com.amazonaws.databasemigrationservice#ReplicationSubnetGroup", + "target": "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentResult", "traits": { - "smithy.api#xmlName": "ReplicationSubnetGroup" + "smithy.api#xmlName": "ReplicationTaskAssessmentResult" } } }, - "com.amazonaws.databasemigrationservice#ReplicationTableStatisticsList": { - "type": "list", - "member": { - "target": "com.amazonaws.databasemigrationservice#TableStatistics" - } - }, - "com.amazonaws.databasemigrationservice#ReplicationTask": { + "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentRun": { "type": "structure", "members": { - "ReplicationTaskIdentifier": { + "ReplicationTaskAssessmentRunArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The user-assigned replication task identifier or name.
\nConstraints:
\nMust contain 1-255 alphanumeric characters or hyphens.
\nFirst character must be a letter.
\nCannot end with a hyphen or contain two consecutive hyphens.
\nAmazon Resource Name (ARN) of this assessment run.
" } }, - "SourceEndpointArn": { + "ReplicationTaskArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
" + "smithy.api#documentation": "ARN of the migration task associated with this premigration\n assessment run.
" } }, - "TargetEndpointArn": { + "Status": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The ARN that uniquely identifies the endpoint.
" + "smithy.api#documentation": "Assessment run status.
\nThis status can have one of the following values:
\n\n \"cancelling\" – The assessment run was canceled by the\n CancelReplicationTaskAssessmentRun operation.
\n \"deleting\" – The assessment run was deleted by the\n DeleteReplicationTaskAssessmentRun operation.
\n \"failed\" – At least one individual assessment completed with a\n failed status.
\n \"error-provisioning\" – An internal error occurred while\n resources were provisioned (during provisioning status).
\n \"error-executing\" – An internal error occurred while\n individual assessments ran (during running status).
\n \"invalid state\" – The assessment run is in an unknown state.
\n \"passed\" – All individual assessments have completed, and none\n has a failed status.
\n \"provisioning\" – Resources required to run individual\n assessments are being provisioned.
\n \"running\" – Individual assessments are being run.
\n \"starting\" – The assessment run is starting, but resources are not yet\n being provisioned for individual assessments.
The ARN of the replication instance.
" + "smithy.api#documentation": "Date on which the assessment run was created using the\n StartReplicationTaskAssessmentRun operation.
The type of migration.
" + "smithy.api#documentation": "Indication of the completion progress for the individual assessments specified to\n run.
" } }, - "TableMappings": { + "LastFailureMessage": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Table mappings specified in the task.
" + "smithy.api#documentation": "Last message generated by an individual assessment failure.
" } }, - "ReplicationTaskSettings": { + "ServiceAccessRoleArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The settings for the replication task.
" + "smithy.api#documentation": "ARN of the service role used to start the assessment run using the\n StartReplicationTaskAssessmentRun operation. The role must allow the iam:PassRole action.
The status of the replication task. This response parameter can return one of\n the following values:
\n\n \"moving\" – The task is being moved in response to running the\n \n MoveReplicationTask\n operation.
\n \"creating\" – The task is being created in response to running\n the \n CreateReplicationTask\n operation.
\n \"deleting\" – The task is being deleted in response to running\n the \n DeleteReplicationTask\n operation.
\n \"failed\" – The task failed to successfully complete the database\n migration in response to running the \n StartReplicationTask\n operation.
\n \"failed-move\" – The task failed to move in response to running\n the \n MoveReplicationTask\n operation.
\n \"modifying\" – The task definition is being modified in response\n to running the \n ModifyReplicationTask\n operation.
\n \"ready\" – The task is in a ready state where it can\n respond to other task operations, such as \n StartReplicationTask\n or \n DeleteReplicationTask\n .
\n \"running\" – The task is performing a database migration in\n response to running the \n StartReplicationTask\n operation.
\n \"starting\" – The task is preparing to perform a database\n migration in response to running the \n StartReplicationTask\n operation.
\n \"stopped\" – The task has stopped in response to running the\n \n StopReplicationTask\n operation.
\n \"stopping\" – The task is preparing to stop in response to\n running the \n StopReplicationTask\n operation.
\n \"testing\" – The database migration specified for this task is\n being tested in response to running either the \n StartReplicationTaskAssessmentRun\n or the\n \n StartReplicationTaskAssessment\n \n operation.
\n \n StartReplicationTaskAssessmentRun\n is\n an improved premigration task assessment operation. The \n StartReplicationTaskAssessment\n \n operation assesses data type compatibility only between the source and target\n database of a given migration task. In contrast, \n StartReplicationTaskAssessmentRun\n \n enables you to specify a variety of premigration task assessments in addition to\n data type compatibility. These assessments include ones for the validity of primary key definitions and\n likely issues with database migration performance, among others.
Amazon S3 bucket where DMS stores the results of this assessment run.
" } }, - "LastFailureMessage": { + "ResultLocationFolder": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The last error (failure) message generated for the replication task.
" + "smithy.api#documentation": "Folder in an Amazon S3 bucket where DMS stores the results of this assessment\n run.
" } }, - "StopReason": { + "ResultEncryptionMode": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The reason the replication task was stopped. This response parameter can return one of\n the following values:
\n\n \"Stop Reason NORMAL\"\n
\n \"Stop Reason RECOVERABLE_ERROR\"\n
\n \"Stop Reason FATAL_ERROR\"\n
\n \"Stop Reason FULL_LOAD_ONLY_FINISHED\"\n
\n \"Stop Reason STOPPED_AFTER_FULL_LOAD\" – Full load completed, with cached changes not applied
\n \"Stop Reason STOPPED_AFTER_CACHED_EVENTS\" – Full load completed, with cached changes applied
\n \"Stop Reason EXPRESS_LICENSE_LIMITS_REACHED\"\n
\n \"Stop Reason STOPPED_AFTER_DDL_APPLY\" – User-defined stop task after DDL applied
\n \"Stop Reason STOPPED_DUE_TO_LOW_MEMORY\"\n
\n \"Stop Reason STOPPED_DUE_TO_LOW_DISK\"\n
\n \"Stop Reason STOPPED_AT_SERVER_TIME\" – User-defined server time for stopping task
\n \"Stop Reason STOPPED_AT_COMMIT_TIME\" – User-defined commit time for stopping task
\n \"Stop Reason RECONFIGURATION_RESTART\"\n
\n \"Stop Reason RECYCLE_TASK\"\n
Encryption mode used to encrypt the assessment run results.
" } }, - "ReplicationTaskCreationDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "ResultKmsKeyArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The date the replication task was created.
" + "smithy.api#documentation": "ARN of the KMS encryption key used to encrypt the assessment run results.
" } }, - "ReplicationTaskStartDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "AssessmentRunName": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The date the replication task is scheduled to start.
" + "smithy.api#documentation": "Unique name of the assessment run.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information that describes a premigration assessment run that you have started\n using the StartReplicationTaskAssessmentRun operation.
Some of the information appears based on other operations that can return the\n ReplicationTaskAssessmentRun object.
The number of individual assessments that are specified to run.
" } }, - "CdcStartPosition": { + "IndividualAssessmentCompletedCount": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of individual assessments that have completed, successfully or not.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The progress values reported by the AssessmentProgress response\n element.
Indicates when you want a change data capture (CDC) operation to start. Use either\n CdcStartPosition or CdcStartTime to specify when you want the CDC operation to start.\n Specifying both values results in an error.
The value can be in date, checkpoint, or LSN/SCN format.
\nDate Example: --cdc-start-position “2018-03-08T12:12:12”
\nCheckpoint Example: --cdc-start-position\n \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"
\nLSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
" + "smithy.api#documentation": "Amazon Resource Name (ARN) of this individual assessment.
" } }, - "CdcStopPosition": { + "ReplicationTaskAssessmentRunArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Indicates when you want a change data capture (CDC) operation to stop. The value can be\n either server time or commit time.
\nServer time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
\nCommit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12“
" + "smithy.api#documentation": "ARN of the premigration assessment run that is created to run this individual\n assessment.
" } }, - "RecoveryCheckpoint": { + "IndividualAssessmentName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Indicates the last checkpoint that occurred during a change data capture (CDC)\n operation. You can provide this value to the CdcStartPosition parameter to\n start a CDC operation that begins at that checkpoint.
Name of this individual assessment.
" } }, - "ReplicationTaskArn": { + "Status": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replication task.
" + "smithy.api#documentation": "Individual assessment status.
\nThis status can have one of the following values:
\n\n \"cancelled\"\n
\n \"error\"\n
\n \"failed\"\n
\n \"passed\"\n
\n \"pending\"\n
\n \"running\"\n
Date when this individual assessment was started as part of running the\n StartReplicationTaskAssessmentRun operation.
Provides information that describes an individual assessment from a premigration\n assessment run.
" + } + }, + "com.amazonaws.databasemigrationservice#ReplicationTaskIndividualAssessmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#ReplicationTaskIndividualAssessment" + } + }, + "com.amazonaws.databasemigrationservice#ReplicationTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#ReplicationTask", + "traits": { + "smithy.api#xmlName": "ReplicationTask" + } + } + }, + "com.amazonaws.databasemigrationservice#ReplicationTaskStats": { + "type": "structure", + "members": { + "FullLoadProgressPercent": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The percent complete for the full load migration task.
" + } + }, + "ElapsedTimeMillis": { + "target": "com.amazonaws.databasemigrationservice#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The elapsed time of the task, in milliseconds.
" + } + }, + "TablesLoaded": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of tables loaded for this task.
" + } + }, + "TablesLoading": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of tables currently loading for this task.
" + } + }, + "TablesQueued": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of tables queued for this task.
" + } + }, + "TablesErrored": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of errors that have occurred during this task.
" + } + }, + "FreshStartDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "The date the replication task was started either with a fresh start or a target reload.
" + } + }, + "StartDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "The date the replication task was started either with a fresh start or a resume. For more information, see \n StartReplicationTaskType.
" } }, - "ReplicationTaskStats": { - "target": "com.amazonaws.databasemigrationservice#ReplicationTaskStats", + "StopDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "The statistics for the task, including elapsed time, tables loaded, and table\n errors.
" + "smithy.api#documentation": "The date the replication task was stopped.
" } }, - "TaskData": { - "target": "com.amazonaws.databasemigrationservice#String", + "FullLoadStartDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "Supplemental information that the task requires to migrate the data for certain source and target endpoints. \n For more information, see Specifying Supplemental Data for Task Settings in the\n Database Migration Service User Guide.\n
" + "smithy.api#documentation": "The date the replication task full load was started.
" } }, - "TargetReplicationInstanceArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "FullLoadFinishDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "The ARN of the replication instance to which this task is moved in response to running\n the \n MoveReplicationTask\n operation. Otherwise, this response\n parameter isn't a member of the ReplicationTask object.
The date the replication task full load was completed.
" } } }, "traits": { - "smithy.api#documentation": "Provides information that describes a replication task created by the\n CreateReplicationTask operation.
In response to a request by the DescribeReplicationTasks operation, this object provides\n a collection of statistics about a replication task.
The replication task identifier of the task on which the task assessment was run.\n
" + "smithy.api#documentation": "" } }, - "ReplicationTaskArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "resourceArn": { + "target": "com.amazonaws.databasemigrationservice#ResourceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replication task.
" + "smithy.api#documentation": "" } - }, - "ReplicationTaskLastAssessmentDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + } + }, + "traits": { + "smithy.api#documentation": "The resource you are attempting to create already exists.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.databasemigrationservice#ResourceArn": { + "type": "string" + }, + "com.amazonaws.databasemigrationservice#ResourceNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.databasemigrationservice#ExceptionMessage", "traits": { - "smithy.api#documentation": "The date the task assessment was completed.
" + "smithy.api#documentation": "" } - }, - "AssessmentStatus": { + } + }, + "traits": { + "smithy.api#documentation": "The resource could not be found.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.databasemigrationservice#ResourcePendingMaintenanceActions": { + "type": "structure", + "members": { + "ResourceIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The status of the task assessment.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action\n applies to. For information about creating an ARN, see Constructing an Amazon\n Resource Name (ARN) for DMS in the DMS documentation.
" } }, - "AssessmentResultsFile": { - "target": "com.amazonaws.databasemigrationservice#String", + "PendingMaintenanceActionDetails": { + "target": "com.amazonaws.databasemigrationservice#PendingMaintenanceActionDetails", "traits": { - "smithy.api#documentation": "The file containing the results of the task assessment.
" + "smithy.api#documentation": "Detailed information about the pending maintenance action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Identifies an DMS resource and any pending actions for it.
" + } + }, + "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.databasemigrationservice#ExceptionMessage", + "traits": { + "smithy.api#documentation": "" } + } + }, + "traits": { + "smithy.api#documentation": "The quota for this resource quota has been exceeded.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.databasemigrationservice#RunFleetAdvisorLsaAnalysis": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#RunFleetAdvisorLsaAnalysisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, - "AssessmentResults": { + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account.
" + } + }, + "com.amazonaws.databasemigrationservice#RunFleetAdvisorLsaAnalysisResponse": { + "type": "structure", + "members": { + "LsaAnalysisId": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The task assessment results in JSON format.
\nThe response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn\n in the request.
" + "smithy.api#documentation": "The ID of the LSA analysis run.
" } }, - "S3ObjectUrl": { + "Status": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The URL of the S3 object containing the task assessment results.
\nThe response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn\n in the request.
" + "smithy.api#documentation": "The status of the LSA analysis, for example COMPLETED.
The task assessment report in JSON format.
" + "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentResultList": { - "type": "list", - "member": { - "target": "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentResult", - "traits": { - "smithy.api#xmlName": "ReplicationTaskAssessmentResult" + "com.amazonaws.databasemigrationservice#S3AccessDeniedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.databasemigrationservice#ExceptionMessage" } + }, + "traits": { + "smithy.api#documentation": "Insufficient privileges are preventing access to an Amazon S3 object.
", + "smithy.api#error": "client" } }, - "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentRun": { + "com.amazonaws.databasemigrationservice#S3ResourceNotFoundFault": { "type": "structure", "members": { - "ReplicationTaskAssessmentRunArn": { + "message": { + "target": "com.amazonaws.databasemigrationservice#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "A specified Amazon S3 bucket, bucket folder, or other object can't be\n found.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.databasemigrationservice#S3Settings": { + "type": "structure", + "members": { + "ServiceAccessRoleArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Amazon Resource Name (ARN) of this assessment run.
" + "smithy.api#documentation": " The Amazon Resource Name (ARN) used by the service to access the IAM role.\n The role must allow the iam:PassRole action. It is a required\n parameter that enables DMS to write and read objects from an S3 bucket.
ARN of the migration task associated with this premigration\n assessment run.
" + "smithy.api#documentation": "Specifies how tables are defined in the S3 source files only.
" } }, - "Status": { + "CsvRowDelimiter": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Assessment run status.
\nThis status can have one of the following values:
\n\n \"cancelling\" – The assessment run was canceled by the\n CancelReplicationTaskAssessmentRun operation.
\n \"deleting\" – The assessment run was deleted by the\n DeleteReplicationTaskAssessmentRun operation.
\n \"failed\" – At least one individual assessment completed with a\n failed status.
\n \"error-provisioning\" – An internal error occurred while\n resources were provisioned (during provisioning status).
\n \"error-executing\" – An internal error occurred while\n individual assessments ran (during running status).
\n \"invalid state\" – The assessment run is in an unknown state.
\n \"passed\" – All individual assessments have completed, and none\n has a failed status.
\n \"provisioning\" – Resources required to run individual\n assessments are being provisioned.
\n \"running\" – Individual assessments are being run.
\n \"starting\" – The assessment run is starting, but resources are not yet\n being provisioned for individual assessments.
The delimiter used to separate rows in the .csv file for both source and target. The default is a carriage\n return (\\n).
Date on which the assessment run was created using the\n StartReplicationTaskAssessmentRun operation.
The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.\n
" } }, - "AssessmentProgress": { - "target": "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentRunProgress", + "BucketFolder": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Indication of the completion progress for the individual assessments specified to\n run.
" + "smithy.api#documentation": " An optional parameter to set a folder name in the S3 bucket. If provided, tables are\n created in the path\n \n bucketFolder/schema_name/table_name/.\n If this parameter isn't specified, then the path used is\n \n schema_name/table_name/.
Last message generated by an individual assessment failure.
" + "smithy.api#documentation": "The name of the S3 bucket.
" } }, - "ServiceAccessRoleArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "CompressionType": { + "target": "com.amazonaws.databasemigrationservice#CompressionTypeValue", "traits": { - "smithy.api#documentation": "ARN of the service role used to start the assessment run using the\n StartReplicationTaskAssessmentRun operation. The role must allow the iam:PassRole action.
An optional parameter to use GZIP to compress the target files. Set to GZIP to compress\n the target files. Either set this parameter to NONE (the default) or don't use it to leave the files uncompressed.\n This parameter applies to both .csv and .parquet file formats.
" } }, - "ResultLocationBucket": { - "target": "com.amazonaws.databasemigrationservice#String", + "EncryptionMode": { + "target": "com.amazonaws.databasemigrationservice#EncryptionModeValue", "traits": { - "smithy.api#documentation": "Amazon S3 bucket where DMS stores the results of this assessment run.
" + "smithy.api#documentation": "The type of server-side encryption that you want to use for your data. This encryption\n type is part of the endpoint settings or the extra connections attributes for Amazon S3.\n You can choose either SSE_S3 (the default) or SSE_KMS.
For the ModifyEndpoint operation, you can change the existing value of\n the EncryptionMode parameter from SSE_KMS to\n SSE_S3. But you can’t change the existing value from SSE_S3\n to SSE_KMS.
To use SSE_S3, you need an Identity and Access Management (IAM) role\n with permission to allow \"arn:aws:s3:::dms-*\" to use the following\n actions:
\n s3:CreateBucket\n
\n s3:ListBucket\n
\n s3:DeleteBucket\n
\n s3:GetBucketLocation\n
\n s3:GetObject\n
\n s3:PutObject\n
\n s3:DeleteObject\n
\n s3:GetObjectVersion\n
\n s3:GetBucketPolicy\n
\n s3:PutBucketPolicy\n
\n s3:DeleteBucketPolicy\n
Folder in an Amazon S3 bucket where DMS stores the results of this assessment\n run.
" + "smithy.api#documentation": "If you are using SSE_KMS for the EncryptionMode, provide the\n KMS key ID. The key that you use needs an attached policy that enables Identity and Access Management\n (IAM) user permissions and allows use of the key.
Here is a CLI example: aws dms create-endpoint --endpoint-identifier\n value --endpoint-type target --engine-name s3 --s3-settings\n ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value\n \n
Encryption mode used to encrypt the assessment run results.
" + "smithy.api#documentation": "The format of the data that you want to use for output. You can choose one of the\n following:
\n\n csv : This is a row-based file format with comma-separated values\n (.csv).
\n parquet : Apache Parquet (.parquet) is a columnar storage file format\n that features efficient compression and provides faster query response.
ARN of the KMS encryption key used to encrypt the assessment run results.
" + "smithy.api#documentation": "The type of encoding you are using:
\n\n RLE_DICTIONARY uses a combination of bit-packing and run-length\n encoding to store repeated values more efficiently. This is the default.
\n PLAIN doesn't use encoding at all. Values are stored as they\n are.
\n PLAIN_DICTIONARY builds a dictionary of the values encountered in a\n given column. The dictionary is stored in a dictionary page for each column\n chunk.
Unique name of the assessment run.
" + "smithy.api#documentation": "The maximum size of an encoded dictionary page of a column. If the dictionary page\n exceeds this, this column is stored using an encoding type of PLAIN. This\n parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a dictionary page\n before it reverts to PLAIN encoding. This size is used for\n .parquet file format only.
Provides information that describes a premigration assessment run that you have started\n using the StartReplicationTaskAssessmentRun operation.
Some of the information appears based on other operations that can return the\n ReplicationTaskAssessmentRun object.
The number of rows in a row group. A smaller row group size provides faster reads. But\n as the number of row groups grows, the slower writes become. This parameter defaults to\n 10,000 rows. This number is used for .parquet file format only.
\nIf you choose a value larger than the maximum, RowGroupLength is set to the\n max row group length in bytes (64 * 1024 * 1024).
The size of one data page in bytes. This parameter defaults to 1024 * 1024 bytes (1 MiB).\n This number is used for .parquet file format only.
" + } + }, + "ParquetVersion": { + "target": "com.amazonaws.databasemigrationservice#ParquetVersionValue", + "traits": { + "smithy.api#documentation": "The version of the Apache Parquet format that you want to use: parquet_1_0\n (the default) or parquet_2_0.
The number of individual assessments that are specified to run.
" + "smithy.api#documentation": "A value that enables statistics for Parquet pages and row groups. Choose\n true to enable statistics, false to disable. Statistics\n include NULL, DISTINCT, MAX, and MIN\n values. This parameter defaults to true. This value is used for\n .parquet file format only.
The number of individual assessments that have completed, successfully or not.
" + "smithy.api#documentation": "A value that enables a full load to write INSERT operations to the comma-separated value\n (.csv) or .parquet output files only to indicate how the rows were added to the source database.
\nDMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 and\n later.
DMS supports the use of the .parquet files with the IncludeOpForFullLoad \n parameter in versions 3.4.7 and later.
For full load, records can only be inserted. By default (the false\n setting), no information is recorded in these output files for a full load to indicate that\n the rows were inserted at the source database. If IncludeOpForFullLoad is set\n to true or y, the INSERT is recorded as an I annotation in the\n first field of the .csv file. This allows the format of your target records from a full\n load to be consistent with the target records from a CDC load.
This setting works together with the CdcInsertsOnly and the\n CdcInsertsAndUpdates parameters for output to .csv files only. For more\n information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service\n User Guide..
The progress values reported by the AssessmentProgress response\n element.
Amazon Resource Name (ARN) of this individual assessment.
" + "smithy.api#documentation": "A value that enables a change data capture (CDC) load to write only INSERT operations to\n .csv or columnar storage (.parquet) output files. By default (the\n false setting), the first field in a .csv or .parquet record contains the\n letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was\n inserted, updated, or deleted at the source database for a CDC load to the target.
If CdcInsertsOnly is set to true or y, only\n INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format\n only, how these INSERTs are recorded depends on the value of\n IncludeOpForFullLoad. If IncludeOpForFullLoad is set to\n true, the first field of every CDC record is set to I to indicate the\n INSERT operation at the source. If IncludeOpForFullLoad is set to\n false, every CDC record is written without a first field to indicate the\n INSERT operation at the source. For more information about how these settings work\n together, see Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service User Guide..
DMS supports the interaction described preceding between the\n CdcInsertsOnly and IncludeOpForFullLoad parameters in\n versions 3.1.4 and later.
\n CdcInsertsOnly and CdcInsertsAndUpdates can't\n both be set to true for the same endpoint. Set either\n CdcInsertsOnly or CdcInsertsAndUpdates to true\n for the same endpoint, but not both.
ARN of the premigration assessment run that is created to run this individual\n assessment.
" + "smithy.api#documentation": "A value that when nonblank causes DMS to add a column with timestamp information to\n the endpoint data for an Amazon S3 target.
\nDMS supports the TimestampColumnName parameter in versions 3.1.4 and later.
DMS includes an additional STRING column in the\n .csv or .parquet object files of your migrated data when you set\n TimestampColumnName to a nonblank value.
For a full load, each row of this timestamp column contains a\n timestamp for when the data was transferred from the source to\n the target by DMS.
\nFor a change data capture (CDC) load, each row of the timestamp column contains the\n timestamp for the commit of that row in the source\n database.
\nThe string format for this timestamp column value is\n yyyy-MM-dd HH:mm:ss.SSSSSS. By default, the\n precision of this value is in microseconds. For a CDC load, the\n rounding of the precision depends on the commit timestamp\n supported by DMS for the source database.
When the AddColumnName parameter is set to true, DMS also\n includes a name for the timestamp column that you set with\n TimestampColumnName.
Name of this individual assessment.
" + "smithy.api#documentation": "A value that specifies the precision of any TIMESTAMP column values that\n are written to an Amazon S3 object file in .parquet format.
DMS supports the ParquetTimestampInMillisecond parameter in versions\n 3.1.4 and later.
When ParquetTimestampInMillisecond is set to true or\n y, DMS writes all TIMESTAMP columns in a .parquet\n formatted file with millisecond precision. Otherwise, DMS writes them with microsecond\n precision.
Currently, Amazon Athena and Glue can handle only\n millisecond precision for TIMESTAMP values. Set\n this parameter to true for S3 endpoint object\n files that are .parquet formatted only if you plan to query or process the data with Athena or Glue.
DMS writes any TIMESTAMP column\n values written to an S3 file in .csv format with\n microsecond precision.
Setting ParquetTimestampInMillisecond has no effect on the string\n format of the timestamp column value that is inserted by setting the\n TimestampColumnName parameter.
Individual assessment status.
\nThis status can have one of the following values:
\n\n \"cancelled\"\n
\n \"error\"\n
\n \"failed\"\n
\n \"passed\"\n
\n \"pending\"\n
\n \"running\"\n
A value that enables a change data capture (CDC) load to write INSERT and UPDATE\n operations to .csv or .parquet (columnar storage) output files. The default setting is\n false, but when CdcInsertsAndUpdates is set to\n true or y, only INSERTs and UPDATEs from the source database\n are migrated to the .csv or .parquet file.
DMS supports the use of the .parquet files in versions 3.4.7 and later.
\nHow these INSERTs and UPDATEs are recorded depends on the\n value of the IncludeOpForFullLoad parameter. If\n IncludeOpForFullLoad is set to true, the first field of every\n CDC record is set to either I or U to indicate INSERT and UPDATE\n operations at the source. But if IncludeOpForFullLoad is set to\n false, CDC records are written without an indication of INSERT or UPDATE\n operations at the source. For more information about how these settings work together, see\n Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service User Guide..
DMS supports the use of the CdcInsertsAndUpdates parameter in\n versions 3.3.1 and later.
\n CdcInsertsOnly and CdcInsertsAndUpdates can't\n both be set to true for the same endpoint. Set either\n CdcInsertsOnly or CdcInsertsAndUpdates to true\n for the same endpoint, but not both.
Date when this individual assessment was started as part of running the\n StartReplicationTaskAssessmentRun operation.
When set to true, this parameter partitions S3 bucket folders based on\n transaction commit dates. The default value is false. For more information\n about date-based folder partitioning, see Using date-based folder partitioning.
Provides information that describes an individual assessment from a premigration\n assessment run.
" - } - }, - "com.amazonaws.databasemigrationservice#ReplicationTaskIndividualAssessmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.databasemigrationservice#ReplicationTaskIndividualAssessment" - } - }, - "com.amazonaws.databasemigrationservice#ReplicationTaskList": { - "type": "list", - "member": { - "target": "com.amazonaws.databasemigrationservice#ReplicationTask", - "traits": { - "smithy.api#xmlName": "ReplicationTask" - } - } - }, - "com.amazonaws.databasemigrationservice#ReplicationTaskStats": { - "type": "structure", - "members": { - "FullLoadProgressPercent": { - "target": "com.amazonaws.databasemigrationservice#Integer", + }, + "DatePartitionSequence": { + "target": "com.amazonaws.databasemigrationservice#DatePartitionSequenceValue", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The percent complete for the full load migration task.
" + "smithy.api#documentation": "Identifies the sequence of the date format to use during folder partitioning. The default value is \n YYYYMMDD. Use this parameter when DatePartitionedEnabled is set to true.
The elapsed time of the task, in milliseconds.
" + "smithy.api#documentation": "Specifies a date separating delimiter to use during folder partitioning. The default value is \n SLASH. Use this parameter when DatePartitionedEnabled is set to true.
The number of tables loaded for this task.
" + "smithy.api#documentation": "This setting applies if the S3 output files during a change data capture (CDC) load are\n written in .csv format. If set to true for columns not included in the\n supplemental log, DMS uses the value specified by \n CsvNoSupValue\n . If not set or set to\n false, DMS uses the null value for these columns.
This setting is supported in DMS versions 3.4.1 and later.
\nThe number of tables currently loading for this task.
" + "smithy.api#documentation": "This setting only applies if your Amazon S3 output files during a change data capture\n (CDC) load are written in .csv format. If \n UseCsvNoSupValue\n is set to true, specify a\n string value that you want DMS to use for all columns not included in the supplemental\n log. If you do not specify a string value, DMS uses the null value for these columns\n regardless of the UseCsvNoSupValue setting.
This setting is supported in DMS versions 3.4.1 and later.
\nThe number of tables queued for this task.
" + "smithy.api#documentation": "If set to true, DMS saves the transaction order for a change data\n capture (CDC) load on the Amazon S3 target specified by \n CdcPath\n . For more information, see Capturing data changes (CDC) including transaction order on the S3\n target.
This setting is supported in DMS versions 3.4.2 and later.
\nThe number of errors that have occurred during this task.
" + "smithy.api#documentation": "Specifies the folder path of CDC files. For an S3 source, this setting is required if a\n task captures change data; otherwise, it's optional. If CdcPath is set, DMS\n reads CDC files from this path and replicates the data changes to the target endpoint.\n For an S3 target if you set \n PreserveTransactions\n to true, DMS\n verifies that you have set this parameter to a folder path on your S3 target where DMS\n can save the transaction order for the CDC load. DMS creates this CDC folder path\n in either your S3 target working directory or the S3 target location specified by \n BucketFolder\n and \n BucketName\n .
For example, if you specify CdcPath as MyChangedData, and you\n specify BucketName as MyTargetBucket but do not specify\n BucketFolder, DMS creates the CDC folder path following:\n MyTargetBucket/MyChangedData.
If you specify the same CdcPath, and you specify BucketName as\n MyTargetBucket and BucketFolder as MyTargetData,\n DMS creates the CDC folder path following:\n MyTargetBucket/MyTargetData/MyChangedData.
For more information on CDC including transaction order on an S3 target, see Capturing data changes (CDC) including transaction order on the S3\n target.
\nThis setting is supported in DMS versions 3.4.2 and later.
\nThe date the replication task was started either with a fresh start or a target reload.
" + "smithy.api#documentation": "When set to true, this parameter uses the task start time as the timestamp column value instead of \n the time data is written to target. For full load, when useTaskStartTimeForFullLoadTimestamp\n is set to true, each row of the timestamp column contains the task start time. For CDC loads, \n each row of the timestamp column contains the transaction commit time.
When useTaskStartTimeForFullLoadTimestamp is set to false, the full load timestamp \n in the timestamp column increments with the time data arrives at the target.
The date the replication task was started either with a fresh start or a resume. For more information, see \n StartReplicationTaskType.
" + "smithy.api#documentation": "A value that enables DMS to specify a predefined (canned) access control list for\n objects created in an Amazon S3 bucket as .csv or .parquet files. For more information\n about Amazon S3 canned ACLs, see Canned\n ACL in the Amazon S3 Developer Guide.\n
\nThe default value is NONE. Valid values include NONE, PRIVATE,\n PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ,\n AWS_EXEC_READ, BUCKET_OWNER_READ, and\n BUCKET_OWNER_FULL_CONTROL.
" } }, - "StopDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "AddColumnName": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "The date the replication task was stopped.
" + "smithy.api#documentation": "An optional parameter that, when set to true or y, you can use\n to add column name information to the .csv output file.
The default value is false. Valid values are true, false,\n y, and n.
The date the replication task full load was started.
" + "smithy.api#documentation": "Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.
\nWhen CdcMaxBatchInterval and CdcMinFileSize are both specified, the\n file write is triggered by whichever parameter condition is met first within an DMS\n CloudFormation template.
The default value is 60 seconds.
" } }, - "FullLoadFinishDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "CdcMinFileSize": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "The date the replication task full load was completed.
" + "smithy.api#documentation": "Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.
\nWhen CdcMinFileSize and CdcMaxBatchInterval are both specified, the file \n write is triggered by whichever parameter condition is met first within an DMS \n CloudFormation template.
The default value is 32 MB.
" } - } - }, - "traits": { - "smithy.api#documentation": "In response to a request by the DescribeReplicationTasks operation, this object provides\n a collection of statistics about a replication task.
An optional parameter that specifies how DMS treats null\n values. While handling the null value, you can use this\n parameter to pass a user-defined string as null when writing to\n the target. For example, when target columns are not nullable,\n you can use this option to differentiate between the empty\n string value and the null value. So, if you set this parameter\n value to the empty string (\"\" or ''), DMS treats the empty\n string as the null value instead of NULL.
The default value is NULL. Valid values include any valid string.
When this value is set to 1, DMS ignores the first row header in a .csv file. A value\n of 1 turns on the feature; a value of 0 turns off the feature.
\nThe default is 0.
" } - } - }, - "traits": { - "smithy.api#documentation": "The resource you are attempting to create already exists.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.databasemigrationservice#ResourceArn": { - "type": "string" - }, - "com.amazonaws.databasemigrationservice#ResourceNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.databasemigrationservice#ExceptionMessage", + }, + "MaxFileSize": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "A value that specifies the maximum size (in KB) of any .csv\n file to be created while migrating to an S3 target during full\n load.
\nThe default value is 1,048,576 KB (1 GB). Valid values include 1 to 1,048,576.
" } - } - }, - "traits": { - "smithy.api#documentation": "The resource could not be found.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.databasemigrationservice#ResourcePendingMaintenanceActions": { - "type": "structure", - "members": { - "ResourceIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", + }, + "Rfc4180": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action\n applies to. For information about creating an ARN, see Constructing an Amazon\n Resource Name (ARN) for DMS in the DMS documentation.
" + "smithy.api#documentation": "For an S3 source, when this value is set to true or y,\n each leading double quotation mark has to be followed by an\n ending double quotation mark. This formatting complies with RFC\n 4180. When this value is set to false or\n n, string literals are copied to the target as\n is. In this case, a delimiter (row or column) signals the end of\n the field. Thus, you can't use a delimiter as part of the\n string, because it signals the end of the value.
For an S3 target, an optional parameter used to set behavior to comply with RFC\n 4180 for data migrated to Amazon S3 using .csv file format only. When this\n value is set to true or y using Amazon\n S3 as a target, if the data has quotation marks or newline\n characters in it, DMS encloses the entire column with an\n additional pair of double quotation marks (\"). Every quotation\n mark within the data is repeated twice.
The default value is true. Valid values include true, false,\n y, and n.
Detailed information about the pending maintenance action.
" + "smithy.api#documentation": "When creating an S3 target endpoint, set DatePartitionTimezone to convert\n the current UTC time into a specified time zone. The conversion occurs when a date\n partition folder is created and a CDC filename is generated. The time zone format is Area/Location.\n Use this parameter when DatePartitionedEnabled is set to true, as shown in the\n following example.
\n s3-settings='{\"DatePartitionEnabled\": true, \"DatePartitionSequence\": \"YYYYMMDDHH\",\n \"DatePartitionDelimiter\": \"SLASH\",\n \"DatePartitionTimezone\":\"Asia/Seoul\", \"BucketName\":\n \"dms-nattarat-test\"}'\n
Identifies an DMS resource and any pending actions for it.
" - } - }, - "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.databasemigrationservice#ExceptionMessage", + }, + "AddTrailingPaddingCharacter": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "Use the S3 target endpoint setting AddTrailingPaddingCharacter to add \n padding on string data. The default value is false.
The quota for this resource quota has been exceeded.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.databasemigrationservice#RunFleetAdvisorLsaAnalysis": { - "type": "operation", - "input": { - "target": "smithy.api#Unit" - }, - "output": { - "target": "com.amazonaws.databasemigrationservice#RunFleetAdvisorLsaAnalysisResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, - { - "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + "ExpectedBucketOwner": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "To specify a bucket owner and prevent sniping, you can use the \n ExpectedBucketOwner endpoint setting.
Example: --s3-settings='{\"ExpectedBucketOwner\": \"AWS_Account_ID\"}'\n
When you make a request to test a connection or perform a migration, S3 checks the account \n ID of the bucket owner against the specified parameter.
" + } + }, + "GlueCatalogGeneration": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "When true, allows Glue to catalog your S3 bucket. Creating an Glue catalog\n lets you use Athena to query your data.
" + } } - ], + }, "traits": { - "smithy.api#documentation": "Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account.
" + "smithy.api#documentation": "Settings for exporting data to Amazon S3.
" } }, - "com.amazonaws.databasemigrationservice#RunFleetAdvisorLsaAnalysisResponse": { + "com.amazonaws.databasemigrationservice#SCApplicationAttributes": { "type": "structure", "members": { - "LsaAnalysisId": { + "S3BucketPath": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The ID of the LSA analysis run.
" + "smithy.api#documentation": "The path for the Amazon S3 bucket that the application uses for exporting assessment reports.
" } }, - "Status": { + "S3BucketRoleArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The status of the LSA analysis, for example COMPLETED.
The ARN for the role the application uses to access its Amazon S3 bucket.
" } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "Provides information that defines a schema conversion application.
" } }, - "com.amazonaws.databasemigrationservice#S3AccessDeniedFault": { + "com.amazonaws.databasemigrationservice#SNSInvalidTopicFault": { "type": "structure", "members": { "message": { - "target": "com.amazonaws.databasemigrationservice#ExceptionMessage" + "target": "com.amazonaws.databasemigrationservice#ExceptionMessage", + "traits": { + "smithy.api#documentation": "" + } } }, "traits": { - "smithy.api#documentation": "Insufficient privileges are preventing access to an Amazon S3 object.
", + "smithy.api#documentation": "The SNS topic is invalid.
", "smithy.api#error": "client" } }, - "com.amazonaws.databasemigrationservice#S3ResourceNotFoundFault": { + "com.amazonaws.databasemigrationservice#SNSNoAuthorizationFault": { "type": "structure", "members": { "message": { - "target": "com.amazonaws.databasemigrationservice#ExceptionMessage" + "target": "com.amazonaws.databasemigrationservice#ExceptionMessage", + "traits": { + "smithy.api#documentation": "" + } } }, "traits": { - "smithy.api#documentation": "A specified Amazon S3 bucket, bucket folder, or other object can't be\n found.
", + "smithy.api#documentation": "You are not authorized for the SNS subscription.
", "smithy.api#error": "client" } }, - "com.amazonaws.databasemigrationservice#S3Settings": { + "com.amazonaws.databasemigrationservice#SafeguardPolicy": { + "type": "enum", + "members": { + "RELY_ON_SQL_SERVER_REPLICATION_AGENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rely-on-sql-server-replication-agent" + } + }, + "EXCLUSIVE_AUTOMATIC_TRUNCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "exclusive-automatic-truncation" + } + }, + "SHARED_AUTOMATIC_TRUNCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "shared-automatic-truncation" + } + } + } + }, + "com.amazonaws.databasemigrationservice#SchemaConversionRequest": { "type": "structure", "members": { - "ServiceAccessRoleArn": { + "Status": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": " The Amazon Resource Name (ARN) used by the service to access the IAM role.\n The role must allow the iam:PassRole action. It is a required\n parameter that enables DMS to write and read objects from an S3 bucket.
The schema conversion action status.
" } }, - "ExternalTableDefinition": { + "RequestIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Specifies how tables are defined in the S3 source files only.
" + "smithy.api#documentation": "The identifier for the schema conversion action.
" } }, - "CsvRowDelimiter": { + "MigrationProjectArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": " The delimiter used to separate rows in the .csv file for both source and target. The default is a carriage\n return (\\n).
The migration project ARN.
" } }, - "CsvDelimiter": { - "target": "com.amazonaws.databasemigrationservice#String", + "Error": { + "target": "com.amazonaws.databasemigrationservice#ErrorDetails" + }, + "ExportSqlDetails": { + "target": "com.amazonaws.databasemigrationservice#ExportSqlDetails" + } + }, + "traits": { + "smithy.api#documentation": "Provides information about a schema conversion action.
" + } + }, + "com.amazonaws.databasemigrationservice#SchemaConversionRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#SchemaConversionRequest" + } + }, + "com.amazonaws.databasemigrationservice#SchemaList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#String" + } + }, + "com.amazonaws.databasemigrationservice#SchemaResponse": { + "type": "structure", + "members": { + "CodeLineCount": { + "target": "com.amazonaws.databasemigrationservice#LongOptional", "traits": { - "smithy.api#documentation": "The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.\n
" + "smithy.api#documentation": "The number of lines of code in a schema in a Fleet Advisor collector inventory.
" } }, - "BucketFolder": { - "target": "com.amazonaws.databasemigrationservice#String", + "CodeSize": { + "target": "com.amazonaws.databasemigrationservice#LongOptional", "traits": { - "smithy.api#documentation": " An optional parameter to set a folder name in the S3 bucket. If provided, tables are\n created in the path\n \n bucketFolder/schema_name/table_name/.\n If this parameter isn't specified, then the path used is\n \n schema_name/table_name/.
The size level of the code in a schema in a Fleet Advisor collector inventory.
" } }, - "BucketName": { + "Complexity": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The name of the S3 bucket.
" + "smithy.api#documentation": "The complexity level of the code in a schema in a Fleet Advisor collector inventory.
" } }, - "CompressionType": { - "target": "com.amazonaws.databasemigrationservice#CompressionTypeValue", + "Server": { + "target": "com.amazonaws.databasemigrationservice#ServerShortInfoResponse", "traits": { - "smithy.api#documentation": "An optional parameter to use GZIP to compress the target files. Set to GZIP to compress\n the target files. Either set this parameter to NONE (the default) or don't use it to leave the files uncompressed.\n This parameter applies to both .csv and .parquet file formats.
" + "smithy.api#documentation": "The database server for a schema in a Fleet Advisor collector inventory.
" } }, - "EncryptionMode": { - "target": "com.amazonaws.databasemigrationservice#EncryptionModeValue", + "DatabaseInstance": { + "target": "com.amazonaws.databasemigrationservice#DatabaseShortInfoResponse", "traits": { - "smithy.api#documentation": "The type of server-side encryption that you want to use for your data. This encryption\n type is part of the endpoint settings or the extra connections attributes for Amazon S3.\n You can choose either SSE_S3 (the default) or SSE_KMS.
For the ModifyEndpoint operation, you can change the existing value of\n the EncryptionMode parameter from SSE_KMS to\n SSE_S3. But you can’t change the existing value from SSE_S3\n to SSE_KMS.
To use SSE_S3, you need an Identity and Access Management (IAM) role\n with permission to allow \"arn:aws:s3:::dms-*\" to use the following\n actions:
\n s3:CreateBucket\n
\n s3:ListBucket\n
\n s3:DeleteBucket\n
\n s3:GetBucketLocation\n
\n s3:GetObject\n
\n s3:PutObject\n
\n s3:DeleteObject\n
\n s3:GetObjectVersion\n
\n s3:GetBucketPolicy\n
\n s3:PutBucketPolicy\n
\n s3:DeleteBucketPolicy\n
The database for a schema in a Fleet Advisor collector inventory.
" } }, - "ServerSideEncryptionKmsKeyId": { + "SchemaId": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "If you are using SSE_KMS for the EncryptionMode, provide the\n KMS key ID. The key that you use needs an attached policy that enables Identity and Access Management\n (IAM) user permissions and allows use of the key.
Here is a CLI example: aws dms create-endpoint --endpoint-identifier\n value --endpoint-type target --engine-name s3 --s3-settings\n ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value\n \n
The ID of a schema in a Fleet Advisor collector inventory.
" } }, - "DataFormat": { - "target": "com.amazonaws.databasemigrationservice#DataFormatValue", + "SchemaName": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The format of the data that you want to use for output. You can choose one of the\n following:
\n\n csv : This is a row-based file format with comma-separated values\n (.csv).
\n parquet : Apache Parquet (.parquet) is a columnar storage file format\n that features efficient compression and provides faster query response.
The name of a schema in a Fleet Advisor collector inventory.
" } }, - "EncodingType": { - "target": "com.amazonaws.databasemigrationservice#EncodingTypeValue", + "OriginalSchema": { + "target": "com.amazonaws.databasemigrationservice#SchemaShortInfoResponse" + }, + "Similarity": { + "target": "com.amazonaws.databasemigrationservice#DoubleOptional", "traits": { - "smithy.api#documentation": "The type of encoding you are using:
\n\n RLE_DICTIONARY uses a combination of bit-packing and run-length\n encoding to store repeated values more efficiently. This is the default.
\n PLAIN doesn't use encoding at all. Values are stored as they\n are.
\n PLAIN_DICTIONARY builds a dictionary of the values encountered in a\n given column. The dictionary is stored in a dictionary page for each column\n chunk.
The similarity value for a schema in a Fleet Advisor collector inventory. A higher similarity value\n indicates that a schema is likely to be a duplicate.
" } - }, - "DictPageSizeLimit": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + } + }, + "traits": { + "smithy.api#documentation": "Describes a schema in a Fleet Advisor collector inventory.
" + } + }, + "com.amazonaws.databasemigrationservice#SchemaShortInfoResponse": { + "type": "structure", + "members": { + "SchemaId": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The maximum size of an encoded dictionary page of a column. If the dictionary page\n exceeds this, this column is stored using an encoding type of PLAIN. This\n parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a dictionary page\n before it reverts to PLAIN encoding. This size is used for\n .parquet file format only.
The ID of a schema in a Fleet Advisor collector inventory.
" } }, - "RowGroupLength": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "SchemaName": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The number of rows in a row group. A smaller row group size provides faster reads. But\n as the number of row groups grows, the slower writes become. This parameter defaults to\n 10,000 rows. This number is used for .parquet file format only.
\nIf you choose a value larger than the maximum, RowGroupLength is set to the\n max row group length in bytes (64 * 1024 * 1024).
The name of a schema in a Fleet Advisor collector inventory.
" } }, - "DataPageSize": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "DatabaseId": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The size of one data page in bytes. This parameter defaults to 1024 * 1024 bytes (1 MiB).\n This number is used for .parquet file format only.
" + "smithy.api#documentation": "The ID of a database in a Fleet Advisor collector inventory.
" } }, - "ParquetVersion": { - "target": "com.amazonaws.databasemigrationservice#ParquetVersionValue", + "DatabaseName": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The version of the Apache Parquet format that you want to use: parquet_1_0\n (the default) or parquet_2_0.
The name of a database in a Fleet Advisor collector inventory.
" } }, - "EnableStatistics": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "DatabaseIpAddress": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "A value that enables statistics for Parquet pages and row groups. Choose\n true to enable statistics, false to disable. Statistics\n include NULL, DISTINCT, MAX, and MIN\n values. This parameter defaults to true. This value is used for\n .parquet file format only.
The IP address of a database in a Fleet Advisor collector inventory.
" } - }, - "IncludeOpForFullLoad": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + } + }, + "traits": { + "smithy.api#documentation": "Describes a schema in a Fleet Advisor collector inventory.
" + } + }, + "com.amazonaws.databasemigrationservice#SecretString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.databasemigrationservice#ServerShortInfoResponse": { + "type": "structure", + "members": { + "ServerId": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "A value that enables a full load to write INSERT operations to the comma-separated value\n (.csv) or .parquet output files only to indicate how the rows were added to the source database.
\nDMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 and\n later.
DMS supports the use of the .parquet files with the IncludeOpForFullLoad \n parameter in versions 3.4.7 and later.
For full load, records can only be inserted. By default (the false\n setting), no information is recorded in these output files for a full load to indicate that\n the rows were inserted at the source database. If IncludeOpForFullLoad is set\n to true or y, the INSERT is recorded as an I annotation in the\n first field of the .csv file. This allows the format of your target records from a full\n load to be consistent with the target records from a CDC load.
This setting works together with the CdcInsertsOnly and the\n CdcInsertsAndUpdates parameters for output to .csv files only. For more\n information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service\n User Guide..
The ID of a server in a Fleet Advisor collector inventory.
" } }, - "CdcInsertsOnly": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "IpAddress": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "A value that enables a change data capture (CDC) load to write only INSERT operations to\n .csv or columnar storage (.parquet) output files. By default (the\n false setting), the first field in a .csv or .parquet record contains the\n letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was\n inserted, updated, or deleted at the source database for a CDC load to the target.
If CdcInsertsOnly is set to true or y, only\n INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format\n only, how these INSERTs are recorded depends on the value of\n IncludeOpForFullLoad. If IncludeOpForFullLoad is set to\n true, the first field of every CDC record is set to I to indicate the\n INSERT operation at the source. If IncludeOpForFullLoad is set to\n false, every CDC record is written without a first field to indicate the\n INSERT operation at the source. For more information about how these settings work\n together, see Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service User Guide..
DMS supports the interaction described preceding between the\n CdcInsertsOnly and IncludeOpForFullLoad parameters in\n versions 3.1.4 and later.
\n CdcInsertsOnly and CdcInsertsAndUpdates can't\n both be set to true for the same endpoint. Set either\n CdcInsertsOnly or CdcInsertsAndUpdates to true\n for the same endpoint, but not both.
The IP address of a server in a Fleet Advisor collector inventory.
" } }, - "TimestampColumnName": { + "ServerName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "A value that when nonblank causes DMS to add a column with timestamp information to\n the endpoint data for an Amazon S3 target.
\nDMS supports the TimestampColumnName parameter in versions 3.1.4 and later.
DMS includes an additional STRING column in the\n .csv or .parquet object files of your migrated data when you set\n TimestampColumnName to a nonblank value.
For a full load, each row of this timestamp column contains a\n timestamp for when the data was transferred from the source to\n the target by DMS.
\nFor a change data capture (CDC) load, each row of the timestamp column contains the\n timestamp for the commit of that row in the source\n database.
\nThe string format for this timestamp column value is\n yyyy-MM-dd HH:mm:ss.SSSSSS. By default, the\n precision of this value is in microseconds. For a CDC load, the\n rounding of the precision depends on the commit timestamp\n supported by DMS for the source database.
When the AddColumnName parameter is set to true, DMS also\n includes a name for the timestamp column that you set with\n TimestampColumnName.
The name address of a server in a Fleet Advisor collector inventory.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a server in a Fleet Advisor collector inventory.
" + } + }, + "com.amazonaws.databasemigrationservice#SourceIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#xmlName": "SourceId" + } + } + }, + "com.amazonaws.databasemigrationservice#SourceType": { + "type": "enum", + "members": { + "replication_instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "replication-instance" + } + } + } + }, + "com.amazonaws.databasemigrationservice#SslSecurityProtocolValue": { + "type": "enum", + "members": { + "PLAINTEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "plaintext" + } + }, + "SSL_ENCRYPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ssl-encryption" } + } + } + }, + "com.amazonaws.databasemigrationservice#StartExtensionPackAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#StartExtensionPackAssociationMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#StartExtensionPackAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, - "ParquetTimestampInMillisecond": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": "A value that specifies the precision of any TIMESTAMP column values that\n are written to an Amazon S3 object file in .parquet format.
DMS supports the ParquetTimestampInMillisecond parameter in versions\n 3.1.4 and later.
When ParquetTimestampInMillisecond is set to true or\n y, DMS writes all TIMESTAMP columns in a .parquet\n formatted file with millisecond precision. Otherwise, DMS writes them with microsecond\n precision.
Currently, Amazon Athena and Glue can handle only\n millisecond precision for TIMESTAMP values. Set\n this parameter to true for S3 endpoint object\n files that are .parquet formatted only if you plan to query or process the data with Athena or Glue.
DMS writes any TIMESTAMP column\n values written to an S3 file in .csv format with\n microsecond precision.
Setting ParquetTimestampInMillisecond has no effect on the string\n format of the timestamp column value that is inserted by setting the\n TimestampColumnName parameter.
A value that enables a change data capture (CDC) load to write INSERT and UPDATE\n operations to .csv or .parquet (columnar storage) output files. The default setting is\n false, but when CdcInsertsAndUpdates is set to\n true or y, only INSERTs and UPDATEs from the source database\n are migrated to the .csv or .parquet file.
DMS supports the use of the .parquet files in versions 3.4.7 and later.
\nHow these INSERTs and UPDATEs are recorded depends on the\n value of the IncludeOpForFullLoad parameter. If\n IncludeOpForFullLoad is set to true, the first field of every\n CDC record is set to either I or U to indicate INSERT and UPDATE\n operations at the source. But if IncludeOpForFullLoad is set to\n false, CDC records are written without an indication of INSERT or UPDATE\n operations at the source. For more information about how these settings work together, see\n Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service User Guide..
DMS supports the use of the CdcInsertsAndUpdates parameter in\n versions 3.3.1 and later.
\n CdcInsertsOnly and CdcInsertsAndUpdates can't\n both be set to true for the same endpoint. Set either\n CdcInsertsOnly or CdcInsertsAndUpdates to true\n for the same endpoint, but not both.
When set to true, this parameter partitions S3 bucket folders based on\n transaction commit dates. The default value is false. For more information\n about date-based folder partitioning, see Using date-based folder partitioning.
Identifies the sequence of the date format to use during folder partitioning. The default value is \n YYYYMMDD. Use this parameter when DatePartitionedEnabled is set to true.
Specifies a date separating delimiter to use during folder partitioning. The default value is \n SLASH. Use this parameter when DatePartitionedEnabled is set to true.
Applies the extension pack to your target database. An extension pack is an add-on \n module that emulates functions present in a source database that are required when \n converting objects to the target database. \n
" + } + }, + "com.amazonaws.databasemigrationservice#StartExtensionPackAssociationMessage": { + "type": "structure", + "members": { + "MigrationProjectIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "This setting applies if the S3 output files during a change data capture (CDC) load are\n written in .csv format. If set to true for columns not included in the\n supplemental log, DMS uses the value specified by \n CsvNoSupValue\n . If not set or set to\n false, DMS uses the null value for these columns.
This setting is supported in DMS versions 3.4.1 and later.
\nThe migration project name or Amazon Resource Name (ARN).
", + "smithy.api#required": {} } - }, - "CsvNoSupValue": { + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#StartExtensionPackAssociationResponse": { + "type": "structure", + "members": { + "RequestIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "This setting only applies if your Amazon S3 output files during a change data capture\n (CDC) load are written in .csv format. If \n UseCsvNoSupValue\n is set to true, specify a\n string value that you want DMS to use for all columns not included in the supplemental\n log. If you do not specify a string value, DMS uses the null value for these columns\n regardless of the UseCsvNoSupValue setting.
This setting is supported in DMS versions 3.4.1 and later.
\nThe identifier for the request operation.
" } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#StartMetadataModelAssessment": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#StartMetadataModelAssessmentMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#StartMetadataModelAssessmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, - "PreserveTransactions": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": "If set to true, DMS saves the transaction order for a change data\n capture (CDC) load on the Amazon S3 target specified by \n CdcPath\n . For more information, see Capturing data changes (CDC) including transaction order on the S3\n target.
This setting is supported in DMS versions 3.4.2 and later.
\nSpecifies the folder path of CDC files. For an S3 source, this setting is required if a\n task captures change data; otherwise, it's optional. If CdcPath is set, DMS\n reads CDC files from this path and replicates the data changes to the target endpoint.\n For an S3 target if you set \n PreserveTransactions\n to true, DMS\n verifies that you have set this parameter to a folder path on your S3 target where DMS\n can save the transaction order for the CDC load. DMS creates this CDC folder path\n in either your S3 target working directory or the S3 target location specified by \n BucketFolder\n and \n BucketName\n .
For example, if you specify CdcPath as MyChangedData, and you\n specify BucketName as MyTargetBucket but do not specify\n BucketFolder, DMS creates the CDC folder path following:\n MyTargetBucket/MyChangedData.
If you specify the same CdcPath, and you specify BucketName as\n MyTargetBucket and BucketFolder as MyTargetData,\n DMS creates the CDC folder path following:\n MyTargetBucket/MyTargetData/MyChangedData.
For more information on CDC including transaction order on an S3 target, see Capturing data changes (CDC) including transaction order on the S3\n target.
\nThis setting is supported in DMS versions 3.4.2 and later.
\nWhen set to true, this parameter uses the task start time as the timestamp column value instead of \n the time data is written to target. For full load, when useTaskStartTimeForFullLoadTimestamp\n is set to true, each row of the timestamp column contains the task start time. For CDC loads, \n each row of the timestamp column contains the transaction commit time.
When useTaskStartTimeForFullLoadTimestamp is set to false, the full load timestamp \n in the timestamp column increments with the time data arrives at the target.
A value that enables DMS to specify a predefined (canned) access control list for\n objects created in an Amazon S3 bucket as .csv or .parquet files. For more information\n about Amazon S3 canned ACLs, see Canned\n ACL in the Amazon S3 Developer Guide.\n
\nThe default value is NONE. Valid values include NONE, PRIVATE,\n PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ,\n AWS_EXEC_READ, BUCKET_OWNER_READ, and\n BUCKET_OWNER_FULL_CONTROL.
" - } + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" }, - "AddColumnName": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": "An optional parameter that, when set to true or y, you can use\n to add column name information to the .csv output file.
The default value is false. Valid values are true, false,\n y, and n.
Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.
\nWhen CdcMaxBatchInterval and CdcMinFileSize are both specified, the\n file write is triggered by whichever parameter condition is met first within an DMS\n CloudFormation template.
The default value is 60 seconds.
" - } + { + "target": "com.amazonaws.databasemigrationservice#S3AccessDeniedFault" }, - "CdcMinFileSize": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + { + "target": "com.amazonaws.databasemigrationservice#S3ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Creates a database migration assessment report by assessing the migration complexity for \n your source database. A database migration assessment report summarizes all of the schema \n conversion tasks. It also details the action items for database objects that can't be converted \n to the database engine of your target database instance.
" + } + }, + "com.amazonaws.databasemigrationservice#StartMetadataModelAssessmentMessage": { + "type": "structure", + "members": { + "MigrationProjectIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3.
\nWhen CdcMinFileSize and CdcMaxBatchInterval are both specified, the file \n write is triggered by whichever parameter condition is met first within an DMS \n CloudFormation template.
The default value is 32 MB.
" + "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", + "smithy.api#required": {} } }, - "CsvNullValue": { + "SelectionRules": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "An optional parameter that specifies how DMS treats null\n values. While handling the null value, you can use this\n parameter to pass a user-defined string as null when writing to\n the target. For example, when target columns are not nullable,\n you can use this option to differentiate between the empty\n string value and the null value. So, if you set this parameter\n value to the empty string (\"\" or ''), DMS treats the empty\n string as the null value instead of NULL.
The default value is NULL. Valid values include any valid string.
A value that specifies the database objects to assess.
", + "smithy.api#required": {} } - }, - "IgnoreHeaderRows": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#StartMetadataModelAssessmentResponse": { + "type": "structure", + "members": { + "RequestIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "When this value is set to 1, DMS ignores the first row header in a .csv file. A value\n of 1 turns on the feature; a value of 0 turns off the feature.
\nThe default is 0.
" + "smithy.api#documentation": "The identifier for the assessment operation.
" } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#StartMetadataModelConversion": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#StartMetadataModelConversionMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#StartMetadataModelConversionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, - "MaxFileSize": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", - "traits": { - "smithy.api#documentation": "A value that specifies the maximum size (in KB) of any .csv\n file to be created while migrating to an S3 target during full\n load.
\nThe default value is 1,048,576 KB (1 GB). Valid values include 1 to 1,048,576.
" - } + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, - "Rfc4180": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": "For an S3 source, when this value is set to true or y,\n each leading double quotation mark has to be followed by an\n ending double quotation mark. This formatting complies with RFC\n 4180. When this value is set to false or\n n, string literals are copied to the target as\n is. In this case, a delimiter (row or column) signals the end of\n the field. Thus, you can't use a delimiter as part of the\n string, because it signals the end of the value.
For an S3 target, an optional parameter used to set behavior to comply with RFC\n 4180 for data migrated to Amazon S3 using .csv file format only. When this\n value is set to true or y using Amazon\n S3 as a target, if the data has quotation marks or newline\n characters in it, DMS encloses the entire column with an\n additional pair of double quotation marks (\"). Every quotation\n mark within the data is repeated twice.
The default value is true. Valid values include true, false,\n y, and n.
When creating an S3 target endpoint, set DatePartitionTimezone to convert\n the current UTC time into a specified time zone. The conversion occurs when a date\n partition folder is created and a CDC filename is generated. The time zone format is Area/Location.\n Use this parameter when DatePartitionedEnabled is set to true, as shown in the\n following example.
\n s3-settings='{\"DatePartitionEnabled\": true, \"DatePartitionSequence\": \"YYYYMMDDHH\",\n \"DatePartitionDelimiter\": \"SLASH\",\n \"DatePartitionTimezone\":\"Asia/Seoul\", \"BucketName\":\n \"dms-nattarat-test\"}'\n
Use the S3 target endpoint setting AddTrailingPaddingCharacter to add \n padding on string data. The default value is false.
Converts your source database objects to a format compatible with the target database.
" + } + }, + "com.amazonaws.databasemigrationservice#StartMetadataModelConversionMessage": { + "type": "structure", + "members": { + "MigrationProjectIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "To specify a bucket owner and prevent sniping, you can use the \n ExpectedBucketOwner endpoint setting.
Example: --s3-settings='{\"ExpectedBucketOwner\": \"AWS_Account_ID\"}'\n
When you make a request to test a connection or perform a migration, S3 checks the account \n ID of the bucket owner against the specified parameter.
" + "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", + "smithy.api#required": {} } }, - "GlueCatalogGeneration": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "SelectionRules": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "When true, allows Glue to catalog your S3 bucket. Creating an Glue catalog\n lets you use Athena to query your data.
" + "smithy.api#documentation": "A value that specifies the database objects to convert.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Settings for exporting data to Amazon S3.
" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#SNSInvalidTopicFault": { + "com.amazonaws.databasemigrationservice#StartMetadataModelConversionResponse": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.databasemigrationservice#ExceptionMessage", + "RequestIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "The identifier for the conversion operation.
" } } }, "traits": { - "smithy.api#documentation": "The SNS topic is invalid.
", - "smithy.api#error": "client" + "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#SNSNoAuthorizationFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.databasemigrationservice#ExceptionMessage", - "traits": { - "smithy.api#documentation": "" - } + "com.amazonaws.databasemigrationservice#StartMetadataModelExportAsScript": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#StartMetadataModelExportAsScriptMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#StartMetadataModelExportAsScriptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#S3AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#S3ResourceNotFoundFault" } - }, + ], "traits": { - "smithy.api#documentation": "You are not authorized for the SNS subscription.
", - "smithy.api#error": "client" + "smithy.api#documentation": "Saves your converted code to a file as a SQL script, and stores this file on your Amazon S3 bucket.
" } }, - "com.amazonaws.databasemigrationservice#SafeguardPolicy": { - "type": "enum", + "com.amazonaws.databasemigrationservice#StartMetadataModelExportAsScriptMessage": { + "type": "structure", "members": { - "RELY_ON_SQL_SERVER_REPLICATION_AGENT": { - "target": "smithy.api#Unit", + "MigrationProjectIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#enumValue": "rely-on-sql-server-replication-agent" + "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", + "smithy.api#required": {} } }, - "EXCLUSIVE_AUTOMATIC_TRUNCATION": { - "target": "smithy.api#Unit", + "SelectionRules": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#enumValue": "exclusive-automatic-truncation" + "smithy.api#documentation": "A value that specifies the database objects to export.
", + "smithy.api#required": {} } }, - "SHARED_AUTOMATIC_TRUNCATION": { - "target": "smithy.api#Unit", + "Origin": { + "target": "com.amazonaws.databasemigrationservice#OriginTypeValue", "traits": { - "smithy.api#enumValue": "shared-automatic-truncation" + "smithy.api#documentation": "Whether to export the metadata model from the source or the target.
", + "smithy.api#required": {} + } + }, + "FileName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "The name of the model file to create in the Amazon S3 bucket.
" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#SchemaList": { - "type": "list", - "member": { - "target": "com.amazonaws.databasemigrationservice#String" - } - }, - "com.amazonaws.databasemigrationservice#SchemaResponse": { + "com.amazonaws.databasemigrationservice#StartMetadataModelExportAsScriptResponse": { "type": "structure", "members": { - "CodeLineCount": { - "target": "com.amazonaws.databasemigrationservice#LongOptional", - "traits": { - "smithy.api#documentation": "The number of lines of code in a schema in a Fleet Advisor collector inventory.
" - } - }, - "CodeSize": { - "target": "com.amazonaws.databasemigrationservice#LongOptional", - "traits": { - "smithy.api#documentation": "The size level of the code in a schema in a Fleet Advisor collector inventory.
" - } - }, - "Complexity": { + "RequestIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The complexity level of the code in a schema in a Fleet Advisor collector inventory.
" + "smithy.api#documentation": "The identifier for the export operation.
" } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#StartMetadataModelExportToTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#StartMetadataModelExportToTargetMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#StartMetadataModelExportToTargetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, - "Server": { - "target": "com.amazonaws.databasemigrationservice#ServerShortInfoResponse", - "traits": { - "smithy.api#documentation": "The database server for a schema in a Fleet Advisor collector inventory.
" - } + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, - "DatabaseInstance": { - "target": "com.amazonaws.databasemigrationservice#DatabaseShortInfoResponse", - "traits": { - "smithy.api#documentation": "The database for a schema in a Fleet Advisor collector inventory.
" - } + { + "target": "com.amazonaws.databasemigrationservice#KMSKeyNotAccessibleFault" }, - "SchemaId": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "The ID of a schema in a Fleet Advisor collector inventory.
" - } + { + "target": "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault" }, - "SchemaName": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "The name of a schema in a Fleet Advisor collector inventory.
" - } + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" }, - "OriginalSchema": { - "target": "com.amazonaws.databasemigrationservice#SchemaShortInfoResponse" + { + "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" }, - "Similarity": { - "target": "com.amazonaws.databasemigrationservice#DoubleOptional", - "traits": { - "smithy.api#documentation": "The similarity value for a schema in a Fleet Advisor collector inventory. A higher similarity value\n indicates that a schema is likely to be a duplicate.
" - } + { + "target": "com.amazonaws.databasemigrationservice#S3AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#S3ResourceNotFoundFault" } - }, + ], "traits": { - "smithy.api#documentation": "Describes a schema in a Fleet Advisor collector inventory.
" + "smithy.api#documentation": "Applies converted database objects to your target database.
" } }, - "com.amazonaws.databasemigrationservice#SchemaShortInfoResponse": { + "com.amazonaws.databasemigrationservice#StartMetadataModelExportToTargetMessage": { "type": "structure", "members": { - "SchemaId": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "The ID of a schema in a Fleet Advisor collector inventory.
" - } - }, - "SchemaName": { + "MigrationProjectIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The name of a schema in a Fleet Advisor collector inventory.
" + "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", + "smithy.api#required": {} } }, - "DatabaseId": { + "SelectionRules": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The ID of a database in a Fleet Advisor collector inventory.
" + "smithy.api#documentation": "A value that specifies the database objects to export.
", + "smithy.api#required": {} } }, - "DatabaseName": { - "target": "com.amazonaws.databasemigrationservice#String", + "OverwriteExtensionPack": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "The name of a database in a Fleet Advisor collector inventory.
" + "smithy.api#documentation": "Whether to overwrite the migration project extension pack. An extension pack is an add-on module \n that emulates functions present in a source database that are required when converting objects \n to the target database.
" } - }, - "DatabaseIpAddress": { + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#StartMetadataModelExportToTargetResponse": { + "type": "structure", + "members": { + "RequestIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The IP address of a database in a Fleet Advisor collector inventory.
" + "smithy.api#documentation": "The identifier for the export operation.
" } } }, "traits": { - "smithy.api#documentation": "Describes a schema in a Fleet Advisor collector inventory.
" + "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#SecretString": { - "type": "string", + "com.amazonaws.databasemigrationservice#StartMetadataModelImport": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#StartMetadataModelImportMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#StartMetadataModelImportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#S3AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#S3ResourceNotFoundFault" + } + ], "traits": { - "smithy.api#sensitive": {} + "smithy.api#documentation": "Loads the metadata for all the dependent database objects of the parent object.
\nThis operation uses your project's Amazon S3 bucket as a metadata cache to improve performance.
" } }, - "com.amazonaws.databasemigrationservice#ServerShortInfoResponse": { + "com.amazonaws.databasemigrationservice#StartMetadataModelImportMessage": { "type": "structure", "members": { - "ServerId": { + "MigrationProjectIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The ID of a server in a Fleet Advisor collector inventory.
" + "smithy.api#documentation": "The migration project name or Amazon Resource Name (ARN).
", + "smithy.api#required": {} } }, - "IpAddress": { + "SelectionRules": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "The IP address of a server in a Fleet Advisor collector inventory.
" + "smithy.api#documentation": "A value that specifies the database objects to import.
", + "smithy.api#required": {} } }, - "ServerName": { - "target": "com.amazonaws.databasemigrationservice#String", + "Origin": { + "target": "com.amazonaws.databasemigrationservice#OriginTypeValue", "traits": { - "smithy.api#documentation": "The name address of a server in a Fleet Advisor collector inventory.
" + "smithy.api#documentation": "Whether to load metadata to the source or target database.
", + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "Describes a server in a Fleet Advisor collector inventory.
" - } - }, - "com.amazonaws.databasemigrationservice#SourceIdsList": { - "type": "list", - "member": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#xmlName": "SourceId" - } - } - }, - "com.amazonaws.databasemigrationservice#SourceType": { - "type": "enum", - "members": { - "replication_instance": { - "target": "smithy.api#Unit", + }, + "Refresh": { + "target": "com.amazonaws.databasemigrationservice#Boolean", "traits": { - "smithy.api#enumValue": "replication-instance" + "smithy.api#default": false, + "smithy.api#documentation": "If true, DMS loads metadata for the specified objects from the source database.
The identifier for the import operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.databasemigrationservice#StartRecommendations": { @@ -13105,7 +16663,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#StartReplicationResponse": { @@ -13143,7 +16702,32 @@ } ], "traits": { - "smithy.api#documentation": "Starts the replication task.
\nFor more information about DMS tasks, see Working with Migration Tasks in the\n Database Migration Service User Guide.\n
" + "smithy.api#documentation": "Starts the replication task.
\nFor more information about DMS tasks, see Working with Migration Tasks in the\n Database Migration Service User Guide.\n
", + "smithy.api#examples": [ + { + "title": "Start replication task", + "documentation": "Starts the replication task.", + "input": { + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "StartReplicationTaskType": "start-replication", + "CdcStartTime": "2016-12-14T13:33:20Z" + }, + "output": { + "ReplicationTask": { + "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "ReplicationTaskIdentifier": "task1", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "TableMappings": "file://mappingfile.json", + "Status": "creating", + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM", + "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z", + "MigrationType": "full-load", + "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E", + "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}" + } + } + } + ] } }, "com.amazonaws.databasemigrationservice#StartReplicationTaskAssessment": { @@ -13178,7 +16762,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#StartReplicationTaskAssessmentResponse": { @@ -13309,7 +16894,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#StartReplicationTaskAssessmentRunResponse": { @@ -13364,7 +16950,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#StartReplicationTaskResponse": { @@ -13440,7 +17027,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#StopReplicationResponse": { @@ -13474,7 +17062,30 @@ } ], "traits": { - "smithy.api#documentation": "Stops the replication task.
" + "smithy.api#documentation": "Stops the replication task.
", + "smithy.api#examples": [ + { + "title": "Stop replication task", + "documentation": "Stops the replication task.", + "input": { + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E" + }, + "output": { + "ReplicationTask": { + "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "ReplicationTaskIdentifier": "task1", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "TableMappings": "file://mappingfile.json", + "Status": "creating", + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM", + "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z", + "MigrationType": "full-load", + "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E", + "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}" + } + } + } + ] } }, "com.amazonaws.databasemigrationservice#StopReplicationTaskMessage": { @@ -13489,7 +17100,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#StopReplicationTaskResponse": { @@ -13959,7 +17571,20 @@ } ], "traits": { - "smithy.api#documentation": "Tests the connection between the replication instance and the endpoint.
" + "smithy.api#documentation": "Tests the connection between the replication instance and the endpoint.
", + "smithy.api#examples": [ + { + "title": "Test conection", + "documentation": "Tests the connection between the replication instance and the endpoint.", + "input": { + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM" + }, + "output": { + "Connection": {} + } + } + ] } }, "com.amazonaws.databasemigrationservice#TestConnectionMessage": { @@ -13981,7 +17606,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#TestConnectionResponse": { @@ -14100,7 +17726,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#UpdateSubscriptionsToEventBridgeResponse": { diff --git a/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json b/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json index f55a5c90c9c..d054e08b252 100644 --- a/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json +++ b/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json @@ -389,6 +389,12 @@ "traits": { "smithy.api#documentation": "The amount of space that's being used in a storage system resource without accounting for\n compression or deduplication.
" } + }, + "ClusterCloudStorageUsed": { + "target": "com.amazonaws.datasync#NonNegativeLong", + "traits": { + "smithy.api#documentation": "The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering).
" + } } }, "traits": { @@ -1111,7 +1117,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an endpoint for an Network File System (NFS) file server that DataSync can use for a\n data transfer.
" + "smithy.api#documentation": "Creates an endpoint for a Network File System (NFS) file server that DataSync can use for a data transfer.
\nFor more information, see Configuring transfers to or from an NFS file\n server.
\nIf you're copying data to or from an Snowcone device, you can also use\n CreateLocationNfs to create your transfer location. For more information, see\n Configuring transfers with Snowcone.
Specifies the subdirectory in the NFS file server that DataSync transfers to\n or from. The NFS path should be a path that's exported by the NFS server, or a\n subdirectory of that path. The path should be such that it can be mounted by other NFS clients\n in your network.
\nTo see all the paths exported by your NFS server, run \"showmount -e\n nfs-server-name\" from an NFS client that has access to your server. You can specify\n any directory that appears in the results, and any subdirectory of that directory. Ensure that\n the NFS export is accessible without Kerberos authentication.
To transfer all the data in the folder you specified, DataSync needs to have\n permissions to read all the data. To ensure this, either configure the NFS export with\n no_root_squash, or ensure that the permissions for all of the files that you\n want DataSync allow read access for all users. Doing either enables the agent to\n read the files. For the agent to access directories, you must additionally enable all execute\n access.
If you are copying data to or from your Snowcone device, see NFS Server on\n Snowcone for more information.
", + "smithy.api#documentation": "Specifies the export path in your NFS file server that you want DataSync to\n mount.
\nThis path (or a subdirectory of the path) is where DataSync transfers data to\n or from. For information on configuring an export for DataSync, see Accessing NFS file servers.
", "smithy.api#required": {} } }, "ServerHostname": { "target": "com.amazonaws.datasync#ServerHostname", "traits": { - "smithy.api#documentation": "Specifies the IP address or domain name of your NFS file server. An agent that is\n installed on-premises uses this hostname to mount the NFS server in a network.
\nIf you are copying data to or from your Snowcone device, see NFS Server on\n Snowcone for more information.
\nYou must specify be an IP version 4 address or Domain Name System (DNS)-compliant\n name.
\nSpecifies the Domain Name System (DNS) name or IP version 4 address of the NFS file\n server that your DataSync agent connects to.
", "smithy.api#required": {} } }, "OnPremConfig": { "target": "com.amazonaws.datasync#OnPremConfig", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Names (ARNs) of agents that DataSync uses to\n connect to your NFS file server.
\nIf you are copying data to or from your Snowcone device, see NFS Server on\n Snowcone for more information.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the DataSync agent that want to\n connect to your NFS file server.
\nYou can specify more than one agent. For more information, see Using multiple\n agents for transfers.
", "smithy.api#required": {} } }, "MountOptions": { "target": "com.amazonaws.datasync#NfsMountOptions", "traits": { - "smithy.api#documentation": "Specifies the mount options that DataSync can use to mount your NFS\n share.
" + "smithy.api#documentation": "Specifies the options that DataSync can use to mount your NFS file\n server.
" } }, "Tags": { @@ -2478,7 +2484,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns metadata, such as the path information, about an NFS location.
" + "smithy.api#documentation": "Provides details about how an DataSync transfer location for a Network\n File System (NFS) file server is configured.
" } }, "com.amazonaws.datasync#DescribeLocationNfsRequest": { @@ -2487,7 +2493,7 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the NFS location to describe.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the NFS location that you want information\n about.
", "smithy.api#required": {} } } @@ -2503,13 +2509,13 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the NFS location that was described.
" + "smithy.api#documentation": "The ARN of the NFS location.
" } }, "LocationUri": { "target": "com.amazonaws.datasync#LocationUri", "traits": { - "smithy.api#documentation": "The URL of the source NFS location that was described.
" + "smithy.api#documentation": "The URL of the NFS location.
" } }, "OnPremConfig": { @@ -2518,13 +2524,13 @@ "MountOptions": { "target": "com.amazonaws.datasync#NfsMountOptions", "traits": { - "smithy.api#documentation": "The mount options that DataSync uses to mount your NFS share.
" + "smithy.api#documentation": "The mount options that DataSync uses to mount your NFS file server.
" } }, "CreationTime": { "target": "com.amazonaws.datasync#Time", "traits": { - "smithy.api#documentation": "The time that the NFS location was created.
" + "smithy.api#documentation": "The time when the NFS location was created.
" } } }, @@ -4067,52 +4073,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -4120,13 +4130,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -4136,224 +4155,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://datasync-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://datasync-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://datasync-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://datasync-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://datasync.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://datasync.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://datasync.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://datasync.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -6370,6 +6340,12 @@ "traits": { "smithy.api#documentation": "The number of LUNs (logical unit numbers) in the cluster.
" } + }, + "ClusterCloudStorageUsed": { + "target": "com.amazonaws.datasync#NonNegativeLong", + "traits": { + "smithy.api#documentation": "The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering).
" + } } }, "traits": { @@ -6763,13 +6739,13 @@ "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "ARNs of the agents to use for an NFS location.
", + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the agents connecting to a transfer\n location.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS)\n location.
" + "smithy.api#documentation": "The DataSync agents that are connecting to a Network File System (NFS)\n location.
" } }, "com.amazonaws.datasync#Operator": { @@ -8749,7 +8725,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates some of the parameters of a previously created location for Network File System\n (NFS) access. For information about creating an NFS location, see Creating a location for\n NFS.
" + "smithy.api#documentation": "Modifies some configurations of the Network File System (NFS) transfer location that\n you're using with DataSync.
\nFor more information, see Configuring transfers to or from an\n NFS file server.
" } }, "com.amazonaws.datasync#UpdateLocationNfsRequest": { @@ -8758,14 +8734,14 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the NFS location that you want to\n update.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the NFS transfer location that you want to\n update.
", "smithy.api#required": {} } }, "Subdirectory": { "target": "com.amazonaws.datasync#NfsSubdirectory", "traits": { - "smithy.api#documentation": "Specifies the subdirectory in your NFS file system that DataSync uses to read\n from or write to during a transfer. The NFS path should be exported by the NFS server, or a\n subdirectory of that path. The path should be such that it can be mounted by other NFS clients\n in your network.
\nTo see all the paths exported by your NFS server, run \"showmount -e\n nfs-server-name\" from an NFS client that has access to your server. You can specify\n any directory that appears in the results, and any subdirectory of that directory. Ensure that\n the NFS export is accessible without Kerberos authentication.
To transfer all the data in the folder that you specified, DataSync must have\n permissions to read all the data. To ensure this, either configure the NFS export with\n no_root_squash, or ensure that the files you want DataSync to access\n have permissions that allow read access for all users. Doing either option enables the agent\n to read the files. For the agent to access directories, you must additionally enable all\n execute access.
If you are copying data to or from your Snowcone device, see NFS Server on\n Snowcone for more information.
" + "smithy.api#documentation": "Specifies the export path in your NFS file server that you want DataSync to\n mount.
\nThis path (or a subdirectory of the path) is where DataSync transfers data to\n or from. For information on configuring an export for DataSync, see Accessing NFS file servers.
" } }, "OnPremConfig": { diff --git a/codegen/sdk-codegen/aws-models/detective.2018-10-26.json b/codegen/sdk-codegen/aws-models/detective.2018-10-26.json index 1867234c9c5..9ec12357bb0 100644 --- a/codegen/sdk-codegen/aws-models/detective.2018-10-26.json +++ b/codegen/sdk-codegen/aws-models/detective.2018-10-26.json @@ -366,52 +366,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -419,13 +423,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -435,224 +448,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://api.detective-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://api.detective-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://api.detective-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://api.detective-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://api.detective.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://api.detective.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://api.detective.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://api.detective.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -1988,7 +1952,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "^.+@(?:(?:(?!-)[A-Za-z0-9-]{1,62})?[A-Za-z0-9]{1}\\.)+[A-Za-z]{2,6}$" + "smithy.api#pattern": "^.+@(?:(?:(?!-)[A-Za-z0-9-]{1,62})?[A-Za-z0-9]{1}\\.)+[A-Za-z]{2,63}$" } }, "com.amazonaws.detective#EmailMessage": { diff --git a/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json b/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json index 7806a61faac..43911fdd00d 100644 --- a/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json +++ b/codegen/sdk-codegen/aws-models/ec2.2016-11-15.json @@ -1535,7 +1535,20 @@ "target": "com.amazonaws.ec2#AllocateAddressResult" }, "traits": { - "smithy.api#documentation": "Allocates an Elastic IP address to your Amazon Web Services 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 Amazon Web Services account.
\nYou 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.
\nIf you release an Elastic IP address, you might be able to recover it. You cannot recover\n an Elastic IP address that you released after it is allocated to another Amazon Web Services account. To attempt to recover an Elastic IP address that you released, specify\n it in this operation.
\nFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\nYou can allocate a carrier IP address which is a public IP address from a telecommunication carrier, \n 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 Amazon Web Services 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 Amazon Web Services account.
\nYou 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.
\nIf you release an Elastic IP address, you might be able to recover it. You cannot recover\n an Elastic IP address that you released after it is allocated to another Amazon Web Services account. To attempt to recover an Elastic IP address that you released, specify\n it in this operation.
\nFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\nYou can allocate a carrier IP address which is a public IP address from a telecommunication carrier, \n to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
", + "smithy.api#examples": [ + { + "title": "To allocate an Elastic IP address", + "documentation": "This example allocates an Elastic IP address.", + "output": { + "PublicIp": "203.0.113.0", + "AllocationId": "eipalloc-64d5890a", + "PublicIpv4Pool": "amazon", + "NetworkBorderGroup": "us-east-1", + "Domain": "vpc" + } + } + ] } }, "com.amazonaws.ec2#AllocateAddressRequest": { @@ -3982,52 +3995,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -4035,13 +4052,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -4051,92 +4077,83 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://ec2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://ec2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] } ], @@ -4145,155 +4162,115 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, + "aws-us-gov", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] } ] } ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws-us-gov", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://ec2.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://ec2-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] + "endpoint": { + "url": "https://ec2.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://ec2-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://ec2.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://ec2.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://ec2.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://ec2.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -5985,7 +5962,20 @@ "target": "com.amazonaws.ec2#AssociateAddressResult" }, "traits": { - "smithy.api#documentation": "Associates an Elastic IP address, or carrier IP address (for instances that are in\n subnets in Wavelength Zones) with an instance or a network interface. Before you can use an\n Elastic IP address, you must allocate it to your account.
\nIf the Elastic IP address is already\n associated with a different instance, it is disassociated from that instance and associated\n with the specified instance. If you associate an Elastic IP address with an instance that has\n an existing Elastic IP address, the existing address is disassociated from the instance, but\n remains allocated to your account.
\n[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication\n carrier to the instance or network interface.
\nYou cannot associate an Elastic IP address with an interface in a different network border group.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon EC2\n doesn't return an error, and you may be charged for each time the Elastic IP address is\n remapped to the same instance. For more information, see the Elastic IP\n Addresses section of Amazon EC2\n Pricing.
\nAssociates an Elastic IP address, or carrier IP address (for instances that are in\n subnets in Wavelength Zones) with an instance or a network interface. Before you can use an\n Elastic IP address, you must allocate it to your account.
\nIf the Elastic IP address is already\n associated with a different instance, it is disassociated from that instance and associated\n with the specified instance. If you associate an Elastic IP address with an instance that has\n an existing Elastic IP address, the existing address is disassociated from the instance, but\n remains allocated to your account.
\n[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication\n carrier to the instance or network interface.
\nYou cannot associate an Elastic IP address with an interface in a different network border group.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon EC2\n doesn't return an error, and you may be charged for each time the Elastic IP address is\n remapped to the same instance. For more information, see the Elastic IP\n Addresses section of Amazon EC2\n Pricing.
\nAssociates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.
\nAfter you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
\nFor more information, see DHCP options sets\n in the Amazon VPC User Guide.
" + "smithy.api#documentation": "Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.
\nAfter you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
\nFor more information, see DHCP options sets\n in the Amazon VPC User Guide.
", + "smithy.api#examples": [ + { + "title": "To associate a DHCP options set with a VPC", + "documentation": "This example associates the specified DHCP options set with the specified VPC.", + "input": { + "DhcpOptionsId": "dopt-d9070ebb", + "VpcId": "vpc-a01106c2" + } + } + ] } }, "com.amazonaws.ec2#AssociateDhcpOptionsRequest": { @@ -6272,7 +6272,30 @@ "target": "com.amazonaws.ec2#AssociateIamInstanceProfileResult" }, "traits": { - "smithy.api#documentation": "Associates an IAM instance profile with a running or stopped instance. You cannot\n associate more than one IAM instance profile with an instance.
" + "smithy.api#documentation": "Associates an IAM instance profile with a running or stopped instance. You cannot\n associate more than one IAM instance profile with an instance.
", + "smithy.api#examples": [ + { + "title": "To associate an IAM instance profile with an instance", + "documentation": "This example associates an IAM instance profile named admin-role with the specified instance.", + "input": { + "IamInstanceProfile": { + "Name": "admin-role" + }, + "InstanceId": "i-123456789abcde123" + }, + "output": { + "IamInstanceProfileAssociation": { + "InstanceId": "i-123456789abcde123", + "State": "associating", + "AssociationId": "iip-assoc-0e7736511a163c209", + "IamInstanceProfile": { + "Id": "AIPAJBLK7RKJKWDXVHIEC", + "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role" + } + } + } + } + ] } }, "com.amazonaws.ec2#AssociateIamInstanceProfileRequest": { @@ -7592,7 +7615,25 @@ "target": "com.amazonaws.ec2#VolumeAttachment" }, "traits": { - "smithy.api#documentation": "Attaches an EBS volume to a running or stopped instance and exposes it to the instance\n with the specified device name.
\nEncrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For\n more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
\nAfter you attach an EBS volume, you must make it available. For more information, see \n Make an EBS volume available for use.
\nIf a volume has an Amazon Web Services Marketplace product code:
\nThe volume can be attached only to a stopped instance.
\nAmazon Web Services Marketplace product codes are copied from the volume to the instance.
\nYou must be subscribed to the product.
\nThe instance type and operating system of the instance must support the product. For\n example, you can't detach a volume from a Windows instance and attach it to a Linux\n instance.
\nFor more information, see Attach an Amazon EBS volume to an instance in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Attaches an EBS volume to a running or stopped instance and exposes it to the instance\n with the specified device name.
\nEncrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For\n more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
\nAfter you attach an EBS volume, you must make it available. For more information, see \n Make an EBS volume available for use.
\nIf a volume has an Amazon Web Services Marketplace product code:
\nThe volume can be attached only to a stopped instance.
\nAmazon Web Services Marketplace product codes are copied from the volume to the instance.
\nYou must be subscribed to the product.
\nThe instance type and operating system of the instance must support the product. For\n example, you can't detach a volume from a Windows instance and attach it to a Linux\n instance.
\nFor more information, see Attach an Amazon EBS volume to an instance in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To attach a volume to an instance", + "documentation": "This example attaches a volume (``vol-1234567890abcdef0``) to an instance (``i-01474ef662b89480``) as ``/dev/sdf``.", + "input": { + "VolumeId": "vol-1234567890abcdef0", + "InstanceId": "i-01474ef662b89480", + "Device": "/dev/sdf" + }, + "output": { + "AttachTime": "2016-08-29T18:52:32.724Z", + "InstanceId": "i-01474ef662b89480", + "VolumeId": "vol-1234567890abcdef0", + "State": "attaching", + "Device": "/dev/sdf" + } + } + ] } }, "com.amazonaws.ec2#AttachVolumeRequest": { @@ -8104,7 +8145,30 @@ "target": "com.amazonaws.ec2#AuthorizeSecurityGroupIngressResult" }, "traits": { - "smithy.api#documentation": "Adds the specified inbound (ingress) rules to a security group.
\nAn inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR\n address range, or from the instances that are associated with the specified destination security \n groups. When specifying an inbound rule for your security group in a VPC, the\n IpPermissions must include a source for the traffic.
You specify a protocol for each rule (for example, TCP). \n For TCP and UDP, you must also specify the destination port or port range. \n For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. \n You can use -1 to mean all types or all codes.
\nRule changes are propagated to instances within the security group as quickly as possible. \n However, a small delay might occur.
\nFor more information about VPC security group quotas, see Amazon VPC quotas.
" + "smithy.api#documentation": "Adds the specified inbound (ingress) rules to a security group.
\nAn inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR\n address range, or from the instances that are associated with the specified destination security \n groups. When specifying an inbound rule for your security group in a VPC, the\n IpPermissions must include a source for the traffic.
You specify a protocol for each rule (for example, TCP). \n For TCP and UDP, you must also specify the destination port or port range. \n For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. \n You can use -1 to mean all types or all codes.
\nRule changes are propagated to instances within the security group as quickly as possible. \n However, a small delay might occur.
\nFor more information about VPC security group quotas, see Amazon VPC quotas.
", + "smithy.api#examples": [ + { + "title": "To add a rule that allows inbound SSH traffic from an IPv4 address range", + "documentation": "This example enables inbound traffic on TCP port 22 (SSH). The rule includes a description to help you identify it later.", + "input": { + "GroupId": "sg-903004f8", + "IpPermissions": [ + { + "IpProtocol": "tcp", + "FromPort": 22, + "ToPort": 22, + "IpRanges": [ + { + "CidrIp": "203.0.113.0/24", + "Description": "SSH access from the LA office" + } + ] + } + ] + }, + "output": {} + } + ] } }, "com.amazonaws.ec2#AuthorizeSecurityGroupIngressRequest": { @@ -12288,7 +12352,20 @@ "target": "com.amazonaws.ec2#ConfirmProductInstanceResult" }, "traits": { - "smithy.api#documentation": "Determines whether a product code is associated with an instance. This action can only\n be used by the owner of the product code. It is useful when a product code owner must\n verify whether another user's instance is eligible for support.
" + "smithy.api#documentation": "Determines whether a product code is associated with an instance. This action can only\n be used by the owner of the product code. It is useful when a product code owner must\n verify whether another user's instance is eligible for support.
", + "smithy.api#examples": [ + { + "title": "To confirm the product instance", + "documentation": "This example determines whether the specified product code is associated with the specified instance.", + "input": { + "ProductCode": "774F4FF8", + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + "OwnerId": "123456789012" + } + } + ] } }, "com.amazonaws.ec2#ConfirmProductInstanceRequest": { @@ -12740,7 +12817,22 @@ "target": "com.amazonaws.ec2#CopyImageResult" }, "traits": { - "smithy.api#documentation": "Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a\n Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost\n to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
\nTo copy an AMI from one Region to another, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tdestination Region using its endpoint. Copies of encrypted backing snapshots for\n \t\tthe AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, \n \t\tunless you set Encrypted during the copy operation. You cannot \n \t\tcreate an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tARN of the destination Outpost using DestinationOutpostArn. \n \t\tBacking snapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.
\nFor more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the\n Amazon EC2 User Guide.
" + "smithy.api#documentation": "Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a\n Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost\n to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
\nTo copy an AMI from one Region to another, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tdestination Region using its endpoint. Copies of encrypted backing snapshots for\n \t\tthe AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, \n \t\tunless you set Encrypted during the copy operation. You cannot \n \t\tcreate an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tARN of the destination Outpost using DestinationOutpostArn. \n \t\tBacking snapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.
\nFor more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the\n Amazon EC2 User Guide.
", + "smithy.api#examples": [ + { + "title": "To copy an AMI to another region", + "documentation": "This example copies the specified AMI from the us-east-1 region to the current region.", + "input": { + "Description": "", + "Name": "My server", + "SourceImageId": "ami-5731123e", + "SourceRegion": "us-east-1" + }, + "output": { + "ImageId": "ami-438bea42" + } + } + ] } }, "com.amazonaws.ec2#CopyImageRequest": { @@ -12856,7 +12948,22 @@ "target": "com.amazonaws.ec2#CopySnapshotResult" }, "traits": { - "smithy.api#documentation": "Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a\n snapshot within the same Region, from one Region to another, or from a Region to an Outpost. \n You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within \n the same Outpost.
\nYou can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
\nWhen copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. \n \tCopies of unencrypted snapshots remain unencrypted, unless you enable encryption for the \n \tsnapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) \n \tKMS key; however, you can specify a different KMS key. To copy an encrypted \n \tsnapshot that has been shared from another account, you must have permissions for the KMS key \n \tused to encrypt the snapshot.
\nSnapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
\nSnapshots created by copying another snapshot have an arbitrary volume ID that should not\n be used for any purpose.
\nFor more information, see Copy an Amazon EBS snapshot in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a\n snapshot within the same Region, from one Region to another, or from a Region to an Outpost. \n You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within \n the same Outpost.
\nYou can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
\nWhen copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. \n \tCopies of unencrypted snapshots remain unencrypted, unless you enable encryption for the \n \tsnapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) \n \tKMS key; however, you can specify a different KMS key. To copy an encrypted \n \tsnapshot that has been shared from another account, you must have permissions for the KMS key \n \tused to encrypt the snapshot.
\nSnapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
\nSnapshots created by copying another snapshot have an arbitrary volume ID that should not\n be used for any purpose.
\nFor more information, see Copy an Amazon EBS snapshot in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To copy a snapshot", + "documentation": "This example copies a snapshot with the snapshot ID of ``snap-066877671789bd71b`` from the ``us-west-2`` region to the ``us-east-1`` region and adds a short description to identify the snapshot.", + "input": { + "SourceRegion": "us-west-2", + "SourceSnapshotId": "snap-066877671789bd71b", + "Description": "This is my copied snapshot.", + "DestinationRegion": "us-east-1" + }, + "output": { + "SnapshotId": "snap-066877671789bd71b" + } + } + ] } }, "com.amazonaws.ec2#CopySnapshotRequest": { @@ -13884,7 +13991,27 @@ "target": "com.amazonaws.ec2#CreateCustomerGatewayResult" }, "traits": { - "smithy.api#documentation": "Provides information to Amazon Web Services about your customer gateway device. The\n customer gateway device is the appliance at your end of the VPN connection. You\n must provide the IP address of the customer gateway device’s external\n interface. The IP address must be static and can be behind a device performing network\n address translation (NAT).
\nFor devices that use Border Gateway Protocol (BGP), you can also provide the device's\n BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network.\n If you don't have an ASN already, you can use a private ASN. For more information, see \n Customer gateway \n options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
\nTo create more than one customer gateway with the same VPN type, IP address, and\n BGP ASN, specify a unique device name for each customer gateway. An identical request\n returns information about the existing customer gateway; it doesn't create a new customer\n gateway.
" + "smithy.api#documentation": "Provides information to Amazon Web Services about your customer gateway device. The\n customer gateway device is the appliance at your end of the VPN connection. You\n must provide the IP address of the customer gateway device’s external\n interface. The IP address must be static and can be behind a device performing network\n address translation (NAT).
\nFor devices that use Border Gateway Protocol (BGP), you can also provide the device's\n BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network.\n If you don't have an ASN already, you can use a private ASN. For more information, see \n Customer gateway \n options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
\nTo create more than one customer gateway with the same VPN type, IP address, and\n BGP ASN, specify a unique device name for each customer gateway. An identical request\n returns information about the existing customer gateway; it doesn't create a new customer\n gateway.
", + "smithy.api#examples": [ + { + "title": "To create a customer gateway", + "documentation": "This example creates a customer gateway with the specified IP address for its outside interface.", + "input": { + "Type": "ipsec.1", + "PublicIp": "12.1.2.3", + "BgpAsn": 65534 + }, + "output": { + "CustomerGateway": { + "CustomerGatewayId": "cgw-0e11f167", + "IpAddress": "12.1.2.3", + "State": "available", + "Type": "ipsec.1", + "BgpAsn": "65534" + } + } + } + ] } }, "com.amazonaws.ec2#CreateCustomerGatewayRequest": { @@ -14083,7 +14210,42 @@ "target": "com.amazonaws.ec2#CreateDhcpOptionsResult" }, "traits": { - "smithy.api#documentation": "Creates a set of DHCP options for your VPC. After creating the set, you must\n\t\t\t\tassociate it with the VPC, causing all existing and new instances that you launch in\n\t\t\t\tthe VPC to use this set of DHCP options. The following are the individual DHCP\n\t\t\t\toptions you can specify. For more information about the options, see RFC 2132.
\n\n domain-name-servers - The IP addresses of up to four domain name\n servers, or AmazonProvidedDNS. The default DHCP option set specifies\n AmazonProvidedDNS. If specifying more than one domain name server, specify the\n IP addresses in a single parameter, separated by commas. To have your instance\n receive a custom DNS hostname as specified in domain-name, you must\n set domain-name-servers to a custom DNS server.
\n domain-name - If you're using AmazonProvidedDNS in\n us-east-1, specify ec2.internal. If you're using\n AmazonProvidedDNS in another Region, specify\n region.compute.internal (for example,\n ap-northeast-1.compute.internal). Otherwise, specify a domain\n name (for example, ExampleCompany.com). This value is used to complete\n unqualified DNS hostnames. Important: Some\n Linux operating systems accept multiple domain names separated by spaces.\n However, Windows and other Linux operating systems treat the value as a single\n domain, which results in unexpected behavior. If your DHCP options set is\n associated with a VPC that has instances with multiple operating systems,\n specify only one domain name.
\n ntp-servers - The IP addresses of up to four Network Time Protocol (NTP)\n servers.
\n netbios-name-servers - The IP addresses of up to four NetBIOS name\n servers.
\n netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that\n you specify 2 (broadcast and multicast are not currently supported). For more information\n about these node types, see RFC 2132.
Your VPC automatically starts out with a set of DHCP options that includes only a DNS\n\t\t\tserver that we provide (AmazonProvidedDNS). If you create a set of options, and if your\n\t\t\tVPC has an internet gateway, make sure to set the domain-name-servers\n\t\t\toption either to AmazonProvidedDNS or to a domain name server of your\n\t\t\tchoice. For more information, see DHCP options sets in the\n\t\t\tAmazon VPC User Guide.
Creates a set of DHCP options for your VPC. After creating the set, you must\n\t\t\t\tassociate it with the VPC, causing all existing and new instances that you launch in\n\t\t\t\tthe VPC to use this set of DHCP options. The following are the individual DHCP\n\t\t\t\toptions you can specify. For more information about the options, see RFC 2132.
\n\n domain-name-servers - The IP addresses of up to four domain name\n servers, or AmazonProvidedDNS. The default DHCP option set specifies\n AmazonProvidedDNS. If specifying more than one domain name server, specify the\n IP addresses in a single parameter, separated by commas. To have your instance\n receive a custom DNS hostname as specified in domain-name, you must\n set domain-name-servers to a custom DNS server.
\n domain-name - If you're using AmazonProvidedDNS in\n us-east-1, specify ec2.internal. If you're using\n AmazonProvidedDNS in another Region, specify\n region.compute.internal (for example,\n ap-northeast-1.compute.internal). Otherwise, specify a domain\n name (for example, ExampleCompany.com). This value is used to complete\n unqualified DNS hostnames. Important: Some\n Linux operating systems accept multiple domain names separated by spaces.\n However, Windows and other Linux operating systems treat the value as a single\n domain, which results in unexpected behavior. If your DHCP options set is\n associated with a VPC that has instances with multiple operating systems,\n specify only one domain name.
\n ntp-servers - The IP addresses of up to four Network Time Protocol (NTP)\n servers.
\n netbios-name-servers - The IP addresses of up to four NetBIOS name\n servers.
\n netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that\n you specify 2 (broadcast and multicast are not currently supported). For more information\n about these node types, see RFC 2132.
Your VPC automatically starts out with a set of DHCP options that includes only a DNS\n\t\t\tserver that we provide (AmazonProvidedDNS). If you create a set of options, and if your\n\t\t\tVPC has an internet gateway, make sure to set the domain-name-servers\n\t\t\toption either to AmazonProvidedDNS or to a domain name server of your\n\t\t\tchoice. For more information, see DHCP options sets in the\n\t\t\tAmazon VPC User Guide.
The fields to include in the flow log record. List the fields in the order in which\n they should appear. If you omit this parameter, the flow log is created using the\n default format. If you specify this parameter, you must include at least one\n field. For more information about the available fields, see Flow log\n records in the Amazon VPC User Guide or Transit Gateway Flow Log\n records in the Amazon Web Services Transit Gateway Guide.
\nSpecify the fields using the ${field-id} format, separated by spaces. For\n the CLI, surround this parameter value with single quotes on Linux or\n double quotes on Windows.
The fields to include in the flow log record. List the fields in the order in which\n they should appear. If you omit this parameter, the flow log is created using the\n default format. If you specify this parameter, you must include at least one\n field. For more information about the available fields, see Flow log\n records in the Amazon VPC User Guide or Transit Gateway Flow Log\n records in the Amazon Web Services Transit Gateway Guide.
\nSpecify the fields using the ${field-id} format, separated by spaces.
Creates an internet gateway for use with a VPC. After creating the internet gateway,\n\t\t\tyou attach it to a VPC using AttachInternetGateway.
\nFor more information, see Internet gateways in the \n Amazon VPC User Guide.
" + "smithy.api#documentation": "Creates an internet gateway for use with a VPC. After creating the internet gateway,\n\t\t\tyou attach it to a VPC using AttachInternetGateway.
\nFor more information, see Internet gateways in the \n Amazon VPC User Guide.
", + "smithy.api#examples": [ + { + "title": "To create an Internet gateway", + "documentation": "This example creates an Internet gateway.", + "output": { + "InternetGateway": { + "Tags": [], + "InternetGatewayId": "igw-c0a643a9", + "Attachments": [] + } + } + } + ] } }, "com.amazonaws.ec2#CreateInternetGatewayRequest": { @@ -15466,7 +15641,16 @@ "target": "com.amazonaws.ec2#KeyPair" }, "traits": { - "smithy.api#documentation": "Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the\n specified PEM or PPK format. Amazon EC2 stores the public key and displays the private\n key for you to save to a file. The private key is returned as an unencrypted PEM encoded\n PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a\n key with the specified name already exists, Amazon EC2 returns an error.
\nThe key pair returned to you is available only in the Amazon Web Services Region in which you create it.\n If you prefer, you can create your own key pair using a third-party tool and upload it\n to any Region using ImportKeyPair.
\nYou can have up to 5,000 key pairs per Amazon Web Services Region.
\nFor more information, see Amazon EC2 key pairs in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the\n specified PEM or PPK format. Amazon EC2 stores the public key and displays the private\n key for you to save to a file. The private key is returned as an unencrypted PEM encoded\n PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a\n key with the specified name already exists, Amazon EC2 returns an error.
\nThe key pair returned to you is available only in the Amazon Web Services Region in which you create it.\n If you prefer, you can create your own key pair using a third-party tool and upload it\n to any Region using ImportKeyPair.
\nYou can have up to 5,000 key pairs per Amazon Web Services Region.
\nFor more information, see Amazon EC2 key pairs in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To create a key pair", + "documentation": "This example creates a key pair named my-key-pair.", + "input": { + "KeyName": "my-key-pair" + } + } + ] } }, "com.amazonaws.ec2#CreateKeyPairRequest": { @@ -15523,7 +15707,50 @@ "target": "com.amazonaws.ec2#CreateLaunchTemplateResult" }, "traits": { - "smithy.api#documentation": "Creates a launch template.
\nA launch template contains the parameters to launch an instance. When you launch an\n instance using RunInstances, you can specify a launch template instead\n of providing the launch parameters in the request. For more information, see Launch\n an instance from a launch template in the\n Amazon Elastic Compute Cloud User Guide.
\nIf you want to clone an existing launch template as the basis for creating a new\n launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support\n cloning a template. For more information, see Create a launch template from an existing launch template in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Creates a launch template.
\nA launch template contains the parameters to launch an instance. When you launch an\n instance using RunInstances, you can specify a launch template instead\n of providing the launch parameters in the request. For more information, see Launch\n an instance from a launch template in the\n Amazon Elastic Compute Cloud User Guide.
\nIf you want to clone an existing launch template as the basis for creating a new\n launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support\n cloning a template. For more information, see Create a launch template from an existing launch template in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To create a launch template", + "documentation": "This example creates a launch template that specifies the subnet in which to launch the instance, assigns a public IP address and an IPv6 address to the instance, and creates a tag for the instance.", + "input": { + "LaunchTemplateName": "my-template", + "VersionDescription": "WebVersion1", + "LaunchTemplateData": { + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeviceIndex": 0, + "Ipv6AddressCount": 1, + "SubnetId": "subnet-7b16de0c" + } + ], + "ImageId": "ami-8c1be5f6", + "InstanceType": "t2.small", + "TagSpecifications": [ + { + "ResourceType": "instance", + "Tags": [ + { + "Key": "Name", + "Value": "webserver" + } + ] + } + ] + } + }, + "output": { + "LaunchTemplate": { + "LatestVersionNumber": 1, + "LaunchTemplateId": "lt-01238c059e3466abc", + "LaunchTemplateName": "my-template", + "DefaultVersionNumber": 1, + "CreatedBy": "arn:aws:iam::123456789012:root", + "CreateTime": "2017-11-27T09:13:24.000Z" + } + } + } + ] } }, "com.amazonaws.ec2#CreateLaunchTemplateRequest": { @@ -15610,7 +15837,48 @@ "target": "com.amazonaws.ec2#CreateLaunchTemplateVersionResult" }, "traits": { - "smithy.api#documentation": "Creates a new version of a launch template. You can specify an existing version of\n launch template from which to base the new version.
\nLaunch template versions are numbered in the order in which they are created. You\n cannot specify, change, or replace the numbering of launch template versions.
\nLaunch templates are immutable; after you create a launch template, you can't modify\n it. Instead, you can create a new version of the launch template that includes any\n changes you require.
\nFor more information, see Modify a launch template (manage launch template versions) in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Creates a new version of a launch template. You can specify an existing version of\n launch template from which to base the new version.
\nLaunch template versions are numbered in the order in which they are created. You\n cannot specify, change, or replace the numbering of launch template versions.
\nLaunch templates are immutable; after you create a launch template, you can't modify\n it. Instead, you can create a new version of the launch template that includes any\n changes you require.
\nFor more information, see Modify a launch template (manage launch template versions) in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To create a launch template version", + "documentation": "This example creates a new launch template version based on version 1 of the specified launch template and specifies a different AMI ID.", + "input": { + "LaunchTemplateId": "lt-0abcd290751193123", + "SourceVersion": "1", + "VersionDescription": "WebVersion2", + "LaunchTemplateData": { + "ImageId": "ami-c998b6b2" + } + }, + "output": { + "LaunchTemplateVersion": { + "VersionDescription": "WebVersion2", + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "my-template", + "VersionNumber": 2, + "CreatedBy": "arn:aws:iam::123456789012:root", + "LaunchTemplateData": { + "ImageId": "ami-c998b6b2", + "InstanceType": "t2.micro", + "NetworkInterfaces": [ + { + "Ipv6Addresses": [ + { + "Ipv6Address": "2001:db8:1234:1a00::123" + } + ], + "DeviceIndex": 0, + "SubnetId": "subnet-7b16de0c", + "AssociatePublicIpAddress": true + } + ] + }, + "DefaultVersion": false, + "CreateTime": "2017-12-01T13:35:46.000Z" + } + } + } + ] } }, "com.amazonaws.ec2#CreateLaunchTemplateVersionRequest": { @@ -16073,7 +16341,31 @@ "target": "com.amazonaws.ec2#CreateNatGatewayResult" }, "traits": { - "smithy.api#documentation": "Creates a NAT gateway in the specified subnet. This action creates a network interface\n in the specified subnet with a private IP address from the IP address range of the\n subnet. You can create either a public NAT gateway or a private NAT gateway.
\nWith a public NAT gateway, internet-bound traffic from a private subnet can be routed\n to the NAT gateway, so that instances in a private subnet can connect to the internet.
\nWith a private NAT gateway, private communication is routed across VPCs and on-premises\n networks through a transit gateway or virtual private gateway. Common use cases include\n running large workloads behind a small pool of allowlisted IPv4 addresses, preserving\n private IPv4 addresses, and communicating between overlapping networks.
\nFor more information, see NAT gateways in the Amazon VPC User Guide.
" + "smithy.api#documentation": "Creates a NAT gateway in the specified subnet. This action creates a network interface\n in the specified subnet with a private IP address from the IP address range of the\n subnet. You can create either a public NAT gateway or a private NAT gateway.
\nWith a public NAT gateway, internet-bound traffic from a private subnet can be routed\n to the NAT gateway, so that instances in a private subnet can connect to the internet.
\nWith a private NAT gateway, private communication is routed across VPCs and on-premises\n networks through a transit gateway or virtual private gateway. Common use cases include\n running large workloads behind a small pool of allowlisted IPv4 addresses, preserving\n private IPv4 addresses, and communicating between overlapping networks.
\nFor more information, see NAT gateways in the Amazon VPC User Guide.
", + "smithy.api#examples": [ + { + "title": "To create a NAT gateway", + "documentation": "This example creates a NAT gateway in subnet subnet-1a2b3c4d and associates an Elastic IP address with the allocation ID eipalloc-37fc1a52 with the NAT gateway.", + "input": { + "SubnetId": "subnet-1a2b3c4d", + "AllocationId": "eipalloc-37fc1a52" + }, + "output": { + "NatGateway": { + "NatGatewayAddresses": [ + { + "AllocationId": "eipalloc-37fc1a52" + } + ], + "VpcId": "vpc-1122aabb", + "State": "pending", + "NatGatewayId": "nat-08d48af2a8e83edfd", + "SubnetId": "subnet-1a2b3c4d", + "CreateTime": "2015-12-17T12:45:26.732Z" + } + } + } + ] } }, "com.amazonaws.ec2#CreateNatGatewayRequest": { @@ -16767,6 +17059,14 @@ "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", "smithy.api#idempotencyToken": {} } + }, + "EnablePrimaryIpv6": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "If you’re creating a network interface in a dual-stack or IPv6-only subnet, you have\n the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA\n address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that\n this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services\n will automatically assign an IPv6 address associated with the ENI attached to your\n instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a\n primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary\n IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is\n terminated or the network interface is detached. If you have multiple IPv6 addresses\n associated with an ENI attached to your instance and you enable a primary IPv6 address,\n the first IPv6 GUA address associated with the ENI becomes the primary IPv6\n address.
" + } } }, "traits": { @@ -16806,7 +17106,18 @@ "target": "com.amazonaws.ec2#CreatePlacementGroupResult" }, "traits": { - "smithy.api#documentation": "Creates a placement group in which to launch instances. The strategy of the placement\n group determines how the instances are organized within the group.
\nA cluster placement group is a logical grouping of instances within a\n single Availability Zone that benefit from low network latency, high network throughput.\n A spread placement group places instances on distinct hardware. A\n partition placement group places groups of instances in different\n partitions, where instances in one partition do not share the same hardware with\n instances in another partition.
For more information, see Placement groups in the\n Amazon EC2 User Guide.
" + "smithy.api#documentation": "Creates a placement group in which to launch instances. The strategy of the placement\n group determines how the instances are organized within the group.
\nA cluster placement group is a logical grouping of instances within a\n single Availability Zone that benefit from low network latency, high network throughput.\n A spread placement group places instances on distinct hardware. A\n partition placement group places groups of instances in different\n partitions, where instances in one partition do not share the same hardware with\n instances in another partition.
For more information, see Placement groups in the\n Amazon EC2 User Guide.
", + "smithy.api#examples": [ + { + "title": "To create a placement group", + "documentation": "This example creates a placement group with the specified name.", + "input": { + "GroupName": "my-cluster", + "Strategy": "cluster" + }, + "output": {} + } + ] } }, "com.amazonaws.ec2#CreatePlacementGroupRequest": { @@ -17399,7 +17710,21 @@ "target": "com.amazonaws.ec2#CreateSecurityGroupResult" }, "traits": { - "smithy.api#documentation": "Creates a security group.
\nA security group acts as a virtual firewall for your instance to control inbound and outbound traffic.\n For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nWhen you create a security group, you specify a friendly name of your choice. \n You can't have two security groups for the same VPC with the same name.
\nYou have a default security group for use in your VPC. If you don't specify a security group \n when you launch an instance, the instance is launched into the appropriate default security group. \n A default security group includes a default rule that grants instances unrestricted network access \n to each other.
\nYou can add or remove rules from your security groups using \n\t\t\t\t\tAuthorizeSecurityGroupIngress,\n\t\t\t\t\tAuthorizeSecurityGroupEgress,\n\t\t\t\t\tRevokeSecurityGroupIngress, and\n\t\t\t\t\tRevokeSecurityGroupEgress.
\nFor more information about VPC security group limits, see Amazon VPC Limits.
" + "smithy.api#documentation": "Creates a security group.
\nA security group acts as a virtual firewall for your instance to control inbound and outbound traffic.\n For more information, see\n\t\t\t\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nWhen you create a security group, you specify a friendly name of your choice. \n You can't have two security groups for the same VPC with the same name.
\nYou have a default security group for use in your VPC. If you don't specify a security group \n when you launch an instance, the instance is launched into the appropriate default security group. \n A default security group includes a default rule that grants instances unrestricted network access \n to each other.
\nYou can add or remove rules from your security groups using \n\t\t\t\t\tAuthorizeSecurityGroupIngress,\n\t\t\t\t\tAuthorizeSecurityGroupEgress,\n\t\t\t\t\tRevokeSecurityGroupIngress, and\n\t\t\t\t\tRevokeSecurityGroupEgress.
\nFor more information about VPC security group limits, see Amazon VPC Limits.
", + "smithy.api#examples": [ + { + "title": "To create a security group for a VPC", + "documentation": "This example creates a security group for the specified VPC.", + "input": { + "Description": "My security group", + "GroupName": "my-security-group", + "VpcId": "vpc-1a2b3c4d" + }, + "output": { + "GroupId": "sg-903004f8" + } + } + ] } }, "com.amazonaws.ec2#CreateSecurityGroupRequest": { @@ -17483,7 +17808,27 @@ "target": "com.amazonaws.ec2#Snapshot" }, "traits": { - "smithy.api#documentation": "Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for\n \tbackups, to make copies of EBS volumes, and to save data before shutting down an\n \tinstance.
\nYou can create snapshots of volumes in a Region and volumes on an Outpost. If you \n \tcreate a snapshot of a volume in a Region, the snapshot must be stored in the same \n \tRegion as the volume. If you create a snapshot of a volume on an Outpost, the snapshot \n \tcan be stored on the same Outpost as the volume, or in the Region for that Outpost.
\nWhen a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.
\nYou can take a snapshot of an attached volume that is in use. However, snapshots only\n capture data that has been written to your Amazon EBS volume at the time the snapshot command is\n issued; this might exclude any data that has been cached by any applications or the operating\n system. If you can pause any file systems on the volume long enough to take a snapshot, your\n snapshot should be complete. However, if you cannot pause all file writes to the volume, you\n should unmount the volume from within the instance, issue the snapshot command, and then\n remount the volume to ensure a consistent and complete snapshot. You may remount and use your\n volume while the snapshot status is pending.
When you create a snapshot for an EBS volume that serves as a root device, we recommend \n that you stop the instance before taking the snapshot.
\nSnapshots that are taken from encrypted volumes are automatically encrypted. Volumes that\n are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes\n and any associated snapshots always remain protected.
\nYou can tag your snapshots during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.
\nFor more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for\n \tbackups, to make copies of EBS volumes, and to save data before shutting down an\n \tinstance.
\nYou can create snapshots of volumes in a Region and volumes on an Outpost. If you \n \tcreate a snapshot of a volume in a Region, the snapshot must be stored in the same \n \tRegion as the volume. If you create a snapshot of a volume on an Outpost, the snapshot \n \tcan be stored on the same Outpost as the volume, or in the Region for that Outpost.
\nWhen a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.
\nYou can take a snapshot of an attached volume that is in use. However, snapshots only\n capture data that has been written to your Amazon EBS volume at the time the snapshot command is\n issued; this might exclude any data that has been cached by any applications or the operating\n system. If you can pause any file systems on the volume long enough to take a snapshot, your\n snapshot should be complete. However, if you cannot pause all file writes to the volume, you\n should unmount the volume from within the instance, issue the snapshot command, and then\n remount the volume to ensure a consistent and complete snapshot. You may remount and use your\n volume while the snapshot status is pending.
When you create a snapshot for an EBS volume that serves as a root device, we recommend \n that you stop the instance before taking the snapshot.
\nSnapshots that are taken from encrypted volumes are automatically encrypted. Volumes that\n are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes\n and any associated snapshots always remain protected.
\nYou can tag your snapshots during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.
\nFor more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To create a snapshot", + "documentation": "This example creates a snapshot of the volume with a volume ID of ``vol-1234567890abcdef0`` and a short description to identify the snapshot.", + "input": { + "VolumeId": "vol-1234567890abcdef0", + "Description": "This is my root volume snapshot." + }, + "output": { + "Description": "This is my root volume snapshot.", + "Tags": [], + "VolumeId": "vol-1234567890abcdef0", + "State": "pending", + "VolumeSize": 8, + "StartTime": "2014-02-28T21:06:01.000Z", + "OwnerId": "012345678910", + "SnapshotId": "snap-066877671789bd71b" + } + } + ] } }, "com.amazonaws.ec2#CreateSnapshotRequest": { @@ -17750,7 +18095,27 @@ "target": "com.amazonaws.ec2#CreateSubnetResult" }, "traits": { - "smithy.api#documentation": "Creates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block.\n If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead.\n For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both\n an IPv4 CIDR block and an IPv6 CIDR block.
\nA subnet CIDR block must not overlap the CIDR block of an existing subnet in the VPC.\n After you create a subnet, you can't change its CIDR block.
\nThe allowed size for an IPv4 subnet is between a /28 netmask (16 IP addresses) and \n a /16 netmask (65,536 IP addresses). Amazon Web Services reserves both the first four and \n the last IPv4 address in each subnet's CIDR block. They're not available for your use.
\nIf you've associated an IPv6 CIDR block with your VPC, you can associate an IPv6 CIDR block \n with a subnet when you create it. The allowed block size for an IPv6 subnet is a /64 netmask.
\nIf you add more than one subnet to a VPC, they're set up in a star topology with a\n logical router in the middle.
\nWhen you stop an instance in a subnet, it retains its private IPv4 address. It's\n therefore possible to have a subnet with no running instances (they're all stopped), but\n no remaining IP addresses available.
\nFor more information, see Subnets in the Amazon VPC User Guide.
" + "smithy.api#documentation": "Creates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block.\n If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead.\n For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both\n an IPv4 CIDR block and an IPv6 CIDR block.
\nA subnet CIDR block must not overlap the CIDR block of an existing subnet in the VPC.\n After you create a subnet, you can't change its CIDR block.
\nThe allowed size for an IPv4 subnet is between a /28 netmask (16 IP addresses) and \n a /16 netmask (65,536 IP addresses). Amazon Web Services reserves both the first four and \n the last IPv4 address in each subnet's CIDR block. They're not available for your use.
\nIf you've associated an IPv6 CIDR block with your VPC, you can associate an IPv6 CIDR block \n with a subnet when you create it. The allowed block size for an IPv6 subnet is a /64 netmask.
\nIf you add more than one subnet to a VPC, they're set up in a star topology with a\n logical router in the middle.
\nWhen you stop an instance in a subnet, it retains its private IPv4 address. It's\n therefore possible to have a subnet with no running instances (they're all stopped), but\n no remaining IP addresses available.
\nFor more information, see Subnets in the Amazon VPC User Guide.
", + "smithy.api#examples": [ + { + "title": "To create a subnet", + "documentation": "This example creates a subnet in the specified VPC with the specified CIDR block. We recommend that you let us select an Availability Zone for you.", + "input": { + "VpcId": "vpc-a01106c2", + "CidrBlock": "10.0.1.0/24" + }, + "output": { + "Subnet": { + "VpcId": "vpc-a01106c2", + "CidrBlock": "10.0.1.0/24", + "State": "pending", + "AvailabilityZone": "us-west-2c", + "SubnetId": "subnet-9d4a7b6c", + "AvailableIpAddressCount": 251 + } + } + } + ] } }, "com.amazonaws.ec2#CreateSubnetCidrReservation": { @@ -17762,7 +18127,7 @@ "target": "com.amazonaws.ec2#CreateSubnetCidrReservationResult" }, "traits": { - "smithy.api#documentation": "Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Creates a subnet CIDR reservation. For more information, see Subnet CIDR reservations \n in the Amazon Virtual Private Cloud User Guide and Assign prefixes \n to network interfaces in the Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateSubnetCidrReservationRequest": { @@ -17788,14 +18153,14 @@ "target": "com.amazonaws.ec2#SubnetCidrReservationType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of reservation.
\nThe following are valid values:
\n\n prefix: The Amazon EC2\n Prefix\n Delegation feature assigns the IP addresses to network interfaces that are\n associated with an instance. For information about Prefix\n Delegation,\n see Prefix Delegation\n for Amazon EC2 network interfaces in the\n Amazon Elastic Compute Cloud User Guide.
\n explicit: You manually assign the IP addresses to resources that\n reside in your subnet.
The type of reservation. The reservation type determines how the reserved IP addresses are \n assigned to resources.
\n\n prefix - Amazon Web Services assigns the reserved IP addresses to \n network interfaces.
\n explicit - You assign the reserved IP addresses to network interfaces.
The\n description\n to assign to the subnet CIDR reservation.
" + "smithy.api#documentation": "The description to assign to the subnet CIDR reservation.
" } }, "DryRun": { @@ -18219,7 +18584,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do\n not specify this parameter when you want to mirror the entire packet. To mirror a subset of\n the packet, set this to the length (in bytes) that you want to mirror. For example, if you\n set this value to 100, then the first 100 bytes that meet the filter criteria are copied to\n the target.
\nIf you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.
The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do\n not specify this parameter when you want to mirror the entire packet. To mirror a subset of\n the packet, set this to the length (in bytes) that you want to mirror. For example, if you\n set this value to 100, then the first 100 bytes that meet the filter criteria are copied to\n the target.
\nIf you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.
For sessions with Network Load Balancer (NLB) Traffic Mirror targets the default PacketLength will be set to 8500. Valid values are 1-8500. Setting a PacketLength greater than 8500 will result in an error response.
Creates an EBS volume that can be attached to an instance in the same Availability Zone.
\nYou can create a new empty volume or restore a volume from an EBS snapshot.\n Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.
\nYou can create encrypted volumes. Encrypted volumes must be attached to instances that \n support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically \n encrypted. For more information, see Amazon EBS encryption\n in the Amazon Elastic Compute Cloud User Guide.
\nYou can tag your volumes during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.
\nFor more information, see Create an Amazon EBS volume in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Creates an EBS volume that can be attached to an instance in the same Availability Zone.
\nYou can create a new empty volume or restore a volume from an EBS snapshot.\n Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.
\nYou can create encrypted volumes. Encrypted volumes must be attached to instances that \n support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically \n encrypted. For more information, see Amazon EBS encryption\n in the Amazon Elastic Compute Cloud User Guide.
\nYou can tag your volumes during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.
\nFor more information, see Create an Amazon EBS volume in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To create a new volume", + "documentation": "This example creates an 80 GiB General Purpose (SSD) volume in the Availability Zone ``us-east-1a``.", + "input": { + "AvailabilityZone": "us-east-1a", + "Size": 80, + "VolumeType": "gp2" + }, + "output": { + "AvailabilityZone": "us-east-1a", + "Encrypted": false, + "VolumeType": "gp2", + "VolumeId": "vol-6b60b7c7", + "State": "creating", + "Iops": 240, + "SnapshotId": "", + "CreateTime": "2016-08-29T18:52:32.724Z", + "Size": 80 + } + } + ] } }, "com.amazonaws.ec2#CreateVolumePermission": { @@ -19949,7 +20336,25 @@ "target": "com.amazonaws.ec2#CreateVpcResult" }, "traits": { - "smithy.api#documentation": "Creates a VPC with the specified CIDR blocks. For more information, see IP addressing for your VPCs and subnets in the \n Amazon VPC User Guide.
\nYou can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided \n IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address \n pool that you provisioned through bring your own IP addresses (BYOIP).
\nBy default, each instance that you launch in the VPC has the default DHCP options, which\n\t\t\tinclude only a default DNS server that we provide (AmazonProvidedDNS). For more\n\t\t\tinformation, see DHCP option sets in the Amazon VPC User Guide.
\nYou can specify the instance tenancy value for the VPC when you create it. You can't change\n this value for the VPC after you create it. For more information, see Dedicated Instances in the\n Amazon EC2 User Guide.
" + "smithy.api#documentation": "Creates a VPC with the specified CIDR blocks. For more information, see IP addressing for your VPCs and subnets in the \n Amazon VPC User Guide.
\nYou can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided \n IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address \n pool that you provisioned through bring your own IP addresses (BYOIP).
\nBy default, each instance that you launch in the VPC has the default DHCP options, which\n\t\t\tinclude only a default DNS server that we provide (AmazonProvidedDNS). For more\n\t\t\tinformation, see DHCP option sets in the Amazon VPC User Guide.
\nYou can specify the instance tenancy value for the VPC when you create it. You can't change\n this value for the VPC after you create it. For more information, see Dedicated Instances in the\n Amazon EC2 User Guide.
", + "smithy.api#examples": [ + { + "title": "To create a VPC", + "documentation": "This example creates a VPC with the specified CIDR block.", + "input": { + "CidrBlock": "10.0.0.0/16" + }, + "output": { + "Vpc": { + "InstanceTenancy": "default", + "State": "pending", + "VpcId": "vpc-a01106c2", + "CidrBlock": "10.0.0.0/16", + "DhcpOptionsId": "dopt-7a8b9c2d" + } + } + } + ] } }, "com.amazonaws.ec2#CreateVpcEndpoint": { @@ -21332,7 +21737,16 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Deletes the specified customer gateway. You must delete the VPN connection before you\n can delete the customer gateway.
" + "smithy.api#documentation": "Deletes the specified customer gateway. You must delete the VPN connection before you\n can delete the customer gateway.
", + "smithy.api#examples": [ + { + "title": "To delete a customer gateway", + "documentation": "This example deletes the specified customer gateway.", + "input": { + "CustomerGatewayId": "cgw-0e11f167" + } + } + ] } }, "com.amazonaws.ec2#DeleteCustomerGatewayRequest": { @@ -21371,7 +21785,16 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.
" + "smithy.api#documentation": "Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.
", + "smithy.api#examples": [ + { + "title": "To delete a DHCP options set", + "documentation": "This example deletes the specified DHCP options set.", + "input": { + "DhcpOptionsId": "dopt-d9070ebb" + } + } + ] } }, "com.amazonaws.ec2#DeleteDhcpOptionsRequest": { @@ -22136,7 +22559,16 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Deletes the specified key pair, by removing the public key from Amazon EC2.
" + "smithy.api#documentation": "Deletes the specified key pair, by removing the public key from Amazon EC2.
", + "smithy.api#examples": [ + { + "title": "To delete a key pair", + "documentation": "This example deletes the specified key pair.", + "input": { + "KeyName": "my-key-pair" + } + } + ] } }, "com.amazonaws.ec2#DeleteKeyPairRequest": { @@ -22178,7 +22610,26 @@ "target": "com.amazonaws.ec2#DeleteLaunchTemplateResult" }, "traits": { - "smithy.api#documentation": "Deletes a launch template. Deleting a launch template deletes all of its\n versions.
" + "smithy.api#documentation": "Deletes a launch template. Deleting a launch template deletes all of its\n versions.
", + "smithy.api#examples": [ + { + "title": "To delete a launch template", + "documentation": "This example deletes the specified launch template.", + "input": { + "LaunchTemplateId": "lt-0abcd290751193123" + }, + "output": { + "LaunchTemplate": { + "LatestVersionNumber": 2, + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "my-template", + "DefaultVersionNumber": 2, + "CreatedBy": "arn:aws:iam::123456789012:root", + "CreateTime": "2017-11-23T16:46:25.000Z" + } + } + } + ] } }, "com.amazonaws.ec2#DeleteLaunchTemplateRequest": { @@ -22234,7 +22685,29 @@ "target": "com.amazonaws.ec2#DeleteLaunchTemplateVersionsResult" }, "traits": { - "smithy.api#documentation": "Deletes one or more versions of a launch template. You cannot delete the default\n version of a launch template; you must first assign a different version as the default.\n If the default version is the only version for the launch template, you must delete the\n entire launch template using DeleteLaunchTemplate.
" + "smithy.api#documentation": "Deletes one or more versions of a launch template.
\nYou can't delete the default version of a launch template; you must first assign a\n different version as the default. If the default version is the only version for the\n launch template, you must delete the entire launch template using DeleteLaunchTemplate.
\nYou can delete up to 200 launch template versions in a single request. To delete more\n than 200 versions in a single request, use DeleteLaunchTemplate, which\n deletes the launch template and all of its versions.
\nFor more information, see Delete a launch template version in the EC2 User\n Guide.
", + "smithy.api#examples": [ + { + "title": "To delete a launch template version", + "documentation": "This example deletes the specified launch template version.", + "input": { + "LaunchTemplateId": "lt-0abcd290751193123", + "Versions": [ + "1" + ] + }, + "output": { + "SuccessfullyDeletedLaunchTemplateVersions": [ + { + "LaunchTemplateName": "my-template", + "VersionNumber": 1, + "LaunchTemplateId": "lt-0abcd290751193123" + } + ], + "UnsuccessfullyDeletedLaunchTemplateVersions": [] + } + } + ] } }, "com.amazonaws.ec2#DeleteLaunchTemplateVersionsRequest": { @@ -22264,7 +22737,7 @@ "target": "com.amazonaws.ec2#VersionStringList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The version numbers of one or more launch template versions to delete.
", + "smithy.api#documentation": "The version numbers of one or more launch template versions to delete. You can specify\n up to 200 launch template version numbers.
", "smithy.api#required": {}, "smithy.api#xmlName": "LaunchTemplateVersion" } @@ -22673,7 +23146,19 @@ "target": "com.amazonaws.ec2#DeleteNatGatewayResult" }, "traits": { - "smithy.api#documentation": "Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, \n but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway \n routes in your route tables.
" + "smithy.api#documentation": "Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, \n but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway \n routes in your route tables.
", + "smithy.api#examples": [ + { + "title": "To delete a NAT gateway", + "documentation": "This example deletes the specified NAT gateway.", + "input": { + "NatGatewayId": "nat-04ae55e711cec5680" + }, + "output": { + "NatGatewayId": "nat-04ae55e711cec5680" + } + } + ] } }, "com.amazonaws.ec2#DeleteNatGatewayRequest": { @@ -23460,7 +23945,17 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Deletes a security group.
\nIf you attempt to delete a security group that is associated with an instance or network interface or is\n\t\t\t referenced by another security group, the operation fails with\n\t\t\t\tDependencyViolation.
Deletes a security group.
\nIf you attempt to delete a security group that is associated with an instance or network interface or is\n\t\t\t referenced by another security group, the operation fails with\n\t\t\t\tDependencyViolation.
Deletes the specified snapshot.
\nWhen you make periodic snapshots of a volume, the snapshots are incremental, and only the\n blocks on the device that have changed since your last snapshot are saved in the new snapshot.\n When you delete a snapshot, only the data not needed for any other snapshot is removed. So\n regardless of which prior snapshots have been deleted, all active snapshots will have access\n to all the information needed to restore the volume.
\nYou cannot delete a snapshot of the root device of an EBS volume used by a registered AMI.\n You must first de-register the AMI before you can delete the snapshot.
\nFor more information, see Delete an Amazon EBS snapshot in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Deletes the specified snapshot.
\nWhen you make periodic snapshots of a volume, the snapshots are incremental, and only the\n blocks on the device that have changed since your last snapshot are saved in the new snapshot.\n When you delete a snapshot, only the data not needed for any other snapshot is removed. So\n regardless of which prior snapshots have been deleted, all active snapshots will have access\n to all the information needed to restore the volume.
\nYou cannot delete a snapshot of the root device of an EBS volume used by a registered AMI.\n You must first de-register the AMI before you can delete the snapshot.
\nFor more information, see Delete an Amazon EBS snapshot in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To delete a snapshot", + "documentation": "This example deletes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``. If the command succeeds, no output is returned.", + "input": { + "SnapshotId": "snap-1234567890abcdef0" + }, + "output": {} + } + ] } }, "com.amazonaws.ec2#DeleteSnapshotRequest": { @@ -23540,7 +24045,13 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Deletes the data feed for Spot Instances.
" + "smithy.api#documentation": "Deletes the data feed for Spot Instances.
", + "smithy.api#examples": [ + { + "title": "To cancel a Spot Instance data feed subscription", + "documentation": "This example deletes a Spot data feed subscription for the account." + } + ] } }, "com.amazonaws.ec2#DeleteSpotDatafeedSubscriptionRequest": { @@ -23571,7 +24082,16 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
" + "smithy.api#documentation": "Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
", + "smithy.api#examples": [ + { + "title": "To delete a subnet", + "documentation": "This example deletes the specified subnet.", + "input": { + "SubnetId": "subnet-9d4a7b6c" + } + } + ] } }, "com.amazonaws.ec2#DeleteSubnetCidrReservation": { @@ -24741,7 +25261,17 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Deletes the specified EBS volume. The volume must be in the available state\n (not attached to an instance).
The volume can remain in the deleting state for several minutes.
For more information, see Delete an Amazon EBS volume in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Deletes the specified EBS volume. The volume must be in the available state\n (not attached to an instance).
The volume can remain in the deleting state for several minutes.
For more information, see Delete an Amazon EBS volume in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To delete a volume", + "documentation": "This example deletes an available volume with the volume ID of ``vol-049df61146c4d7901``. If the command succeeds, no output is returned.", + "input": { + "VolumeId": "vol-049df61146c4d7901" + }, + "output": {} + } + ] } }, "com.amazonaws.ec2#DeleteVolumeRequest": { @@ -24779,7 +25309,16 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.
" + "smithy.api#documentation": "Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.
", + "smithy.api#examples": [ + { + "title": "To delete a VPC", + "documentation": "This example deletes the specified VPC.", + "input": { + "VpcId": "vpc-a01106c2" + } + } + ] } }, "com.amazonaws.ec2#DeleteVpcEndpointConnectionNotifications": { @@ -25574,7 +26113,33 @@ "target": "com.amazonaws.ec2#DescribeAccountAttributesResult" }, "traits": { - "smithy.api#documentation": "Describes attributes of your Amazon Web Services account. The following are the supported account attributes:
\n\n default-vpc: The ID of the default VPC for your account, or none.
\n max-instances: This attribute is no longer supported. The returned\n value does not reflect your actual vCPU limit for running On-Demand Instances.\n For more information, see On-Demand Instance Limits in the\n Amazon Elastic Compute Cloud User Guide.
\n max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate.
\n supported-platforms: This attribute is deprecated.
\n vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate.
\n vpc-max-security-groups-per-interface: The maximum number of security groups\n that you can assign to a network interface.
Describes attributes of your Amazon Web Services account. The following are the supported account attributes:
\n\n default-vpc: The ID of the default VPC for your account, or none.
\n max-instances: This attribute is no longer supported. The returned\n value does not reflect your actual vCPU limit for running On-Demand Instances.\n For more information, see On-Demand Instance Limits in the\n Amazon Elastic Compute Cloud User Guide.
\n max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate.
\n supported-platforms: This attribute is deprecated.
\n vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate.
\n vpc-max-security-groups-per-interface: The maximum number of security groups\n that you can assign to a network interface.
Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
" + "smithy.api#documentation": "Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
", + "smithy.api#examples": [ + { + "title": "To describe your Elastic IP addresses", + "documentation": "This example describes your Elastic IP addresses.", + "output": { + "Addresses": [ + { + "InstanceId": "i-1234567890abcdef0", + "PublicIp": "198.51.100.0", + "Domain": "standard" + }, + { + "Domain": "vpc", + "InstanceId": "i-1234567890abcdef0", + "NetworkInterfaceId": "eni-12345678", + "AssociationId": "eipassoc-12345678", + "NetworkInterfaceOwnerId": "123456789012", + "PublicIp": "203.0.113.0", + "AllocationId": "eipalloc-12345678", + "PrivateIpAddress": "10.0.1.241" + } + ] + } + } + ] } }, "com.amazonaws.ec2#DescribeAddressesAttribute": { @@ -25923,7 +26513,41 @@ "target": "com.amazonaws.ec2#DescribeAvailabilityZonesResult" }, "traits": { - "smithy.api#documentation": "Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to\n you. If there is an event impacting a zone, you can use this request to view the state and any\n provided messages for that zone.
\nFor more information about Availability Zones, Local Zones, and Wavelength Zones, see\n Regions and zones \n in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to\n you. If there is an event impacting a zone, you can use this request to view the state and any\n provided messages for that zone.
\nFor more information about Availability Zones, Local Zones, and Wavelength Zones, see\n Regions and zones \n in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To describe your Availability Zones", + "documentation": "This example describes the Availability Zones that are available to you. The response includes Availability Zones only for the current region.", + "output": { + "AvailabilityZones": [ + { + "State": "available", + "RegionName": "us-east-1", + "Messages": [], + "ZoneName": "us-east-1b" + }, + { + "State": "available", + "RegionName": "us-east-1", + "Messages": [], + "ZoneName": "us-east-1c" + }, + { + "State": "available", + "RegionName": "us-east-1", + "Messages": [], + "ZoneName": "us-east-1d" + }, + { + "State": "available", + "RegionName": "us-east-1", + "Messages": [], + "ZoneName": "us-east-1e" + } + ] + } + } + ] } }, "com.amazonaws.ec2#DescribeAvailabilityZonesRequest": { @@ -27334,6 +27958,28 @@ }, "traits": { "smithy.api#documentation": "Describes one or more of your VPN customer gateways.
\nFor more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.
", + "smithy.api#examples": [ + { + "title": "To describe a customer gateway", + "documentation": "This example describes the specified customer gateway.", + "input": { + "CustomerGatewayIds": [ + "cgw-0e11f167" + ] + }, + "output": { + "CustomerGateways": [ + { + "CustomerGatewayId": "cgw-0e11f167", + "IpAddress": "12.1.2.3", + "State": "available", + "Type": "ipsec.1", + "BgpAsn": "65534" + } + ] + } + } + ], "smithy.waiters#waitable": { "CustomerGatewayAvailable": { "acceptors": [ @@ -27433,6 +28079,37 @@ }, "traits": { "smithy.api#documentation": "Describes one or more of your DHCP options sets.
\nFor more information, see DHCP options sets in the\n\t\t\t\tAmazon VPC User Guide.
", + "smithy.api#examples": [ + { + "title": "To describe a DHCP options set", + "documentation": "This example describes the specified DHCP options set.", + "input": { + "DhcpOptionsIds": [ + "dopt-d9070ebb" + ] + }, + "output": { + "DhcpOptions": [ + { + "DhcpConfigurations": [ + { + "Values": [ + { + "Value": "10.2.5.2" + }, + { + "Value": "10.2.5.1" + } + ], + "Key": "domain-name-servers" + } + ], + "DhcpOptionsId": "dopt-d9070ebb" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -29184,6 +29861,30 @@ }, "traits": { "smithy.api#documentation": "Describes your IAM instance profile associations.
", + "smithy.api#examples": [ + { + "title": "To describe an IAM instance profile association", + "documentation": "This example describes the specified IAM instance profile association.", + "input": { + "AssociationIds": [ + "iip-assoc-0db249b1f25fa24b8" + ] + }, + "output": { + "IamInstanceProfileAssociations": [ + { + "InstanceId": "i-09eb09efa73ec1dee", + "State": "associated", + "AssociationId": "iip-assoc-0db249b1f25fa24b8", + "IamInstanceProfile": { + "Id": "AIPAJVQN4F5WVLGCJDRGM", + "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role" + } + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -29367,7 +30068,25 @@ "target": "com.amazonaws.ec2#ImageAttribute" }, "traits": { - "smithy.api#documentation": "Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
" + "smithy.api#documentation": "Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
", + "smithy.api#examples": [ + { + "title": "To describe the launch permissions for an AMI", + "documentation": "This example describes the launch permissions for the specified AMI.", + "input": { + "Attribute": "launchPermission", + "ImageId": "ami-5731123e" + }, + "output": { + "ImageId": "ami-5731123e", + "LaunchPermissions": [ + { + "UserId": "123456789012" + } + ] + } + } + ] } }, "com.amazonaws.ec2#DescribeImageAttributeRequest": { @@ -29415,6 +30134,48 @@ }, "traits": { "smithy.api#documentation": "Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
\nThe images available to you include public images, private images that you own, and private images owned by other \n Amazon Web Services accounts for which you have explicit launch permissions.
\nRecently 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#examples": [ + { + "title": "To describe an AMI", + "documentation": "This example describes the specified AMI.", + "input": { + "ImageIds": [ + "ami-5731123e" + ] + }, + "output": { + "Images": [ + { + "VirtualizationType": "paravirtual", + "Name": "My server", + "Hypervisor": "xen", + "ImageId": "ami-5731123e", + "RootDeviceType": "ebs", + "State": "available", + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "DeleteOnTermination": true, + "SnapshotId": "snap-1234567890abcdef0", + "VolumeSize": 8, + "VolumeType": "standard" + } + } + ], + "Architecture": "x86_64", + "ImageLocation": "123456789012/My server", + "KernelId": "aki-88aa75e1", + "OwnerId": "123456789012", + "RootDeviceName": "/dev/sda1", + "Public": false, + "ImageType": "machine", + "Description": "An AMI for my server" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -30138,6 +30899,47 @@ }, "traits": { "smithy.api#documentation": "Describes the status of the specified instances or all of your instances. By default,\n only running instances are described, unless you specifically indicate to return the\n status of all instances.
\nInstance status includes the following components:
\n\n Status checks - Amazon EC2 performs status\n checks on running EC2 instances to identify hardware and software issues. For\n more information, see Status checks for your instances and Troubleshoot\n instances with failed status checks in the Amazon EC2 User\n Guide.
\n\n Scheduled events - Amazon EC2 can schedule\n events (such as reboot, stop, or terminate) for your instances related to\n hardware issues, software updates, or system maintenance. For more information,\n see Scheduled events for your instances in the Amazon EC2 User\n Guide.
\n\n Instance state - You can manage your instances\n from the moment you launch them through their termination. For more information,\n see Instance\n lifecycle in the Amazon EC2 User Guide.
\nDescribes the specified instances or all instances.
\nIf you specify instance IDs, the output includes information for only the specified\n instances. If you specify filters, the output includes information for only those\n instances that meet the filter criteria. If you do not specify instance IDs or filters,\n the output includes information for all instances, which can affect performance. We\n recommend that you use pagination to ensure that the operation returns quickly and\n successfully.
\nIf you specify an instance ID that is not valid, an error is returned. If you specify\n an instance that you do not own, it is not included in the output.
\nRecently terminated instances might appear in the returned results. This interval is\n usually less than one hour.
\nIf you describe instances in the rare case where an Availability Zone is experiencing\n a service disruption and you specify instance IDs that are in the affected zone, or do\n not specify any instance IDs at all, the call fails. If you describe instances and\n specify only instance IDs that are in an unaffected zone, the call works\n normally.
", + "smithy.api#examples": [ + { + "title": "To describe an Amazon EC2 instance", + "documentation": "This example describes the specified instance.", + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": {} + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -30605,7 +31419,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "The filters.
\n\n affinity - The affinity setting for an instance running on a\n Dedicated Host (default | host).
\n architecture - The instance architecture (i386 |\n x86_64 | arm64).
\n availability-zone - The Availability Zone of the instance.
\n block-device-mapping.attach-time - The attach time for an EBS\n volume mapped to the instance, for example,\n 2010-09-15T17:15:20.000Z.
\n block-device-mapping.delete-on-termination - A Boolean that\n indicates whether the EBS volume is deleted on instance termination.
\n block-device-mapping.device-name - The device name specified in the\n block device mapping (for example, /dev/sdh or\n xvdh).
\n block-device-mapping.status - The status for the EBS volume\n (attaching | attached | detaching |\n detached).
\n block-device-mapping.volume-id - The volume ID of the EBS\n volume.
\n capacity-reservation-id - The ID of the Capacity Reservation into which the\n instance was launched.
\n client-token - The idempotency token you provided when you launched\n the instance.
\n dns-name - The public DNS name of the instance.
\n hibernation-options.configured - A Boolean that indicates whether\n the instance is enabled for hibernation. A value of true means that\n the instance is enabled for hibernation.
\n host-id - The ID of the Dedicated Host on which the instance is\n running, if applicable.
\n hypervisor - The hypervisor type of the instance\n (ovm | xen). The value xen is used\n for both Xen and Nitro hypervisors.
\n iam-instance-profile.arn - The instance profile associated with\n the instance. Specified as an ARN.
\n image-id - The ID of the image used to launch the\n instance.
\n instance-id - The ID of the instance.
\n instance-lifecycle - Indicates whether this is a Spot Instance or\n a Scheduled Instance (spot | scheduled).
\n instance-state-code - The state of the instance, as a 16-bit\n unsigned integer. The high byte is used for internal purposes and should be\n ignored. The low byte is set based on the state represented. The valid values\n are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64\n (stopping), and 80 (stopped).
\n instance-state-name - The state of the instance\n (pending | running | shutting-down |\n terminated | stopping |\n stopped).
\n instance-type - The type of instance (for example,\n t2.micro).
\n instance.group-id - The ID of the security group for the\n instance.
\n instance.group-name - The name of the security group for the\n instance.
\n ip-address - The public IPv4 address of the instance.
\n kernel-id - The kernel ID.
\n key-name - The name of the key pair used when the instance was\n launched.
\n launch-index - When launching multiple instances, this is the\n index for the instance in the launch group (for example, 0, 1, 2, and so on).\n
\n launch-time - The time when the instance was launched, in the ISO\n 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2021-09-29T11:04:43.305Z. You can use a wildcard\n (*), for example, 2021-09-29T*, which matches an\n entire day.
\n metadata-options.http-tokens - The metadata request authorization\n state (optional | required)
\n metadata-options.http-put-response-hop-limit - The HTTP metadata\n request put response hop limit (integer, possible values 1 to\n 64)
\n metadata-options.http-endpoint - The status of access to the HTTP\n metadata endpoint on your instance (enabled |\n disabled)
\n metadata-options.instance-metadata-tags - The status of access to\n instance tags from the instance metadata (enabled |\n disabled)
\n monitoring-state - Indicates whether detailed monitoring is\n enabled (disabled | enabled).
\n network-interface.addresses.private-ip-address - The private IPv4\n address associated with the network interface.
\n network-interface.addresses.primary - Specifies whether the IPv4\n address of the network interface is the primary private IPv4 address.
\n network-interface.addresses.association.public-ip - The ID of the\n association of an Elastic IP address (IPv4) with a network interface.
\n network-interface.addresses.association.ip-owner-id - The owner\n ID of the private IPv4 address associated with the network interface.
\n network-interface.association.public-ip - The address of the\n Elastic IP address (IPv4) bound to the network interface.
\n network-interface.association.ip-owner-id - The owner of the\n Elastic IP address (IPv4) associated with the network interface.
\n network-interface.association.allocation-id - The allocation ID\n returned when you allocated the Elastic IP address (IPv4) for your network\n interface.
\n network-interface.association.association-id - The association ID\n returned when the network interface was associated with an IPv4 address.
\n network-interface.attachment.attachment-id - The ID of the\n interface attachment.
\n network-interface.attachment.instance-id - The ID of the instance\n to which the network interface is attached.
\n network-interface.attachment.instance-owner-id - The owner ID of\n the instance to which the network interface is attached.
\n network-interface.attachment.device-index - The device index to\n which the network interface is attached.
\n network-interface.attachment.status - The status of the\n attachment (attaching | attached |\n detaching | detached).
\n network-interface.attachment.attach-time - The time that the\n network interface was attached to an instance.
\n network-interface.attachment.delete-on-termination - Specifies\n whether the attachment is deleted when an instance is terminated.
\n network-interface.availability-zone - The Availability Zone for\n the network interface.
\n network-interface.description - The description of the network\n interface.
\n network-interface.group-id - The ID of a security group\n associated with the network interface.
\n network-interface.group-name - The name of a security group\n associated with the network interface.
\n network-interface.ipv6-addresses.ipv6-address - The IPv6 address\n associated with the network interface.
\n network-interface.mac-address - The MAC address of the network\n interface.
\n network-interface.network-interface-id - The ID of the network\n interface.
\n network-interface.owner-id - The ID of the owner of the network\n interface.
\n network-interface.private-dns-name - The private DNS name of the\n network interface.
\n network-interface.requester-id - The requester ID for the network\n interface.
\n network-interface.requester-managed - Indicates whether the\n network interface is being managed by Amazon Web Services.
\n network-interface.status - The status of the network interface\n (available) | in-use).
\n network-interface.source-dest-check - Whether the network\n interface performs source/destination checking. A value of true\n means that checking is enabled, and false means that checking is\n disabled. The value must be false for the network interface to\n perform network address translation (NAT) in your VPC.
\n network-interface.subnet-id - The ID of the subnet for the\n network interface.
\n network-interface.vpc-id - The ID of the VPC for the network\n interface.
\n outpost-arn - The Amazon Resource Name (ARN) of the\n Outpost.
\n owner-id - The Amazon Web Services account ID of the instance\n owner.
\n placement-group-name - The name of the placement group for the\n instance.
\n placement-partition-number - The partition in which the instance is\n located.
\n platform - The platform. To list only Windows instances, use\n windows.
\n private-dns-name - The private IPv4 DNS name of the\n instance.
\n private-ip-address - The private IPv4 address of the\n instance.
\n product-code - The product code associated with the AMI used to\n launch the instance.
\n product-code.type - The type of product code (devpay |\n marketplace).
\n ramdisk-id - The RAM disk ID.
\n reason - The reason for the current state of the instance (for\n example, shows \"User Initiated [date]\" when you stop or terminate the instance).\n Similar to the state-reason-code filter.
\n requester-id - The ID of the entity that launched the instance on\n your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so\n on).
\n reservation-id - The ID of the instance's reservation. A\n reservation ID is created any time you launch an instance. A reservation ID has\n a one-to-one relationship with an instance launch request, but can be associated\n with more than one instance if you launch multiple instances using the same\n launch request. For example, if you launch one instance, you get one reservation\n ID. If you launch ten instances using the same launch request, you also get one\n reservation ID.
\n root-device-name - The device name of the root device volume (for\n example, /dev/sda1).
\n root-device-type - The type of the root device volume\n (ebs | instance-store).
\n source-dest-check - Indicates whether the instance performs\n source/destination checking. A value of true means that checking is\n enabled, and false means that checking is disabled. The value must\n be false for the instance to perform network address translation\n (NAT) in your VPC.
\n spot-instance-request-id - The ID of the Spot Instance\n request.
\n state-reason-code - The reason code for the state change.
\n state-reason-message - A message that describes the state\n change.
\n subnet-id - The ID of the subnet for the instance.
\n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
\n tenancy - The tenancy of an instance (dedicated |\n default | host).
\n virtualization-type - The virtualization type of the instance\n (paravirtual | hvm).
\n vpc-id - The ID of the VPC that the instance is running in.
The filters.
\n\n affinity - The affinity setting for an instance running on a\n Dedicated Host (default | host).
\n architecture - The instance architecture (i386 |\n x86_64 | arm64).
\n availability-zone - The Availability Zone of the instance.
\n block-device-mapping.attach-time - The attach time for an EBS\n volume mapped to the instance, for example,\n 2022-09-15T17:15:20.000Z.
\n block-device-mapping.delete-on-termination - A Boolean that\n indicates whether the EBS volume is deleted on instance termination.
\n block-device-mapping.device-name - The device name specified in\n the block device mapping (for example, /dev/sdh or\n xvdh).
\n block-device-mapping.status - The status for the EBS volume\n (attaching | attached | detaching |\n detached).
\n block-device-mapping.volume-id - The volume ID of the EBS\n volume.
\n boot-mode - The boot mode that was specified by the AMI\n (legacy-bios | uefi |\n uefi-preferred).
\n capacity-reservation-id - The ID of the Capacity Reservation into which the\n instance was launched.
\n capacity-reservation-specification.capacity-reservation-preference\n - The instance's Capacity Reservation preference (open | none).
\n capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id\n - The ID of the targeted Capacity Reservation.
\n capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn\n - The ARN of the targeted Capacity Reservation group.
\n client-token - The idempotency token you provided when you\n launched the instance.
\n current-instance-boot-mode - The boot mode that is used to launch\n the instance at launch or start (legacy-bios |\n uefi).
\n dns-name - The public DNS name of the instance.
\n ebs-optimized - A Boolean that indicates whether the instance is\n optimized for Amazon EBS I/O.
\n ena-support - A Boolean that indicates whether the instance is\n enabled for enhanced networking with ENA.
\n enclave-options.enabled - A Boolean that indicates whether the\n instance is enabled for Amazon Web Services Nitro Enclaves.
\n hibernation-options.configured - A Boolean that indicates whether\n the instance is enabled for hibernation. A value of true means that\n the instance is enabled for hibernation.
\n host-id - The ID of the Dedicated Host on which the instance is\n running, if applicable.
\n hypervisor - The hypervisor type of the instance\n (ovm | xen). The value xen is used\n for both Xen and Nitro hypervisors.
\n iam-instance-profile.arn - The instance profile associated with\n the instance. Specified as an ARN.
\n iam-instance-profile.id - The instance profile associated with\n the instance. Specified as an ID.
\n iam-instance-profile.name - The instance profile associated with\n the instance. Specified as an name.
\n image-id - The ID of the image used to launch the\n instance.
\n instance-id - The ID of the instance.
\n instance-lifecycle - Indicates whether this is a Spot Instance or\n a Scheduled Instance (spot | scheduled).
\n instance-state-code - The state of the instance, as a 16-bit\n unsigned integer. The high byte is used for internal purposes and should be\n ignored. The low byte is set based on the state represented. The valid values\n are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64\n (stopping), and 80 (stopped).
\n instance-state-name - The state of the instance\n (pending | running | shutting-down |\n terminated | stopping |\n stopped).
\n instance-type - The type of instance (for example,\n t2.micro).
\n instance.group-id - The ID of the security group for the\n instance.
\n instance.group-name - The name of the security group for the\n instance.
\n ip-address - The public IPv4 address of the instance.
\n ipv6-address - The IPv6 address of the instance.
\n kernel-id - The kernel ID.
\n key-name - The name of the key pair used when the instance was\n launched.
\n launch-index - When launching multiple instances, this is the\n index for the instance in the launch group (for example, 0, 1, 2, and so on).\n
\n launch-time - The time when the instance was launched, in the ISO\n 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2021-09-29T11:04:43.305Z. You can use a wildcard\n (*), for example, 2021-09-29T*, which matches an\n entire day.
\n license-pool -
\n maintenance-options.auto-recovery - The current automatic\n recovery behavior of the instance (disabled | default).
\n metadata-options.http-endpoint - The status of access to the HTTP\n metadata endpoint on your instance (enabled |\n disabled)
\n metadata-options.http-protocol-ipv4 - Indicates whether the IPv4\n endpoint is enabled (disabled | enabled).
\n metadata-options.http-protocol-ipv6 - Indicates whether the IPv6\n endpoint is enabled (disabled | enabled).
\n metadata-options.http-put-response-hop-limit - The HTTP metadata\n request put response hop limit (integer, possible values 1 to\n 64)
\n metadata-options.http-tokens - The metadata request authorization\n state (optional | required)
\n metadata-options.instance-metadata-tags - The status of access to\n instance tags from the instance metadata (enabled |\n disabled)
\n metadata-options.state - The state of the metadata option changes\n (pending | applied).
\n monitoring-state - Indicates whether detailed monitoring is\n enabled (disabled | enabled).
\n network-interface.addresses.primary - Specifies whether the IPv4\n address of the network interface is the primary private IPv4 address.
\n network-interface.addresses.private-ip-address - The private IPv4\n address associated with the network interface.
\n network-interface.addresses.association.public-ip - The ID of the\n association of an Elastic IP address (IPv4) with a network interface.
\n network-interface.addresses.association.ip-owner-id - The owner\n ID of the private IPv4 address associated with the network interface.
\n network-interface.association.public-ip - The address of the\n Elastic IP address (IPv4) bound to the network interface.
\n network-interface.association.ip-owner-id - The owner of the\n Elastic IP address (IPv4) associated with the network interface.
\n network-interface.association.allocation-id - The allocation ID\n returned when you allocated the Elastic IP address (IPv4) for your network\n interface.
\n network-interface.association.association-id - The association ID\n returned when the network interface was associated with an IPv4 address.
\n network-interface.attachment.attachment-id - The ID of the\n interface attachment.
\n network-interface.attachment.instance-id - The ID of the instance\n to which the network interface is attached.
\n network-interface.attachment.instance-owner-id - The owner ID of\n the instance to which the network interface is attached.
\n network-interface.attachment.device-index - The device index to\n which the network interface is attached.
\n network-interface.attachment.status - The status of the\n attachment (attaching | attached |\n detaching | detached).
\n network-interface.attachment.attach-time - The time that the\n network interface was attached to an instance.
\n network-interface.attachment.delete-on-termination - Specifies\n whether the attachment is deleted when an instance is terminated.
\n network-interface.availability-zone - The Availability Zone for\n the network interface.
\n network-interface.description - The description of the network\n interface.
\n network-interface.group-id - The ID of a security group\n associated with the network interface.
\n network-interface.group-name - The name of a security group\n associated with the network interface.
\n network-interface.ipv6-addresses.ipv6-address - The IPv6 address\n associated with the network interface.
\n network-interface.mac-address - The MAC address of the network\n interface.
\n network-interface.network-interface-id - The ID of the network\n interface.
\n network-interface.owner-id - The ID of the owner of the network\n interface.
\n network-interface.private-dns-name - The private DNS name of the\n network interface.
\n network-interface.requester-id - The requester ID for the network\n interface.
\n network-interface.requester-managed - Indicates whether the\n network interface is being managed by Amazon Web Services.
\n network-interface.status - The status of the network interface\n (available) | in-use).
\n network-interface.source-dest-check - Whether the network\n interface performs source/destination checking. A value of true\n means that checking is enabled, and false means that checking is\n disabled. The value must be false for the network interface to\n perform network address translation (NAT) in your VPC.
\n network-interface.subnet-id - The ID of the subnet for the\n network interface.
\n network-interface.vpc-id - The ID of the VPC for the network\n interface.
\n outpost-arn - The Amazon Resource Name (ARN) of the\n Outpost.
\n owner-id - The Amazon Web Services account ID of the instance\n owner.
\n placement-group-name - The name of the placement group for the\n instance.
\n placement-partition-number - The partition in which the instance is\n located.
\n platform - The platform. To list only Windows instances, use\n windows.
\n platform-details - The platform (Linux/UNIX |\n Red Hat BYOL Linux | Red Hat Enterprise Linux |\n Red Hat Enterprise Linux with HA | Red Hat Enterprise\n Linux with SQL Server Standard and HA | Red Hat Enterprise\n Linux with SQL Server Enterprise and HA | Red Hat Enterprise\n Linux with SQL Server Standard | Red Hat Enterprise Linux with\n SQL Server Web | Red Hat Enterprise Linux with SQL Server\n Enterprise | SQL Server Enterprise | SQL Server\n Standard | SQL Server Web | SUSE Linux |\n Ubuntu Pro | Windows | Windows BYOL |\n Windows with SQL Server Enterprise | Windows with SQL\n Server Standard | Windows with SQL Server Web).
\n private-dns-name - The private IPv4 DNS name of the\n instance.
\n private-dns-name-options.enable-resource-name-dns-a-record - A\n Boolean that indicates whether to respond to DNS queries for instance hostnames\n with DNS A records.
\n private-dns-name-options.enable-resource-name-dns-aaaa-record - A\n Boolean that indicates whether to respond to DNS queries for instance hostnames\n with DNS AAAA records.
\n private-dns-name-options.hostname-type - The type of hostname\n (ip-name | resource-name).
\n private-ip-address - The private IPv4 address of the\n instance.
\n product-code - The product code associated with the AMI used to\n launch the instance.
\n product-code.type - The type of product code (devpay\n | marketplace).
\n ramdisk-id - The RAM disk ID.
\n reason - The reason for the current state of the instance (for\n example, shows \"User Initiated [date]\" when you stop or terminate the instance).\n Similar to the state-reason-code filter.
\n requester-id - The ID of the entity that launched the instance on\n your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so\n on).
\n reservation-id - The ID of the instance's reservation. A\n reservation ID is created any time you launch an instance. A reservation ID has\n a one-to-one relationship with an instance launch request, but can be associated\n with more than one instance if you launch multiple instances using the same\n launch request. For example, if you launch one instance, you get one reservation\n ID. If you launch ten instances using the same launch request, you also get one\n reservation ID.
\n root-device-name - The device name of the root device volume (for\n example, /dev/sda1).
\n root-device-type - The type of the root device volume\n (ebs | instance-store).
\n source-dest-check - Indicates whether the instance performs\n source/destination checking. A value of true means that checking is\n enabled, and false means that checking is disabled. The value must\n be false for the instance to perform network address translation\n (NAT) in your VPC.
\n spot-instance-request-id - The ID of the Spot Instance\n request.
\n state-reason-code - The reason code for the state change.
\n state-reason-message - A message that describes the state\n change.
\n subnet-id - The ID of the subnet for the instance.
\n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
\n tenancy - The tenancy of an instance (dedicated |\n default | host).
\n tpm-support - Indicates if the instance is configured for\n NitroTPM support (v2.0).
\n usage-operation - The usage operation value for the instance\n (RunInstances | RunInstances:00g0 |\n RunInstances:0010 | RunInstances:1010 |\n RunInstances:1014 | RunInstances:1110 |\n RunInstances:0014 | RunInstances:0210 |\n RunInstances:0110 | RunInstances:0100 |\n RunInstances:0004 | RunInstances:0200 |\n RunInstances:000g | RunInstances:0g00 |\n RunInstances:0002 | RunInstances:0800 |\n RunInstances:0102 | RunInstances:0006 |\n RunInstances:0202).
\n usage-operation-update-time - The time that the usage operation\n was last updated, for example, 2022-09-15T17:15:20.000Z.
\n virtualization-type - The virtualization type of the instance\n (paravirtual | hvm).
\n vpc-id - The ID of the VPC that the instance is running in.
Describes one or more of your internet gateways.
", + "smithy.api#examples": [ + { + "title": "To describe the Internet gateway for a VPC", + "documentation": "This example describes the Internet gateway for the specified VPC.", + "input": { + "Filters": [ + { + "Name": "attachment.vpc-id", + "Values": [ + "vpc-a01106c2" + ] + } + ] + }, + "output": { + "InternetGateways": [ + { + "Tags": [], + "InternetGatewayId": "igw-c0a643a9", + "Attachments": [ + { + "State": "attached", + "VpcId": "vpc-a01106c2" + } + ] + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -31324,6 +32168,25 @@ }, "traits": { "smithy.api#documentation": "Describes the specified key pairs or all of your key pairs.
\nFor more information about key pairs, see Amazon EC2 key pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To display a key pair", + "documentation": "This example displays the fingerprint for the specified key.", + "input": { + "KeyNames": [ + "my-key-pair" + ] + }, + "output": { + "KeyPairs": [ + { + "KeyName": "my-key-pair", + "KeyFingerprint": "1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f" + } + ] + } + } + ], "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], @@ -31425,6 +32288,66 @@ }, "traits": { "smithy.api#documentation": "Describes one or more versions of a specified launch template. You can describe all\n versions, individual versions, or a range of versions. You can also describe all the\n latest versions or all the default versions of all the launch templates in your\n account.
", + "smithy.api#examples": [ + { + "title": "To describe the versions for a launch template", + "documentation": "This example describes the versions for the specified launch template.", + "input": { + "LaunchTemplateId": "068f72b72934aff71" + }, + "output": { + "LaunchTemplateVersions": [ + { + "LaunchTemplateId": "lt-068f72b72934aff71", + "LaunchTemplateName": "Webservers", + "VersionNumber": 2, + "CreatedBy": "arn:aws:iam::123456789102:root", + "LaunchTemplateData": { + "KeyName": "kp-us-east", + "ImageId": "ami-6057e21a", + "InstanceType": "t2.medium", + "NetworkInterfaces": [ + { + "SubnetId": "subnet-1a2b3c4d", + "DeviceIndex": 0, + "Groups": [ + "sg-7c227019" + ] + } + ] + }, + "DefaultVersion": false, + "CreateTime": "2017-11-20T13:12:32.000Z" + }, + { + "LaunchTemplateId": "lt-068f72b72934aff71", + "LaunchTemplateName": "Webservers", + "VersionNumber": 1, + "CreatedBy": "arn:aws:iam::123456789102:root", + "LaunchTemplateData": { + "UserData": "", + "KeyName": "kp-us-east", + "ImageId": "ami-aabbcc11", + "InstanceType": "t2.medium", + "NetworkInterfaces": [ + { + "SubnetId": "subnet-7b16de0c", + "DeviceIndex": 0, + "DeleteOnTermination": false, + "Groups": [ + "sg-7c227019" + ], + "AssociatePublicIpAddress": true + } + ] + }, + "DefaultVersion": true, + "CreateTime": "2017-11-20T12:52:33.000Z" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -31543,6 +32466,29 @@ }, "traits": { "smithy.api#documentation": "Describes one or more launch templates.
", + "smithy.api#examples": [ + { + "title": "To describe a launch template", + "documentation": "This example describes the specified launch template.", + "input": { + "LaunchTemplateIds": [ + "lt-01238c059e3466abc" + ] + }, + "output": { + "LaunchTemplates": [ + { + "LatestVersionNumber": 1, + "LaunchTemplateName": "my-template", + "LaunchTemplateId": "lt-01238c059e3466abc", + "CreatedBy": "arn:aws:iam::123456789012:root", + "CreateTime": "2018-01-16T04:32:57.000Z", + "DefaultVersionNumber": 1 + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -32248,6 +33194,20 @@ }, "traits": { "smithy.api#documentation": "This action is deprecated.
\nDescribes your Elastic IP addresses that are being moved from or being restored to the EC2-Classic platform. \n This request does not return information about any other Elastic IP addresses in your account.
", + "smithy.api#examples": [ + { + "title": "To describe your moving addresses", + "documentation": "This example describes all of your moving Elastic IP addresses.", + "output": { + "MovingAddressStatuses": [ + { + "PublicIp": "198.51.100.0", + "MoveStatus": "movingToVpc" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -32352,6 +33312,41 @@ }, "traits": { "smithy.api#documentation": "Describes one or more of your NAT gateways.
", + "smithy.api#examples": [ + { + "title": "To describe a NAT gateway", + "documentation": "This example describes the NAT gateway for the specified VPC.", + "input": { + "Filter": [ + { + "Name": "vpc-id", + "Values": [ + "vpc-1a2b3c4d" + ] + } + ] + }, + "output": { + "NatGateways": [ + { + "NatGatewayAddresses": [ + { + "PublicIp": "198.11.222.333", + "NetworkInterfaceId": "eni-9dec76cd", + "AllocationId": "eipalloc-89c620ec", + "PrivateIp": "10.0.0.149" + } + ], + "VpcId": "vpc-1a2b3c4d", + "State": "available", + "NatGatewayId": "nat-05dba92075d71c408", + "SubnetId": "subnet-847e4dc2", + "CreateTime": "2015-12-01T12:26:55.983Z" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -32524,6 +33519,50 @@ }, "traits": { "smithy.api#documentation": "Describes one or more of your network ACLs.
\nFor more information, see Network ACLs in the\n\t\t\t\tAmazon VPC User Guide.
", + "smithy.api#examples": [ + { + "title": "To describe a network ACL", + "documentation": "This example describes the specified network ACL.", + "input": { + "NetworkAclIds": [ + "acl-5fb85d36" + ] + }, + "output": { + "NetworkAcls": [ + { + "Associations": [ + { + "SubnetId": "subnet-65ea5f08", + "NetworkAclId": "acl-9aeb5ef7", + "NetworkAclAssociationId": "aclassoc-66ea5f0b" + } + ], + "NetworkAclId": "acl-5fb85d36", + "VpcId": "vpc-a01106c2", + "Tags": [], + "Entries": [ + { + "CidrBlock": "0.0.0.0/0", + "RuleNumber": 32767, + "Protocol": "-1", + "Egress": true, + "RuleAction": "deny" + }, + { + "CidrBlock": "0.0.0.0/0", + "RuleNumber": 32767, + "Protocol": "-1", + "Egress": false, + "RuleAction": "deny" + } + ], + "IsDefault": false + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -33190,6 +34229,70 @@ }, "traits": { "smithy.api#documentation": "Describes one or more of your network interfaces.
", + "smithy.api#examples": [ + { + "title": "To describe a network interface", + "documentation": "", + "input": { + "NetworkInterfaceIds": [ + "eni-e5aa89a3" + ] + }, + "output": { + "NetworkInterfaces": [ + { + "Status": "in-use", + "MacAddress": "02:2f:8f:b0:cf:75", + "SourceDestCheck": true, + "VpcId": "vpc-a01106c2", + "Description": "my network interface", + "Association": { + "PublicIp": "203.0.113.12", + "AssociationId": "eipassoc-0fbb766a", + "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com", + "IpOwnerId": "123456789012" + }, + "NetworkInterfaceId": "eni-e5aa89a3", + "PrivateIpAddresses": [ + { + "PrivateDnsName": "ip-10-0-1-17.ec2.internal", + "Association": { + "PublicIp": "203.0.113.12", + "AssociationId": "eipassoc-0fbb766a", + "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com", + "IpOwnerId": "123456789012" + }, + "Primary": true, + "PrivateIpAddress": "10.0.1.17" + } + ], + "RequesterManaged": false, + "PrivateDnsName": "ip-10-0-1-17.ec2.internal", + "AvailabilityZone": "us-east-1d", + "Attachment": { + "Status": "attached", + "DeviceIndex": 1, + "AttachTime": "2013-11-30T23:36:42.000Z", + "InstanceId": "i-1234567890abcdef0", + "DeleteOnTermination": false, + "AttachmentId": "eni-attach-66c4350a", + "InstanceOwnerId": "123456789012" + }, + "Groups": [ + { + "GroupName": "default", + "GroupId": "sg-8637d3e3" + } + ], + "SubnetId": "subnet-b61f49f0", + "OwnerId": "123456789012", + "TagSet": [], + "PrivateIpAddress": "10.0.1.17" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -33636,7 +34739,61 @@ "target": "com.amazonaws.ec2#DescribeRegionsResult" }, "traits": { - "smithy.api#documentation": "Describes the Regions that are enabled for your account, or all Regions.
\nFor a list of the Regions supported by Amazon EC2, see \n Amazon Elastic Compute Cloud endpoints and quotas.
\nFor information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
" + "smithy.api#documentation": "Describes the Regions that are enabled for your account, or all Regions.
\nFor a list of the Regions supported by Amazon EC2, see \n Amazon Elastic Compute Cloud endpoints and quotas.
\nFor information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
", + "smithy.api#examples": [ + { + "title": "To describe your regions", + "documentation": "This example describes all the regions that are available to you.", + "output": { + "Regions": [ + { + "Endpoint": "ec2.ap-south-1.amazonaws.com", + "RegionName": "ap-south-1" + }, + { + "Endpoint": "ec2.eu-west-1.amazonaws.com", + "RegionName": "eu-west-1" + }, + { + "Endpoint": "ec2.ap-southeast-1.amazonaws.com", + "RegionName": "ap-southeast-1" + }, + { + "Endpoint": "ec2.ap-southeast-2.amazonaws.com", + "RegionName": "ap-southeast-2" + }, + { + "Endpoint": "ec2.eu-central-1.amazonaws.com", + "RegionName": "eu-central-1" + }, + { + "Endpoint": "ec2.ap-northeast-2.amazonaws.com", + "RegionName": "ap-northeast-2" + }, + { + "Endpoint": "ec2.ap-northeast-1.amazonaws.com", + "RegionName": "ap-northeast-1" + }, + { + "Endpoint": "ec2.us-east-1.amazonaws.com", + "RegionName": "us-east-1" + }, + { + "Endpoint": "ec2.sa-east-1.amazonaws.com", + "RegionName": "sa-east-1" + }, + { + "Endpoint": "ec2.us-west-1.amazonaws.com", + "RegionName": "us-west-1" + }, + { + "Endpoint": "ec2.us-west-2.amazonaws.com", + "RegionName": "us-west-2" + } + ] + } + } + ] } }, "com.amazonaws.ec2#DescribeRegionsRequest": { @@ -34177,6 +35334,41 @@ }, "traits": { "smithy.api#documentation": "Describes one or more of your route tables.
\nEach subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
\nFor more information, see Route tables in the\n\t\t\t\tAmazon VPC User Guide.
", + "smithy.api#examples": [ + { + "title": "To describe a route table", + "documentation": "This example describes the specified route table.", + "input": { + "RouteTableIds": [ + "rtb-1f382e7d" + ] + }, + "output": { + "RouteTables": [ + { + "Associations": [ + { + "RouteTableAssociationId": "rtbassoc-d8ccddba", + "Main": true, + "RouteTableId": "rtb-1f382e7d" + } + ], + "RouteTableId": "rtb-1f382e7d", + "VpcId": "vpc-a01106c2", + "PropagatingVgws": [], + "Tags": [], + "Routes": [ + { + "GatewayId": "local", + "DestinationCidrBlock": "10.0.0.0/16", + "State": "active" + } + ] + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -34492,7 +35684,27 @@ "target": "com.amazonaws.ec2#DescribeSecurityGroupReferencesResult" }, "traits": { - "smithy.api#documentation": "Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.
" + "smithy.api#documentation": "Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.
", + "smithy.api#examples": [ + { + "title": "To describe security group references", + "documentation": "This example describes the security group references for the specified security group.", + "input": { + "GroupId": [ + "sg-903004f8" + ] + }, + "output": { + "SecurityGroupReferenceSet": [ + { + "ReferencingVpcId": "vpc-1a2b3c4d", + "GroupId": "sg-903004f8", + "VpcPeeringConnectionId": "pcx-b04deed9" + } + ] + } + } + ] } }, "com.amazonaws.ec2#DescribeSecurityGroupReferencesRequest": { @@ -34641,6 +35853,18 @@ }, "traits": { "smithy.api#documentation": "Describes the specified security groups or all of your security groups.
", + "smithy.api#examples": [ + { + "title": "To describe a security group", + "documentation": "This example describes the specified security group.", + "input": { + "GroupIds": [ + "sg-903004f8" + ] + }, + "output": {} + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -34771,7 +35995,21 @@ "target": "com.amazonaws.ec2#DescribeSnapshotAttributeResult" }, "traits": { - "smithy.api#documentation": "Describes the specified attribute of the specified snapshot. You can specify only one\n attribute at a time.
\nFor more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Describes the specified attribute of the specified snapshot. You can specify only one\n attribute at a time.
\nFor more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To describe snapshot attributes", + "documentation": "This example describes the ``createVolumePermission`` attribute on a snapshot with the snapshot ID of ``snap-066877671789bd71b``.", + "input": { + "SnapshotId": "snap-066877671789bd71b", + "Attribute": "createVolumePermission" + }, + "output": { + "SnapshotId": "snap-066877671789bd71b", + "CreateVolumePermissions": [] + } + } + ] } }, "com.amazonaws.ec2#DescribeSnapshotAttributeRequest": { @@ -34930,6 +36168,32 @@ }, "traits": { "smithy.api#documentation": "Describes the specified EBS snapshots available to you or all of the EBS snapshots\n available to you.
\nThe snapshots available to you include public snapshots, private snapshots that you own,\n and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume\n permissions.
\nThe create volume permissions fall into the following categories:
\n\n public: The owner of the snapshot granted create volume\n permissions for the snapshot to the all group. All Amazon Web Services accounts have create\n volume permissions for these snapshots.
\n explicit: The owner of the snapshot granted create volume\n permissions to a specific Amazon Web Services account.
\n\n implicit: An Amazon Web Services account has implicit create volume permissions\n for all snapshots it owns.
\nThe list of snapshots returned can be filtered by specifying snapshot IDs, snapshot\n owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, \n Amazon EC2 returns all snapshots for which you have create volume permissions.
\nIf you specify one or more snapshot IDs, only snapshots that have the specified IDs are\n returned. If you specify an invalid snapshot ID, an error is returned. If you specify a\n snapshot ID for which you do not have access, it is not included in the returned\n results.
\nIf you specify one or more snapshot owners using the OwnerIds option, only\n snapshots from the specified owners and for which you have access are returned. The results\n can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots\n owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions\n for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots),\n self for snapshots for which you own or have explicit permissions, or\n all for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the\n list more manageable. For more information, see Pagination.
\nTo get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
\nFor more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To describe a snapshot", + "documentation": "This example describes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``.", + "input": { + "SnapshotIds": [ + "snap-1234567890abcdef0" + ] + }, + "output": { + "Snapshots": [ + { + "Description": "This is my snapshot.", + "VolumeId": "vol-049df61146c4d7901", + "State": "completed", + "VolumeSize": 8, + "Progress": "100%", + "StartTime": "2014-02-28T21:28:32.000Z", + "SnapshotId": "snap-1234567890abcdef0", + "OwnerId": "012345678910" + } + ], + "NextToken": "" + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -35058,7 +36322,21 @@ "target": "com.amazonaws.ec2#DescribeSpotDatafeedSubscriptionResult" }, "traits": { - "smithy.api#documentation": "Describes the data feed for Spot Instances. For more information, see Spot\n Instance data feed in the Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "Describes the data feed for Spot Instances. For more information, see Spot\n Instance data feed in the Amazon EC2 User Guide for Linux Instances.
", + "smithy.api#examples": [ + { + "title": "To describe the datafeed for your AWS account", + "documentation": "This example describes the Spot Instance datafeed subscription for your AWS account.", + "output": { + "SpotDatafeedSubscription": { + "OwnerId": "123456789012", + "Prefix": "spotdata", + "Bucket": "my-s3-bucket", + "State": "Active" + } + } + } + ] } }, "com.amazonaws.ec2#DescribeSpotDatafeedSubscriptionRequest": { @@ -35345,6 +36623,60 @@ }, "traits": { "smithy.api#documentation": "Describes your Spot Fleet requests.
\nSpot Fleet requests are deleted 48 hours after they are canceled and their instances\n are terminated.
", + "smithy.api#examples": [ + { + "title": "To describe a Spot fleet request", + "documentation": "This example describes the specified Spot fleet request.", + "input": { + "SpotFleetRequestIds": [ + "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + ] + }, + "output": { + "SpotFleetRequestConfigs": [ + { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "SpotFleetRequestConfig": { + "TargetCapacity": 20, + "LaunchSpecifications": [ + { + "EbsOptimized": false, + "NetworkInterfaces": [ + { + "SubnetId": "subnet-a61dafcf", + "DeviceIndex": 0, + "DeleteOnTermination": false, + "AssociatePublicIpAddress": true, + "SecondaryPrivateIpAddressCount": 0 + } + ], + "InstanceType": "cc2.8xlarge", + "ImageId": "ami-1a2b3c4d" + }, + { + "EbsOptimized": false, + "NetworkInterfaces": [ + { + "SubnetId": "subnet-a61dafcf", + "DeviceIndex": 0, + "DeleteOnTermination": false, + "AssociatePublicIpAddress": true, + "SecondaryPrivateIpAddressCount": 0 + } + ], + "InstanceType": "r3.8xlarge", + "ImageId": "ami-1a2b3c4d" + } + ], + "SpotPrice": "0.05", + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role" + }, + "SpotFleetRequestState": "active" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -35433,6 +36765,58 @@ }, "traits": { "smithy.api#documentation": "Describes the specified Spot Instance requests.
\nYou 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.
We recommend that you set MaxResults to a value between 5 and 1000 to\n limit the number of items returned. This paginates the output, which makes the list\n more manageable and returns the items faster. If the list of items exceeds your\n MaxResults value, then that number of items is returned along with a\n NextToken value that can be passed to a subsequent\n DescribeSpotInstanceRequests request to retrieve the remaining\n items.
Spot Instance requests are deleted four hours after they are canceled and their instances are\n terminated.
", + "smithy.api#examples": [ + { + "title": "To describe a Spot Instance request", + "documentation": "This example describes the specified Spot Instance request.", + "input": { + "SpotInstanceRequestIds": [ + "sir-08b93456" + ] + }, + "output": { + "SpotInstanceRequests": [ + { + "Status": { + "UpdateTime": "2014-04-30T18:16:21.000Z", + "Code": "fulfilled", + "Message": "Your Spot request is fulfilled." + }, + "ProductDescription": "Linux/UNIX", + "InstanceId": "i-1234567890abcdef0", + "SpotInstanceRequestId": "sir-08b93456", + "State": "active", + "LaunchedAvailabilityZone": "us-west-1b", + "LaunchSpecification": { + "ImageId": "ami-7aba833f", + "KeyName": "my-key-pair", + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "DeleteOnTermination": true, + "VolumeType": "standard", + "VolumeSize": 8 + } + } + ], + "EbsOptimized": false, + "SecurityGroups": [ + { + "GroupName": "my-security-group", + "GroupId": "sg-e38f24a7" + } + ], + "InstanceType": "m1.small" + }, + "Type": "one-time", + "CreateTime": "2014-04-30T18:14:55.000Z", + "SpotPrice": "0.010000" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -35599,6 +36983,40 @@ }, "traits": { "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.
\nWhen 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#examples": [ + { + "title": "To describe Spot price history for Linux/UNIX (Amazon VPC)", + "documentation": "This example returns the Spot Price history for m1.xlarge, Linux/UNIX (Amazon VPC) instances for a particular day in January.", + "input": { + "StartTime": "2014-01-06T07:08:09.05Z", + "EndTime": "2014-01-06T08:09:10.05Z", + "InstanceTypes": [ + "m1.xlarge" + ], + "ProductDescriptions": [ + "Linux/UNIX (Amazon VPC)" + ] + }, + "output": { + "SpotPriceHistory": [ + { + "Timestamp": "2014-01-06T04:32:53.000Z", + "ProductDescription": "Linux/UNIX (Amazon VPC)", + "InstanceType": "m1.xlarge", + "SpotPrice": "0.080000", + "AvailabilityZone": "us-west-1a" + }, + { + "Timestamp": "2014-01-05T11:28:26.000Z", + "ProductDescription": "Linux/UNIX (Amazon VPC)", + "InstanceType": "m1.xlarge", + "SpotPrice": "0.080000", + "AvailabilityZone": "us-west-1c" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -35956,6 +37374,36 @@ }, "traits": { "smithy.api#documentation": "Describes one or more of your subnets.
\nFor more information, see Subnets in the\n\t\t\t\tAmazon VPC User Guide.
", + "smithy.api#examples": [ + { + "title": "To describe the subnets for a VPC", + "documentation": "This example describes the subnets for the specified VPC.", + "input": { + "Filters": [ + { + "Name": "vpc-id", + "Values": [ + "vpc-a01106c2" + ] + } + ] + }, + "output": { + "Subnets": [ + { + "VpcId": "vpc-a01106c2", + "CidrBlock": "10.0.1.0/24", + "MapPublicIpOnLaunch": false, + "DefaultForAz": false, + "State": "available", + "AvailabilityZone": "us-east-1c", + "SubnetId": "subnet-9d4a7b6c", + "AvailableIpAddressCount": 251 + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -36071,6 +37519,38 @@ }, "traits": { "smithy.api#documentation": "Describes the specified tags for your EC2 resources.
\nFor more information about tags, see Tag your Amazon EC2 resources in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To describe the tags for a single resource", + "documentation": "This example describes the tags for the specified instance.", + "input": { + "Filters": [ + { + "Name": "resource-id", + "Values": [ + "i-1234567890abcdef8" + ] + } + ] + }, + "output": { + "Tags": [ + { + "ResourceType": "instance", + "ResourceId": "i-1234567890abcdef8", + "Value": "test", + "Key": "Stack" + }, + { + "ResourceType": "instance", + "ResourceId": "i-1234567890abcdef8", + "Value": "Beta Server", + "Key": "Name" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -37857,7 +39337,23 @@ "target": "com.amazonaws.ec2#DescribeVolumeAttributeResult" }, "traits": { - "smithy.api#documentation": "Describes the specified attribute of the specified volume. You can specify only one\n attribute at a time.
\nFor more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Describes the specified attribute of the specified volume. You can specify only one\n attribute at a time.
\nFor more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To describe a volume attribute", + "documentation": "This example describes the ``autoEnableIo`` attribute of the volume with the ID ``vol-049df61146c4d7901``.", + "input": { + "VolumeId": "vol-049df61146c4d7901", + "Attribute": "autoEnableIO" + }, + "output": { + "AutoEnableIO": { + "Value": false + }, + "VolumeId": "vol-049df61146c4d7901" + } + } + ] } }, "com.amazonaws.ec2#DescribeVolumeAttributeRequest": { @@ -37936,6 +39432,40 @@ }, "traits": { "smithy.api#documentation": "Describes the status of the specified volumes. Volume status provides the result of the\n checks performed on your volumes to determine events that can impair the performance of your\n volumes. The performance of a volume can be affected if an issue occurs on the volume's\n underlying host. If the volume's underlying host experiences a power outage or system issue,\n after the system is restored, there could be data inconsistencies on the volume. Volume events\n notify you if this occurs. Volume actions notify you if any action needs to be taken in\n response to the event.
\nThe DescribeVolumeStatus operation provides the following information about\n the specified volumes:
\n Status: Reflects the current status of the volume. The possible\n values are ok, impaired , warning, or\n insufficient-data. If all checks pass, the overall status of the volume is\n ok. If the check fails, the overall status is impaired. If the\n status is insufficient-data, then the checks might still be taking place on your\n volume at the time. We recommend that you retry the request. For more information about volume\n status, see Monitor the status of your volumes in the\n Amazon Elastic Compute Cloud User Guide.
\n Events: Reflect the cause of a volume status and might require you to\n take action. For example, if your volume returns an impaired status, then the\n volume event might be potential-data-inconsistency. This means that your volume\n has been affected by an issue with the underlying host, has all I/O operations disabled, and\n might have inconsistent data.
\n Actions: Reflect the actions you might have to take in response to an\n event. For example, if the status of the volume is impaired and the volume event\n shows potential-data-inconsistency, then the action shows\n enable-volume-io. This means that you may want to enable the I/O operations for\n the volume by calling the EnableVolumeIO action and then check the volume\n for data consistency.
Volume status is based on the volume status checks, and does not reflect the volume state.\n Therefore, volume status does not indicate volumes in the error state (for\n example, when a volume is incapable of accepting I/O.)
Describes the specified EBS volumes or all of your EBS volumes.
\nIf you are describing a long list of volumes, we recommend that you paginate the output to make the list\n more manageable. For more information, see Pagination.
\nFor more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To describe all volumes", + "documentation": "This example describes all of your volumes in the default region.", + "output": { + "Volumes": [ + { + "AvailabilityZone": "us-east-1a", + "Attachments": [ + { + "AttachTime": "2013-12-18T22:35:00.000Z", + "InstanceId": "i-1234567890abcdef0", + "VolumeId": "vol-049df61146c4d7901", + "State": "attached", + "DeleteOnTermination": true, + "Device": "/dev/sda1" + } + ], + "VolumeType": "standard", + "VolumeId": "vol-049df61146c4d7901", + "State": "in-use", + "SnapshotId": "snap-1234567890abcdef0", + "CreateTime": "2013-12-18T22:35:00.084Z", + "Size": 8 + } + ], + "NextToken": "" + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -38277,7 +39837,23 @@ "target": "com.amazonaws.ec2#DescribeVpcAttributeResult" }, "traits": { - "smithy.api#documentation": "Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
" + "smithy.api#documentation": "Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
", + "smithy.api#examples": [ + { + "title": "To describe the enableDnsSupport attribute", + "documentation": "This example describes the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.", + "input": { + "VpcId": "vpc-a01106c2", + "Attribute": "enableDnsSupport" + }, + "output": { + "VpcId": "vpc-a01106c2", + "EnableDnsSupport": { + "Value": true + } + } + } + ] } }, "com.amazonaws.ec2#DescribeVpcAttributeRequest": { @@ -39170,6 +40746,35 @@ }, "traits": { "smithy.api#documentation": "Describes one or more of your VPCs.
", + "smithy.api#examples": [ + { + "title": "To describe a VPC", + "documentation": "This example describes the specified VPC.", + "input": { + "VpcIds": [ + "vpc-a01106c2" + ] + }, + "output": { + "Vpcs": [ + { + "VpcId": "vpc-a01106c2", + "InstanceTenancy": "default", + "Tags": [ + { + "Value": "MyVPC", + "Key": "Name" + } + ], + "State": "available", + "DhcpOptionsId": "dopt-7a8b9c2d", + "CidrBlock": "10.0.0.0/16", + "IsDefault": false + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -39817,7 +41422,23 @@ "target": "com.amazonaws.ec2#VolumeAttachment" }, "traits": { - "smithy.api#documentation": "Detaches an EBS volume from an instance. Make sure to unmount any file systems on the\n device within your operating system before detaching the volume. Failure to do so can result\n in the volume becoming stuck in the busy state while detaching. If this happens,\n detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot\n the instance, or all three. If an EBS volume is the root device of an instance, it can't be\n detached while the instance is running. To detach the root volume, stop the instance\n first.
When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the\n product code is no longer associated with the instance.
\nFor more information, see Detach an Amazon EBS volume in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Detaches an EBS volume from an instance. Make sure to unmount any file systems on the\n device within your operating system before detaching the volume. Failure to do so can result\n in the volume becoming stuck in the busy state while detaching. If this happens,\n detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot\n the instance, or all three. If an EBS volume is the root device of an instance, it can't be\n detached while the instance is running. To detach the root volume, stop the instance\n first.
When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the\n product code is no longer associated with the instance.
\nFor more information, see Detach an Amazon EBS volume in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To detach a volume from an instance", + "documentation": "This example detaches the volume (``vol-049df61146c4d7901``) from the instance it is attached to.", + "input": { + "VolumeId": "vol-1234567890abcdef0" + }, + "output": { + "AttachTime": "2014-02-27T19:23:06.000Z", + "InstanceId": "i-1234567890abcdef0", + "VolumeId": "vol-049df61146c4d7901", + "State": "detaching", + "Device": "/dev/sdb" + } + } + ] } }, "com.amazonaws.ec2#DetachVolumeRequest": { @@ -40882,7 +42503,17 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Disables a virtual private gateway (VGW) from propagating routes to a specified route\n table of a VPC.
" + "smithy.api#documentation": "Disables a virtual private gateway (VGW) from propagating routes to a specified route\n table of a VPC.
", + "smithy.api#examples": [ + { + "title": "To disable route propagation", + "documentation": "This example disables the specified virtual private gateway from propagating static routes to the specified route table.", + "input": { + "RouteTableId": "rtb-22574640", + "GatewayId": "vgw-9a4cacf3" + } + } + ] } }, "com.amazonaws.ec2#DisableVgwRoutePropagationRequest": { @@ -41030,7 +42661,16 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Disassociates an Elastic IP address from the instance or network interface it's associated with.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
" + "smithy.api#documentation": "Disassociates an Elastic IP address from the instance or network interface it's associated with.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
", + "smithy.api#examples": [ + { + "title": "To disassociate an Elastic IP address", + "documentation": "This example disassociates an Elastic IP address from an instance.", + "input": { + "AssociationId": "eipassoc-2bebb745" + } + } + ] } }, "com.amazonaws.ec2#DisassociateAddressRequest": { @@ -41202,7 +42842,27 @@ "target": "com.amazonaws.ec2#DisassociateIamInstanceProfileResult" }, "traits": { - "smithy.api#documentation": "Disassociates an IAM instance profile from a running or stopped instance.
\nUse DescribeIamInstanceProfileAssociations to get the association\n ID.
" + "smithy.api#documentation": "Disassociates an IAM instance profile from a running or stopped instance.
\nUse DescribeIamInstanceProfileAssociations to get the association\n ID.
", + "smithy.api#examples": [ + { + "title": "To disassociate an IAM instance profile", + "documentation": "This example disassociates the specified IAM instance profile from an instance.", + "input": { + "AssociationId": "iip-assoc-05020b59952902f5f" + }, + "output": { + "IamInstanceProfileAssociation": { + "InstanceId": "i-123456789abcde123", + "State": "disassociating", + "AssociationId": "iip-assoc-05020b59952902f5f", + "IamInstanceProfile": { + "Id": "AIPAI5IVIHMFFYY2DKV5Y", + "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role" + } + } + } + } + ] } }, "com.amazonaws.ec2#DisassociateIamInstanceProfileRequest": { @@ -42367,7 +44027,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "The ARN of the Outpost on which the snapshot is stored.
\nThis parameter is only supported on BlockDeviceMapping objects called by\n \n CreateImage.
The ARN of the Outpost on which the snapshot is stored.
\nThis parameter is not supported when using CreateImage.
", "smithy.api#xmlName": "outpostArn" } }, @@ -44129,7 +45789,17 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Enables a virtual private gateway (VGW) to propagate routes to the specified route\n table of a VPC.
" + "smithy.api#documentation": "Enables a virtual private gateway (VGW) to propagate routes to the specified route\n table of a VPC.
", + "smithy.api#examples": [ + { + "title": "To enable route propagation", + "documentation": "This example enables the specified virtual private gateway to propagate static routes to the specified route table.", + "input": { + "RouteTableId": "rtb-22574640", + "GatewayId": "vgw-9a4cacf3" + } + } + ] } }, "com.amazonaws.ec2#EnableVgwRoutePropagationRequest": { @@ -48221,7 +49891,21 @@ "target": "com.amazonaws.ec2#GetConsoleOutputResult" }, "traits": { - "smithy.api#documentation": "Gets the console output for the specified instance. For Linux instances, the instance\n console output displays the exact console output that would normally be displayed on a\n physical monitor attached to a computer. For Windows instances, the instance console\n output includes the last three system event log errors.
\nBy default, the console output returns buffered information that was posted shortly\n after an instance transition state (start, stop, reboot, or terminate). This information\n is available for at least one hour after the most recent post. Only the most recent 64\n KB of console output is available.
\nYou can optionally retrieve the latest serial console output at any time during the\n instance lifecycle. This option is supported on instance types that use the Nitro\n hypervisor.
\nFor more information, see Instance\n console output in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Gets the console output for the specified instance. For Linux instances, the instance\n console output displays the exact console output that would normally be displayed on a\n physical monitor attached to a computer. For Windows instances, the instance console\n output includes the last three system event log errors.
\nBy default, the console output returns buffered information that was posted shortly\n after an instance transition state (start, stop, reboot, or terminate). This information\n is available for at least one hour after the most recent post. Only the most recent 64\n KB of console output is available.
\nYou can optionally retrieve the latest serial console output at any time during the\n instance lifecycle. This option is supported on instance types that use the Nitro\n hypervisor.
\nFor more information, see Instance\n console output in the Amazon EC2 User Guide.
", + "smithy.api#examples": [ + { + "title": "To get the console output", + "documentation": "This example gets the console output for the specified instance.", + "input": { + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + "InstanceId": "i-1234567890abcdef0", + "Output": "...", + "Timestamp": "2018-05-25T21:23:53.000Z" + } + } + ] } }, "com.amazonaws.ec2#GetConsoleOutputRequest": { @@ -49514,7 +51198,66 @@ "target": "com.amazonaws.ec2#GetLaunchTemplateDataResult" }, "traits": { - "smithy.api#documentation": "Retrieves the configuration data of the specified instance. You can use this data to\n create a launch template.
\nThis action calls on other describe actions to get instance information. Depending on\n your instance configuration, you may need to allow the following actions in your IAM\n policy: DescribeSpotInstanceRequests,\n DescribeInstanceCreditSpecifications, DescribeVolumes,\n DescribeInstanceAttribute, and DescribeElasticGpus. Or,\n you can allow describe* depending on your instance requirements.
Retrieves the configuration data of the specified instance. You can use this data to\n create a launch template.
\nThis action calls on other describe actions to get instance information. Depending on\n your instance configuration, you may need to allow the following actions in your IAM\n policy: DescribeSpotInstanceRequests,\n DescribeInstanceCreditSpecifications, DescribeVolumes,\n DescribeInstanceAttribute, and DescribeElasticGpus. Or,\n you can allow describe* depending on your instance requirements.
The IPv6 address.
", "smithy.api#xmlName": "ipv6Address" } + }, + "IsPrimaryIpv6": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsPrimaryIpv6", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. \n For more information, see RunInstances.
", + "smithy.api#xmlName": "isPrimaryIpv6" + } } }, "traits": { @@ -56815,6 +58568,14 @@ "smithy.api#default": 0, "smithy.api#documentation": "The number of IPv6 delegated prefixes to be automatically assigned to the network interface. \n You cannot use this option if you use the Ipv6Prefix option.
The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances.
" + } } }, "traits": { @@ -61700,6 +63461,96 @@ "traits": { "smithy.api#enumValue": "c7gn.16xlarge" } + }, + "p5_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p5.48xlarge" + } + }, + "m7i_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.large" + } + }, + "m7i_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.xlarge" + } + }, + "m7i_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.2xlarge" + } + }, + "m7i_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.4xlarge" + } + }, + "m7i_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.8xlarge" + } + }, + "m7i_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.12xlarge" + } + }, + "m7i_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.16xlarge" + } + }, + "m7i_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.24xlarge" + } + }, + "m7i_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i.48xlarge" + } + }, + "m7i_flex_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i-flex.large" + } + }, + "m7i_flex_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i-flex.xlarge" + } + }, + "m7i_flex_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i-flex.2xlarge" + } + }, + "m7i_flex_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i-flex.4xlarge" + } + }, + "m7i_flex_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7i-flex.8xlarge" + } } } }, @@ -66403,6 +68254,16 @@ "smithy.api#documentation": "The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network\n interface.
", "smithy.api#xmlName": "ipv6PrefixCount" } + }, + "PrimaryIpv6": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PrimaryIpv6", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances.
", + "smithy.api#xmlName": "primaryIpv6" + } } }, "traits": { @@ -66555,6 +68416,14 @@ "smithy.api#default": 0, "smithy.api#documentation": "The number of IPv6 prefixes to be automatically assigned to the network interface. You\n cannot use this option if you use the Ipv6Prefix option.
The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances.
" + } } }, "traits": { @@ -69737,7 +71606,24 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.
\nTo specify the attribute, you can use the Attribute parameter, or one of the following parameters: \n Description, ImdsSupport, or LaunchPermission.
Images with an Amazon Web Services Marketplace product code cannot be made public.
\nTo enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance \n and create an AMI from the instance.
" + "smithy.api#documentation": "Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.
\nTo specify the attribute, you can use the Attribute parameter, or one of the following parameters: \n Description, ImdsSupport, or LaunchPermission.
Images with an Amazon Web Services Marketplace product code cannot be made public.
\nTo enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance \n and create an AMI from the instance.
", + "smithy.api#examples": [ + { + "title": "To make an AMI public", + "documentation": "This example makes the specified AMI public.", + "input": { + "ImageId": "ami-5731123e", + "LaunchPermission": { + "Add": [ + { + "Group": "all" + } + ] + } + }, + "output": {} + } + ] } }, "com.amazonaws.ec2#ModifyImageAttributeRequest": { @@ -70931,7 +72817,27 @@ "target": "com.amazonaws.ec2#ModifyLaunchTemplateResult" }, "traits": { - "smithy.api#documentation": "Modifies a launch template. You can specify which version of the launch template to\n set as the default version. When launching an instance, the default version applies when\n a launch template version is not specified.
" + "smithy.api#documentation": "Modifies a launch template. You can specify which version of the launch template to\n set as the default version. When launching an instance, the default version applies when\n a launch template version is not specified.
", + "smithy.api#examples": [ + { + "title": "To change the default version of a launch template", + "documentation": "This example specifies version 2 as the default version of the specified launch template.", + "input": { + "LaunchTemplateId": "lt-0abcd290751193123", + "DefaultVersion": "2" + }, + "output": { + "LaunchTemplate": { + "LatestVersionNumber": 2, + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "WebServers", + "DefaultVersionNumber": 2, + "CreatedBy": "arn:aws:iam::123456789012:root", + "CreateTime": "2017-12-01T13:35:46.000Z" + } + } + } + ] } }, "com.amazonaws.ec2#ModifyLaunchTemplateRequest": { @@ -71226,6 +73132,14 @@ "traits": { "smithy.api#documentation": "Updates the ENA Express configuration for the network interface that’s attached to the\n\t\t\tinstance.
" } + }, + "EnablePrimaryIpv6": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have\n the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA\n address associated with an ENI that you have enabled to use a primary IPv6 address. Use\n this option if the instance that this ENI will be attached to relies on its IPv6 address\n not changing. Amazon Web Services will automatically assign an IPv6 address associated\n with the ENI attached to your instance to be the primary IPv6 address. Once you enable\n an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6\n GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6\n address until the instance is terminated or the network interface is detached. If you\n have multiple IPv6 addresses associated with an ENI attached to your instance and you\n enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI\n becomes the primary IPv6 address.
" + } } }, "traits": { @@ -71445,7 +73359,22 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Adds or removes permission settings for the specified snapshot. You may add or remove\n specified Amazon Web Services account IDs from a snapshot's list of create volume permissions, but you cannot\n do both in a single operation. If you need to both add and remove account IDs for a snapshot,\n you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.
\nEncrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made\n public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.
\nFor more information about modifying snapshot permissions, see Share a snapshot in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Adds or removes permission settings for the specified snapshot. You may add or remove\n specified Amazon Web Services account IDs from a snapshot's list of create volume permissions, but you cannot\n do both in a single operation. If you need to both add and remove account IDs for a snapshot,\n you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.
\nEncrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made\n public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.
\nFor more information about modifying snapshot permissions, see Share a snapshot in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To modify a snapshot attribute", + "documentation": "This example modifies snapshot ``snap-1234567890abcdef0`` to remove the create volume permission for a user with the account ID ``123456789012``. If the command succeeds, no output is returned.", + "input": { + "SnapshotId": "snap-1234567890abcdef0", + "Attribute": "createVolumePermission", + "OperationType": "remove", + "UserIds": [ + "123456789012" + ] + }, + "output": {} + } + ] } }, "com.amazonaws.ec2#ModifySnapshotAttributeRequest": { @@ -71670,7 +73599,19 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Modifies a subnet attribute. You can only modify one attribute at a time.
\nUse this action to modify subnets on Amazon Web Services Outposts.
\nTo modify a subnet on an Outpost rack, set both\n MapCustomerOwnedIpOnLaunch and\n CustomerOwnedIpv4Pool. These two parameters act as a single\n attribute.
To modify a subnet on an Outpost server, set either\n EnableLniAtDeviceIndex or\n DisableLniAtDeviceIndex.
For more information about Amazon Web Services Outposts, see the following:
\n\n Outpost servers\n
\n\n Outpost racks\n
\nModifies a subnet attribute. You can only modify one attribute at a time.
\nUse this action to modify subnets on Amazon Web Services Outposts.
\nTo modify a subnet on an Outpost rack, set both\n MapCustomerOwnedIpOnLaunch and\n CustomerOwnedIpv4Pool. These two parameters act as a single\n attribute.
To modify a subnet on an Outpost server, set either\n EnableLniAtDeviceIndex or\n DisableLniAtDeviceIndex.
For more information about Amazon Web Services Outposts, see the following:
\n\n Outpost servers\n
\n\n Outpost racks\n
\nThe number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.
" + "smithy.api#documentation": "The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.
\nFor sessions with Network Load Balancer (NLB) traffic mirror targets, the default PacketLength will be set to 8500. Valid values are 1-8500. Setting a PacketLength greater than 8500 will result in an error response.
Modifies a volume attribute.
\nBy default, all I/O operations for the volume are suspended when the data on the volume is\n determined to be potentially inconsistent, to prevent undetectable, latent data corruption.\n The I/O access to the volume can be resumed by first enabling I/O access and then checking the\n data consistency on your volume.
\nYou can change the default behavior to resume I/O operations. We recommend that you change\n this only for boot volumes or for volumes that are stateless or disposable.
" + "smithy.api#documentation": "Modifies a volume attribute.
\nBy default, all I/O operations for the volume are suspended when the data on the volume is\n determined to be potentially inconsistent, to prevent undetectable, latent data corruption.\n The I/O access to the volume can be resumed by first enabling I/O access and then checking the\n data consistency on your volume.
\nYou can change the default behavior to resume I/O operations. We recommend that you change\n this only for boot volumes or for volumes that are stateless or disposable.
", + "smithy.api#examples": [ + { + "title": "To modify a volume attribute", + "documentation": "This example sets the ``autoEnableIo`` attribute of the volume with the ID ``vol-1234567890abcdef0`` to ``true``. If the command succeeds, no output is returned.", + "input": { + "DryRun": true, + "VolumeId": "vol-1234567890abcdef0", + "AutoEnableIO": { + "Value": true + } + }, + "output": {} + } + ] } }, "com.amazonaws.ec2#ModifyVolumeAttributeRequest": { @@ -73119,7 +75074,19 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Modifies the specified attribute of the specified VPC.
" + "smithy.api#documentation": "Modifies the specified attribute of the specified VPC.
", + "smithy.api#examples": [ + { + "title": "To modify the enableDnsSupport attribute", + "documentation": "This example modifies the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for instances in the VPC to their corresponding IP addresses; otherwise, it does not.", + "input": { + "VpcId": "vpc-a01106c2", + "EnableDnsSupport": { + "Value": false + } + } + } + ] } }, "com.amazonaws.ec2#ModifyVpcAttributeRequest": { @@ -76273,6 +78240,16 @@ "smithy.api#documentation": "The IPv6 address.
", "smithy.api#xmlName": "ipv6Address" } + }, + "IsPrimaryIpv6": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsPrimaryIpv6", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see ModifyNetworkInterfaceAttribute.
", + "smithy.api#xmlName": "isPrimaryIpv6" + } } }, "traits": { @@ -80221,7 +82198,19 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Requests a reboot of the specified instances. This operation is asynchronous; it only\n queues a request to reboot the specified instances. The operation succeeds if the\n instances are valid and belong to you. Requests to reboot terminated instances are\n ignored.
\nIf an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a\n hard reboot.
\nFor more information about troubleshooting, see Troubleshoot an unreachable\n instance in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Requests a reboot of the specified instances. This operation is asynchronous; it only\n queues a request to reboot the specified instances. The operation succeeds if the\n instances are valid and belong to you. Requests to reboot terminated instances are\n ignored.
\nIf an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a\n hard reboot.
\nFor more information about troubleshooting, see Troubleshoot an unreachable\n instance in the Amazon EC2 User Guide.
", + "smithy.api#examples": [ + { + "title": "To reboot an EC2 instance", + "documentation": "This example reboots the specified EC2 instance.", + "input": { + "InstanceIds": [ + "i-1234567890abcdef5" + ] + }, + "output": {} + } + ] } }, "com.amazonaws.ec2#RebootInstancesRequest": { @@ -81076,7 +83065,16 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Releases the specified Elastic IP address.
\n[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).
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 Amazon Web Services account.
After you release an Elastic IP address, you might be able to recover it.\n For more information, see AllocateAddress.
" + "smithy.api#documentation": "Releases the specified Elastic IP address.
\n[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).
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 Amazon Web Services account.
After you release an Elastic IP address, you might be able to recover it.\n For more information, see AllocateAddress.
", + "smithy.api#examples": [ + { + "title": "To release an Elastic IP address", + "documentation": "This example releases the specified Elastic IP address.", + "input": { + "AllocationId": "eipalloc-64d5890a" + } + } + ] } }, "com.amazonaws.ec2#ReleaseAddressRequest": { @@ -82569,7 +84567,32 @@ "target": "com.amazonaws.ec2#RequestSpotInstancesResult" }, "traits": { - "smithy.api#documentation": "Creates a Spot Instance request.
\nFor more information, see Spot Instance requests in\n the Amazon EC2 User Guide for Linux Instances.
\nWe strongly discourage using the RequestSpotInstances API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide for Linux Instances.
\nCreates a Spot Instance request.
\nFor more information, see Spot Instance requests in\n the Amazon EC2 User Guide for Linux Instances.
\nWe strongly discourage using the RequestSpotInstances API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide for Linux Instances.
\nResets an attribute of an AMI to its default value.
" + "smithy.api#documentation": "Resets an attribute of an AMI to its default value.
", + "smithy.api#examples": [ + { + "title": "To reset the launchPermission attribute", + "documentation": "This example resets the launchPermission attribute for the specified AMI. By default, AMIs are private.", + "input": { + "Attribute": "launchPermission", + "ImageId": "ami-5731123e" + }, + "output": {} + } + ] } }, "com.amazonaws.ec2#ResetImageAttributeName": { @@ -84135,7 +86169,18 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Resets permission settings for the specified snapshot.
\nFor more information about modifying snapshot permissions, see Share a snapshot in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Resets permission settings for the specified snapshot.
\nFor more information about modifying snapshot permissions, see Share a snapshot in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#examples": [ + { + "title": "To reset a snapshot attribute", + "documentation": "This example resets the create volume permissions for snapshot ``snap-1234567890abcdef0``. If the command succeeds, no output is returned.", + "input": { + "SnapshotId": "snap-1234567890abcdef0", + "Attribute": "createVolumePermission" + }, + "output": {} + } + ] } }, "com.amazonaws.ec2#ResetSnapshotAttributeRequest": { @@ -86388,7 +88433,44 @@ "target": "com.amazonaws.ec2#Reservation" }, "traits": { - "smithy.api#documentation": "Launches the specified number of instances using an AMI for which you have\n permissions.
\nYou can specify a number of options, or leave the default options. The following rules\n apply:
\nIf you don't specify a subnet ID, we choose a default subnet from\n your default VPC for you. If you don't have a default VPC, you must specify a\n subnet ID in the request.
\nAll instances have a network interface with a primary private IPv4\n address. If you don't specify this address, we choose one from the IPv4 range of\n your subnet.
\nNot all instance types support IPv6 addresses. For more information, see\n Instance\n types.
\nIf you don't specify a security group ID, we use the default security group.\n For more information, see Security\n groups.
\nIf any of the AMIs have a product code attached for which the user has not\n subscribed, the request fails.
\nYou can create a launch template,\n which is a resource that contains the parameters to launch an instance. When you launch\n an instance using RunInstances, you can specify the launch template\n instead of specifying the launch parameters.
\nTo ensure faster instance launches, break up large requests into smaller batches. For\n example, create five separate launch requests for 100 instances each instead of one\n launch request for 500 instances.
\nAn instance is ready for you to use when it's in the running state. You\n can check the state of your instance using DescribeInstances. You can\n tag instances and EBS volumes during launch, after launch, or both. For more\n information, see CreateTags and Tagging your Amazon EC2\n resources.
Linux instances have access to the public key of the key pair at boot. You can use\n this key to provide secure access to the instance. Amazon EC2 public images use this\n feature to provide secure access without passwords. For more information, see Key\n pairs.
\nFor troubleshooting, see What to do if\n an instance immediately terminates, and Troubleshooting connecting to your instance.
" + "smithy.api#documentation": "Launches the specified number of instances using an AMI for which you have\n permissions.
\nYou can specify a number of options, or leave the default options. The following rules\n apply:
\nIf you don't specify a subnet ID, we choose a default subnet from\n your default VPC for you. If you don't have a default VPC, you must specify a\n subnet ID in the request.
\nAll instances have a network interface with a primary private IPv4\n address. If you don't specify this address, we choose one from the IPv4 range of\n your subnet.
\nNot all instance types support IPv6 addresses. For more information, see\n Instance\n types.
\nIf you don't specify a security group ID, we use the default security group.\n For more information, see Security\n groups.
\nIf any of the AMIs have a product code attached for which the user has not\n subscribed, the request fails.
\nYou can create a launch template,\n which is a resource that contains the parameters to launch an instance. When you launch\n an instance using RunInstances, you can specify the launch template\n instead of specifying the launch parameters.
\nTo ensure faster instance launches, break up large requests into smaller batches. For\n example, create five separate launch requests for 100 instances each instead of one\n launch request for 500 instances.
\nAn instance is ready for you to use when it's in the running state. You\n can check the state of your instance using DescribeInstances. You can\n tag instances and EBS volumes during launch, after launch, or both. For more\n information, see CreateTags and Tagging your Amazon EC2\n resources.
Linux instances have access to the public key of the key pair at boot. You can use\n this key to provide secure access to the instance. Amazon EC2 public images use this\n feature to provide secure access without passwords. For more information, see Key\n pairs.
\nFor troubleshooting, see What to do if\n an instance immediately terminates, and Troubleshooting connecting to your instance.
", + "smithy.api#examples": [ + { + "title": "To launch an instance", + "documentation": "This example launches an instance using the specified AMI, instance type, security group, subnet, block device mapping, and tags.", + "input": { + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sdh", + "Ebs": { + "VolumeSize": 100 + } + } + ], + "ImageId": "ami-abc12345", + "InstanceType": "t2.micro", + "KeyName": "my-key-pair", + "MaxCount": 1, + "MinCount": 1, + "SecurityGroupIds": [ + "sg-1a2b3c4d" + ], + "SubnetId": "subnet-6e7f829e", + "TagSpecifications": [ + { + "ResourceType": "instance", + "Tags": [ + { + "Key": "Purpose", + "Value": "test" + } + ] + } + ] + }, + "output": {} + } + ] } }, "com.amazonaws.ec2#RunInstancesMonitoringEnabled": { @@ -86694,6 +88776,14 @@ "smithy.api#default": false, "smithy.api#documentation": "Indicates whether an instance is enabled for stop protection. For more information,\n see Stop\n protection.
" } + }, + "EnablePrimaryIpv6": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "If you’re launching an instance into a dual-stack or IPv6-only subnet, you can enable\n assigning a primary IPv6 address. A primary IPv6 address is an IPv6 GUA address\n associated with an ENI that you have enabled to use a primary IPv6 address. Use this\n option if an instance relies on its IPv6 address not changing. When you launch the\n instance, Amazon Web Services will automatically assign an IPv6 address associated with\n the ENI attached to your instance to be the primary IPv6 address. Once you enable an\n IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6\n GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6\n address until the instance is terminated or the network interface is detached. If you\n have multiple IPv6 addresses associated with an ENI attached to your instance and you\n enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI\n becomes the primary IPv6 address.
" + } } }, "traits": { @@ -91095,7 +93185,33 @@ "target": "com.amazonaws.ec2#StartInstancesResult" }, "traits": { - "smithy.api#documentation": "Starts an Amazon EBS-backed instance that you've previously stopped.
\nInstances 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.
\nBefore 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.
\nPerforming this operation on an instance that uses an instance store as its root\n device returns an error.
\nIf you attempt to start a T3 instance with host tenancy and the\n unlimted CPU credit option, the request fails. The\n unlimited CPU credit option is not supported on Dedicated Hosts. Before\n you start the instance, either change its CPU credit option to standard, or\n change its tenancy to default or dedicated.
For more information, see Stop and start your instance\n in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Starts an Amazon EBS-backed instance that you've previously stopped.
\nInstances 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.
\nBefore 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.
\nPerforming this operation on an instance that uses an instance store as its root\n device returns an error.
\nIf you attempt to start a T3 instance with host tenancy and the\n unlimted CPU credit option, the request fails. The\n unlimited CPU credit option is not supported on Dedicated Hosts. Before\n you start the instance, either change its CPU credit option to standard, or\n change its tenancy to default or dedicated.
For more information, see Stop and start your instance\n in the Amazon EC2 User Guide.
", + "smithy.api#examples": [ + { + "title": "To start a stopped EC2 instance", + "documentation": "This example starts the specified EC2 instance.", + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": { + "StartingInstances": [ + { + "InstanceId": "i-1234567890abcdef0", + "CurrentState": { + "Code": 0, + "Name": "pending" + }, + "PreviousState": { + "Code": 80, + "Name": "stopped" + } + } + ] + } + } + ] } }, "com.amazonaws.ec2#StartInstancesRequest": { @@ -91530,7 +93646,33 @@ "target": "com.amazonaws.ec2#StopInstancesResult" }, "traits": { - "smithy.api#documentation": "Stops an Amazon EBS-backed instance. For more information, see Stop and start\n your instance in the Amazon EC2 User Guide.
\nYou 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.
\nWe 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.
\nYou 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\n Amazon EC2 User Guide.
\nWhen 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.
\nStopping 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.
\nWhen 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 Troubleshoot\n stopping your instance in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Stops an Amazon EBS-backed instance. For more information, see Stop and start\n your instance in the Amazon EC2 User Guide.
\nYou 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.
\nWe 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.
\nYou 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\n Amazon EC2 User Guide.
\nWhen 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.
\nStopping 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.
\nWhen 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 Troubleshoot\n stopping your instance in the Amazon EC2 User Guide.
", + "smithy.api#examples": [ + { + "title": "To stop a running EC2 instance", + "documentation": "This example stops the specified EC2 instance.", + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": { + "StoppingInstances": [ + { + "InstanceId": "i-1234567890abcdef0", + "CurrentState": { + "Code": 64, + "Name": "stopping" + }, + "PreviousState": { + "Code": 16, + "Name": "running" + } + } + ] + } + } + ] } }, "com.amazonaws.ec2#StopInstancesRequest": { @@ -92082,7 +94224,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "The\n description\n assigned to the subnet CIDR\n reservation.
", + "smithy.api#documentation": "The description assigned to the subnet CIDR reservation.
", "smithy.api#xmlName": "description" } }, @@ -93008,7 +95150,33 @@ "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.
\nIf you specify multiple instances and the request fails (for example, because of a\n single incorrect instance ID), none of the instances are terminated.
\nIf you terminate multiple instances across multiple Availability Zones, and one or\n more of the specified instances are enabled for termination protection, the request\n fails with the following results:
\nThe specified instances that are in the same Availability Zone as the\n protected instance are not terminated.
\nThe specified instances that are in different Availability Zones, where no\n other specified instances are protected, are successfully terminated.
\nFor example, say you have the following instances:
\nInstance A: us-east-1a; Not protected
Instance B: us-east-1a; Not protected
Instance C: us-east-1b; Protected
Instance D: us-east-1b; not protected
If you attempt to terminate all of these instances in the same request, the request\n reports failure with the following results:
\nInstance A and Instance B are successfully terminated because none of the\n specified instances in us-east-1a are enabled for termination\n protection.
Instance C and Instance D fail to terminate because at least one of the\n specified instances in us-east-1b (Instance C) is enabled for\n termination protection.
Terminated instances remain visible after termination (for approximately one\n hour).
\nBy default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.
\nYou 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.
For more information about troubleshooting, see Troubleshooting terminating your instance in the\n 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.
\nIf you specify multiple instances and the request fails (for example, because of a\n single incorrect instance ID), none of the instances are terminated.
\nIf you terminate multiple instances across multiple Availability Zones, and one or\n more of the specified instances are enabled for termination protection, the request\n fails with the following results:
\nThe specified instances that are in the same Availability Zone as the\n protected instance are not terminated.
\nThe specified instances that are in different Availability Zones, where no\n other specified instances are protected, are successfully terminated.
\nFor example, say you have the following instances:
\nInstance A: us-east-1a; Not protected
Instance B: us-east-1a; Not protected
Instance C: us-east-1b; Protected
Instance D: us-east-1b; not protected
If you attempt to terminate all of these instances in the same request, the request\n reports failure with the following results:
\nInstance A and Instance B are successfully terminated because none of the\n specified instances in us-east-1a are enabled for termination\n protection.
Instance C and Instance D fail to terminate because at least one of the\n specified instances in us-east-1b (Instance C) is enabled for\n termination protection.
Terminated instances remain visible after termination (for approximately one\n hour).
\nBy default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.
\nYou 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.
For more information about troubleshooting, see Troubleshooting terminating your instance in the\n Amazon EC2 User Guide.
", + "smithy.api#examples": [ + { + "title": "To terminate an EC2 instance", + "documentation": "This example terminates the specified EC2 instance.", + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": { + "TerminatingInstances": [ + { + "InstanceId": "i-1234567890abcdef0", + "CurrentState": { + "Code": 32, + "Name": "shutting-down" + }, + "PreviousState": { + "Code": 16, + "Name": "running" + } + } + ] + } + } + ] } }, "com.amazonaws.ec2#TerminateInstancesRequest": { @@ -97530,7 +99698,30 @@ "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgressResult" }, "traits": { - "smithy.api#documentation": "Updates the description of an egress (outbound) security group rule. You\n\t\t\tcan replace an existing description, or add a description to a rule that did not have one\n\t\t\tpreviously. You can remove a description for a security group rule by omitting the \n\t\t\tdescription parameter in the request.
" + "smithy.api#documentation": "Updates the description of an egress (outbound) security group rule. You\n\t\t\tcan replace an existing description, or add a description to a rule that did not have one\n\t\t\tpreviously. You can remove a description for a security group rule by omitting the \n\t\t\tdescription parameter in the request.
", + "smithy.api#examples": [ + { + "title": "To update an outbound security group rule description", + "documentation": "This example updates the description for the specified security group rule.", + "input": { + "GroupId": "sg-123abc12", + "IpPermissions": [ + { + "IpProtocol": "tcp", + "FromPort": 80, + "ToPort": 80, + "IpRanges": [ + { + "CidrIp": "203.0.113.0/24", + "Description": "Outbound HTTP access to server 2" + } + ] + } + ] + }, + "output": {} + } + ] } }, "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsEgressRequest": { @@ -97601,7 +99792,30 @@ "target": "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngressResult" }, "traits": { - "smithy.api#documentation": "Updates the description of an ingress (inbound) security group rule. You can replace an\n\t\t\texisting description, or add a description to a rule that did not have one previously.\n\t\t You can remove a description for a security group rule by omitting the description \n\t\t parameter in the request.
" + "smithy.api#documentation": "Updates the description of an ingress (inbound) security group rule. You can replace an\n\t\t\texisting description, or add a description to a rule that did not have one previously.\n\t\t You can remove a description for a security group rule by omitting the description \n\t\t parameter in the request.
", + "smithy.api#examples": [ + { + "title": "To update an inbound security group rule description", + "documentation": "This example updates the description for the specified security group rule.", + "input": { + "GroupId": "sg-123abc12", + "IpPermissions": [ + { + "IpProtocol": "tcp", + "FromPort": 22, + "ToPort": 22, + "IpRanges": [ + { + "CidrIp": "203.0.113.0/16", + "Description": "SSH access from the LA office" + } + ] + } + ] + }, + "output": {} + } + ] } }, "com.amazonaws.ec2#UpdateSecurityGroupRuleDescriptionsIngressRequest": { diff --git a/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json b/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json index 6f83e3d4361..37ba5292c62 100644 --- a/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json +++ b/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json @@ -332,52 +332,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -385,13 +389,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -401,224 +414,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://ecs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://ecs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://ecs-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://ecs-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://ecs.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://ecs.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://ecs.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://ecs.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -1471,14 +1435,14 @@ "autoScalingGroupArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the Auto Scaling group.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name.
", "smithy.api#required": {} } }, "managedScaling": { "target": "com.amazonaws.ecs#ManagedScaling", "traits": { - "smithy.api#documentation": "The managed scaling settings for the Auto Scaling group capacity provider.
" + "smithy.api#documentation": "he managed scaling settings for the Auto Scaling group capacity provider.
" } }, "managedTerminationProtection": { @@ -2361,13 +2325,13 @@ "startTimeout": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "Time duration (in seconds) to wait before giving up on resolving dependencies for a\n\t\t\tcontainer. For example, you specify two containers in a task definition with containerA\n\t\t\thaving a dependency on containerB reaching a COMPLETE,\n\t\t\tSUCCESS, or HEALTHY status. If a startTimeout\n\t\t\tvalue is specified for containerB and it doesn't reach the desired status within that\n\t\t\ttime then containerA gives up and not start. This results in the task transitioning to a\n\t\t\t\tSTOPPED state.
When the ECS_CONTAINER_START_TIMEOUT container agent configuration\n\t\t\t\tvariable is used, it's enforced independently from this start timeout value.
For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For tasks using the EC2 launch type, your container instances require at\n\t\t\tleast version 1.26.0 of the container agent to use a container start\n\t\t\ttimeout value. However, we recommend using the latest container agent version. For\n\t\t\tinformation about checking your agent version and updating to the latest version, see\n\t\t\t\tUpdating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init\n\t\t\tpackage. If your container instances are launched from version 20190301 or\n\t\t\tlater, then they contain the required versions of the container agent and\n\t\t\t\tecs-init. For more information, see Amazon ECS-optimized Linux AMI\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
Time duration (in seconds) to wait before giving up on resolving dependencies for a\n\t\t\tcontainer. For example, you specify two containers in a task definition with containerA\n\t\t\thaving a dependency on containerB reaching a COMPLETE,\n\t\t\tSUCCESS, or HEALTHY status. If a startTimeout\n\t\t\tvalue is specified for containerB and it doesn't reach the desired status within that\n\t\t\ttime then containerA gives up and not start. This results in the task transitioning to a\n\t\t\t\tSTOPPED state.
When the ECS_CONTAINER_START_TIMEOUT container agent configuration\n\t\t\t\tvariable is used, it's enforced independently from this start timeout value.
For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For tasks using the EC2 launch type, your container instances require at\n\t\t\tleast version 1.26.0 of the container agent to use a container start\n\t\t\ttimeout value. However, we recommend using the latest container agent version. For\n\t\t\tinformation about checking your agent version and updating to the latest version, see\n\t\t\t\tUpdating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init\n\t\t\tpackage. If your container instances are launched from version 20190301 or\n\t\t\tlater, then they contain the required versions of the container agent and\n\t\t\t\tecs-init. For more information, see Amazon ECS-optimized Linux AMI\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
The valid values are 2-120 seconds.
" } }, "stopTimeout": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "Time duration (in seconds) to wait before the container is forcefully killed if it\n\t\t\tdoesn't exit normally on its own.
\nFor tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
The max stop timeout value is 120 seconds and if the parameter is not specified, the\n\t\t\tdefault value of 30 seconds is used.
\nFor tasks that use the EC2 launch type, if the stopTimeout\n\t\t\tparameter isn't specified, the value set for the Amazon ECS container agent configuration\n\t\t\tvariable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the\n\t\t\t\tstopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT\n\t\t\tagent configuration variable are set, then the default values of 30 seconds for Linux\n\t\t\tcontainers and 30 seconds on Windows containers are used. Your container instances\n\t\t\trequire at least version 1.26.0 of the container agent to use a container stop timeout\n\t\t\tvalue. However, we recommend using the latest container agent version. For information\n\t\t\tabout checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
Time duration (in seconds) to wait before the container is forcefully killed if it\n\t\t\tdoesn't exit normally on its own.
\nFor tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
The max stop timeout value is 120 seconds and if the parameter is not specified, the\n\t\t\tdefault value of 30 seconds is used.
\nFor tasks that use the EC2 launch type, if the stopTimeout\n\t\t\tparameter isn't specified, the value set for the Amazon ECS container agent configuration\n\t\t\tvariable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the\n\t\t\t\tstopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT\n\t\t\tagent configuration variable are set, then the default values of 30 seconds for Linux\n\t\t\tcontainers and 30 seconds on Windows containers are used. Your container instances\n\t\t\trequire at least version 1.26.0 of the container agent to use a container stop timeout\n\t\t\tvalue. However, we recommend using the latest container agent version. For information\n\t\t\tabout checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The valid values are 2-120 seconds.
" } }, "hostname": { @@ -2487,7 +2451,7 @@ "credentialSpecs": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "A list of ARNs in SSM or Amazon S3 to a credential spec\n\t\t\t(credspeccode>) file that configures a container for Active Directory\n\t\t\tauthentication. This parameter is only used with domainless authentication.
The format for each ARN is\n\t\t\t\t\tcredentialspecdomainless:MyARN. Replace\n\t\t\t\tMyARN with the ARN in SSM or Amazon S3.
The credspec must provide a ARN in Secrets Manager for a secret\n\t\t\tcontaining the username, password, and the domain to connect to. For better security,\n\t\t\tthe instance isn't joined to the domain for domainless authentication. Other\n\t\t\tapplications on the instance can't use the domainless credentials. You can use this\n\t\t\tparameter to run tasks on the same instance, even it the tasks need to join different\n\t\t\tdomains. For more information, see Using gMSAs for Windows\n\t\t\t\tContainers and Using gMSAs for Linux\n\t\t\t\tContainers.
A list of ARNs in SSM or Amazon S3 to a credential spec\n\t\t\t\t(CredSpec) file that configures the container for Active Directory\n\t\t\tauthentication. We recommend that you use this parameter instead of the\n\t\t\t\tdockerSecurityOptions. The maximum number of ARNs is\n\t\t\t1.
There are two formats for each ARN.
\nYou use credentialspecdomainless:MyARN to provide a\n\t\t\t\t\t\t\tCredSpec with an additional section for a secret in Secrets Manager.\n\t\t\t\t\t\tYou provide the login credentials to the domain in the secret.
Each task that runs on any container instance can join different\n\t\t\t\t\t\tdomains.
\nYou can use this format without joining the container instance to a\n\t\t\t\t\t\tdomain.
\nYou use credentialspec:MyARN to provide a\n\t\t\t\t\t\t\tCredSpec for a single domain.
You must join the container instance to the domain before you start any\n\t\t\t\t\t\ttasks that use this task definition.
\nIn both formats, replace MyARN with the ARN in\n\t\t\tSSM or Amazon S3.
If you provide a credentialspecdomainless:MyARN, the\n\t\t\t\tcredspec must provide a ARN in Secrets Manager for a secret containing the\n\t\t\tusername, password, and the domain to connect to. For better security, the instance\n\t\t\tisn't joined to the domain for domainless authentication. Other applications on the\n\t\t\tinstance can't use the domainless credentials. You can use this parameter to run tasks\n\t\t\ton the same instance, even it the tasks need to join different domains. For more\n\t\t\tinformation, see Using gMSAs for Windows\n\t\t\t\tContainers and Using gMSAs for Linux\n\t\t\t\tContainers.
The overrides that are sent to a container. An empty container override can be passed\n\t\t\tin. An example of an empty container override is {\"containerOverrides\": [ ]\n\t\t\t\t}. If a non-empty container override is specified, the name\n\t\t\tparameter must be included.
The overrides that are sent to a container. An empty container override can be passed\n\t\t\tin. An example of an empty container override is {\"containerOverrides\": [ ]\n\t\t\t\t}. If a non-empty container override is specified, the name\n\t\t\tparameter must be included.
You can use Secrets Manager or Amazon Web Services Systems Manager Parameter Store to store the sensitive\n\t\t\tdata. For more information, see Retrieve secrets through environment variables in the Amazon ECS Developer Guide.
" } }, "com.amazonaws.ecs#ContainerOverrides": { @@ -2951,7 +2915,27 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new Amazon ECS cluster. By default, your account receives a default\n\t\t\tcluster when you launch your first container instance. However, you can create your own\n\t\t\tcluster with a unique name with the CreateCluster action.
When you call the CreateCluster API operation, Amazon ECS attempts to\n\t\t\t\tcreate the Amazon ECS service-linked role for your account. This is so that it can manage\n\t\t\t\trequired resources in other Amazon Web Services services on your behalf. However, if the user\n\t\t\t\tthat makes the call doesn't have permissions to create the service-linked role, it\n\t\t\t\tisn't created. For more information, see Using\n\t\t\t\t\tservice-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
\nCreates a new Amazon ECS cluster. By default, your account receives a default\n\t\t\tcluster when you launch your first container instance. However, you can create your own\n\t\t\tcluster with a unique name with the CreateCluster action.
When you call the CreateCluster API operation, Amazon ECS attempts to\n\t\t\t\tcreate the Amazon ECS service-linked role for your account. This is so that it can manage\n\t\t\t\trequired resources in other Amazon Web Services services on your behalf. However, if the user\n\t\t\t\tthat makes the call doesn't have permissions to create the service-linked role, it\n\t\t\t\tisn't created. For more information, see Using\n\t\t\t\t\tservice-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
\nRuns and maintains your desired number of tasks from a specified task definition. If\n\t\t\tthe number of tasks running in a service drops below the desiredCount,\n\t\t\tAmazon ECS runs another copy of the task in the specified cluster. To update an existing\n\t\t\tservice, see the UpdateService action.
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
\nIn addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
\nTasks for services that don't use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING state. Tasks for services that use a load balancer are\n\t\t\tconsidered healthy if they're in the RUNNING state and are reported as\n\t\t\thealthy by the load balancer.
There are two service scheduler strategies available:
\n\n REPLICA - The replica scheduling strategy places and\n\t\t\t\t\tmaintains your desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. For\n\t\t\t\t\tmore information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
\n DAEMON - The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks. It also stops tasks\n\t\t\t\t\tthat don't meet the placement constraints. When using this strategy, you don't\n\t\t\t\t\tneed to specify a desired number of tasks, a task placement strategy, or use\n\t\t\t\t\tService Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis initiated by changing properties. For example, the deployment might be initiated by\n\t\t\tthe task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for\n\t\t\t\tminimumHealthyPercent is 100%. The default value for a daemon service\n\t\t\tfor minimumHealthyPercent is 0%.
If a service uses the ECS deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of your desired number of tasks (rounded up to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can deploy without using additional cluster capacity. For example, if you\n\t\t\tset your service to have desired number of four tasks and a minimum healthy percent of\n\t\t\t50%, the scheduler might stop two existing tasks to free up cluster capacity before\n\t\t\tstarting two new tasks. If they're in the RUNNING state, tasks for services\n\t\t\tthat don't use a load balancer are considered healthy . If they're in the\n\t\t\t\tRUNNING state and reported as healthy by the load balancer, tasks for\n\t\t\tservices that do use a load balancer are considered healthy . The\n\t\t\tdefault value for minimum healthy percent is 100%.
If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of the desired number of tasks (rounded down to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can define the deployment batch size. For example, if your service has a\n\t\t\tdesired number of four tasks and a maximum percent value of 200%, the scheduler may\n\t\t\tstart four new tasks before stopping the four older tasks (provided that the cluster\n\t\t\tresources required to do this are available). The default value for maximum percent is\n\t\t\t200%.
If a service uses either the CODE_DEPLOY or EXTERNAL\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING state.\n\t\t\tThis is while the container instances are in the DRAINING state. If the\n\t\t\ttasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're\n\t\t\tcurrently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement. For\n\t\t\tinformation about task placement and task placement strategies, see Amazon ECS\n\t\t\t\ttask placement in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Runs and maintains your desired number of tasks from a specified task definition. If\n\t\t\tthe number of tasks running in a service drops below the desiredCount,\n\t\t\tAmazon ECS runs another copy of the task in the specified cluster. To update an existing\n\t\t\tservice, see the UpdateService action.
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
\nIn addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
\nTasks for services that don't use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING state. Tasks for services that use a load balancer are\n\t\t\tconsidered healthy if they're in the RUNNING state and are reported as\n\t\t\thealthy by the load balancer.
There are two service scheduler strategies available:
\n\n REPLICA - The replica scheduling strategy places and\n\t\t\t\t\tmaintains your desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. For\n\t\t\t\t\tmore information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
\n DAEMON - The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks. It also stops tasks\n\t\t\t\t\tthat don't meet the placement constraints. When using this strategy, you don't\n\t\t\t\t\tneed to specify a desired number of tasks, a task placement strategy, or use\n\t\t\t\t\tService Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis initiated by changing properties. For example, the deployment might be initiated by\n\t\t\tthe task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for\n\t\t\t\tminimumHealthyPercent is 100%. The default value for a daemon service\n\t\t\tfor minimumHealthyPercent is 0%.
If a service uses the ECS deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of your desired number of tasks (rounded up to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can deploy without using additional cluster capacity. For example, if you\n\t\t\tset your service to have desired number of four tasks and a minimum healthy percent of\n\t\t\t50%, the scheduler might stop two existing tasks to free up cluster capacity before\n\t\t\tstarting two new tasks. If they're in the RUNNING state, tasks for services\n\t\t\tthat don't use a load balancer are considered healthy . If they're in the\n\t\t\t\tRUNNING state and reported as healthy by the load balancer, tasks for\n\t\t\tservices that do use a load balancer are considered healthy . The\n\t\t\tdefault value for minimum healthy percent is 100%.
If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of the desired number of tasks (rounded down to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can define the deployment batch size. For example, if your service has a\n\t\t\tdesired number of four tasks and a maximum percent value of 200%, the scheduler may\n\t\t\tstart four new tasks before stopping the four older tasks (provided that the cluster\n\t\t\tresources required to do this are available). The default value for maximum percent is\n\t\t\t200%.
If a service uses either the CODE_DEPLOY or EXTERNAL\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING state.\n\t\t\tThis is while the container instances are in the DRAINING state. If the\n\t\t\ttasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're\n\t\t\tcurrently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement. For\n\t\t\tinformation about task placement and task placement strategies, see Amazon ECS\n\t\t\t\ttask placement in the Amazon Elastic Container Service Developer Guide.
", + "smithy.api#examples": [ + { + "title": "To create a new service", + "documentation": "This example creates a service in your default region called ``ecs-simple-service``. The service uses the ``hello_world`` task definition and it maintains 10 copies of that task.", + "input": { + "serviceName": "ecs-simple-service", + "taskDefinition": "hello_world", + "desiredCount": 10 + }, + "output": { + "service": { + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default", + "createdAt": "2016-08-29T16:13:47.298Z", + "deploymentConfiguration": { + "maximumPercent": 200, + "minimumHealthyPercent": 100 + }, + "deployments": [ + { + "createdAt": "2016-08-29T16:13:47.298Z", + "desiredCount": 10, + "id": "ecs-svc/9223370564342348388", + "pendingCount": 0, + "runningCount": 0, + "status": "PRIMARY", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", + "updatedAt": "2016-08-29T16:13:47.298Z" + }, + { + "createdAt": "2016-08-29T15:52:44.481Z", + "desiredCount": 0, + "id": "ecs-svc/9223370564343611322", + "pendingCount": 0, + "runningCount": 0, + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", + "updatedAt": "2016-08-29T16:11:38.941Z" + } + ], + "desiredCount": 10, + "events": [], + "loadBalancers": [], + "pendingCount": 0, + "runningCount": 0, + "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service", + "serviceName": "ecs-simple-service", + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6" + } + } + } + ] } }, "com.amazonaws.ecs#CreateServiceRequest": { @@ -3295,7 +3331,7 @@ "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The task definition for the tasks in the task set to use.
", + "smithy.api#documentation": "The task definition for the tasks in the task set to use. If a revision isn't specified, the\n\t\t\tlatest ACTIVE revision is used.
Disables an account setting for a specified user, role, or the root user for\n\t\t\tan account.
" + "smithy.api#documentation": "Disables an account setting for a specified user, role, or the root user for\n\t\t\tan account.
", + "smithy.api#examples": [ + { + "title": "To delete your account setting", + "documentation": "This example deletes the account setting for your user for the specified resource type.", + "input": { + "name": "serviceLongArnFormat" + }, + "output": { + "setting": { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::Deletes the specified cluster. The cluster transitions to the INACTIVE\n\t\t\tstate. Clusters with an INACTIVE status might remain discoverable in your\n\t\t\taccount for a period of time. However, this behavior is subject to change in the future.\n\t\t\tWe don't recommend that you rely on INACTIVE clusters persisting.
You must deregister all container instances from this cluster before you may delete\n\t\t\tit. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
" + "smithy.api#documentation": "Deletes the specified cluster. The cluster transitions to the INACTIVE\n\t\t\tstate. Clusters with an INACTIVE status might remain discoverable in your\n\t\t\taccount for a period of time. However, this behavior is subject to change in the future.\n\t\t\tWe don't recommend that you rely on INACTIVE clusters persisting.
You must deregister all container instances from this cluster before you may delete\n\t\t\tit. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
", + "smithy.api#examples": [ + { + "title": "To delete an empty cluster", + "documentation": "This example deletes an empty cluster in your default region.", + "input": { + "cluster": "my_cluster" + }, + "output": { + "cluster": { + "activeServicesCount": 0, + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster", + "clusterName": "my_cluster", + "pendingTasksCount": 0, + "registeredContainerInstancesCount": 0, + "runningTasksCount": 0, + "status": "INACTIVE" + } + } + } + ] } }, "com.amazonaws.ecs#DeleteClusterRequest": { @@ -3633,7 +3705,17 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a specified service within a cluster. You can delete a service if you have no\n\t\t\trunning tasks in it and the desired task count is zero. If the service is actively\n\t\t\tmaintaining tasks, you can't delete it, and you must update the service to a desired\n\t\t\ttask count of zero. For more information, see UpdateService.
\nWhen you delete a service, if there are still running tasks that require cleanup,\n\t\t\t\tthe service status moves from ACTIVE to DRAINING, and the\n\t\t\t\tservice is no longer visible in the console or in the ListServices\n\t\t\t\tAPI operation. After all tasks have transitioned to either STOPPING or\n\t\t\t\t\tSTOPPED status, the service status moves from DRAINING\n\t\t\t\tto INACTIVE. Services in the DRAINING or\n\t\t\t\t\tINACTIVE status can still be viewed with the DescribeServices API operation. However, in the future,\n\t\t\t\t\tINACTIVE services may be cleaned up and purged from Amazon ECS record\n\t\t\t\tkeeping, and DescribeServices calls on those services return a\n\t\t\t\t\tServiceNotFoundException error.
If you attempt to create a new service with the same name as an existing service\n\t\t\t\tin either ACTIVE or DRAINING status, you receive an\n\t\t\t\terror.
Deletes a specified service within a cluster. You can delete a service if you have no\n\t\t\trunning tasks in it and the desired task count is zero. If the service is actively\n\t\t\tmaintaining tasks, you can't delete it, and you must update the service to a desired\n\t\t\ttask count of zero. For more information, see UpdateService.
\nWhen you delete a service, if there are still running tasks that require cleanup,\n\t\t\t\tthe service status moves from ACTIVE to DRAINING, and the\n\t\t\t\tservice is no longer visible in the console or in the ListServices\n\t\t\t\tAPI operation. After all tasks have transitioned to either STOPPING or\n\t\t\t\t\tSTOPPED status, the service status moves from DRAINING\n\t\t\t\tto INACTIVE. Services in the DRAINING or\n\t\t\t\t\tINACTIVE status can still be viewed with the DescribeServices API operation. However, in the future,\n\t\t\t\t\tINACTIVE services may be cleaned up and purged from Amazon ECS record\n\t\t\t\tkeeping, and DescribeServices calls on those services return a\n\t\t\t\t\tServiceNotFoundException error.
If you attempt to create a new service with the same name as an existing service\n\t\t\t\tin either ACTIVE or DRAINING status, you receive an\n\t\t\t\terror.
The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type.
The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If it is turned on, a\n\t\t\tservice deployment will transition to a failed state and stop launching new tasks. You\n\t\t\tcan also configure Amazon ECS to roll back your service to the last completed deployment\n\t\t\tafter a failure. For more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type.
The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If it is turned on, a\n\t\t\tservice deployment will transition to a failed state and stop launching new tasks. You\n\t\t\tcan also configure Amazon ECS to roll back your service to the last completed deployment\n\t\t\tafter a failure. For more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer Guide.
\nFor more information about API failure reasons, see API failure reasons in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#DeploymentConfiguration": { @@ -4125,7 +4207,19 @@ } ], "traits": { - "smithy.api#documentation": "Deregisters an Amazon ECS container instance from the specified cluster. This instance is\n\t\t\tno longer available to run tasks.
\nIf you intend to use the container instance for some other purpose after\n\t\t\tderegistration, we recommend that you stop all of the tasks running on the container\n\t\t\tinstance before deregistration. That prevents any orphaned tasks from consuming\n\t\t\tresources.
\nDeregistering a container instance removes the instance from a cluster, but it doesn't\n\t\t\tterminate the EC2 instance. If you are finished using the instance, be sure to terminate\n\t\t\tit in the Amazon EC2 console to stop billing.
\nIf you terminate a running container instance, Amazon ECS automatically deregisters the\n\t\t\t\tinstance from your cluster (stopped container instances or instances with\n\t\t\t\tdisconnected agents aren't automatically deregistered when terminated).
\nDeregisters an Amazon ECS container instance from the specified cluster. This instance is\n\t\t\tno longer available to run tasks.
\nIf you intend to use the container instance for some other purpose after\n\t\t\tderegistration, we recommend that you stop all of the tasks running on the container\n\t\t\tinstance before deregistration. That prevents any orphaned tasks from consuming\n\t\t\tresources.
\nDeregistering a container instance removes the instance from a cluster, but it doesn't\n\t\t\tterminate the EC2 instance. If you are finished using the instance, be sure to terminate\n\t\t\tit in the Amazon EC2 console to stop billing.
\nIf you terminate a running container instance, Amazon ECS automatically deregisters the\n\t\t\t\tinstance from your cluster (stopped container instances or instances with\n\t\t\t\tdisconnected agents aren't automatically deregistered when terminated).
\nDescribes one or more of your clusters.
" + "smithy.api#documentation": "Describes one or more of your clusters.
", + "smithy.api#examples": [ + { + "title": "To describe a cluster", + "documentation": "This example provides a description of the specified cluster in your default region.", + "input": { + "clusters": [ + "default" + ] + }, + "output": { + "clusters": [ + { + "clusterName": "default", + "status": "ACTIVE", + "clusterArn": "arn:aws:ecs:us-east-1:aws_account_id:cluster/default" + } + ], + "failures": [] + } + } + ] } }, "com.amazonaws.ecs#DescribeClustersRequest": { @@ -4388,7 +4503,91 @@ } ], "traits": { - "smithy.api#documentation": "Describes one or more container instances. Returns metadata about each container\n\t\t\tinstance requested.
" + "smithy.api#documentation": "Describes one or more container instances. Returns metadata about each container\n\t\t\tinstance requested.
", + "smithy.api#examples": [ + { + "title": "To describe container instance", + "documentation": "This example provides a description of the specified container instance in your default region, using the container instance UUID as an identifier.", + "input": { + "cluster": "default", + "containerInstances": [ + "f2756532-8f13-4d53-87c9-aed50dc94cd7" + ] + }, + "output": { + "failures": [], + "containerInstances": [ + { + "status": "ACTIVE", + "registeredResources": [ + { + "doubleValue": 0.0, + "type": "INTEGER", + "longValue": 0, + "integerValue": 2048, + "name": "CPU" + }, + { + "doubleValue": 0.0, + "type": "INTEGER", + "longValue": 0, + "integerValue": 3768, + "name": "MEMORY" + }, + { + "name": "PORTS", + "longValue": 0, + "doubleValue": 0.0, + "stringSetValue": [ + "2376", + "22", + "51678", + "2375" + ], + "type": "STRINGSET", + "integerValue": 0 + } + ], + "ec2InstanceId": "i-807f3249", + "agentConnected": true, + "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/f2756532-8f13-4d53-87c9-aed50dc94cd7", + "pendingTasksCount": 0, + "remainingResources": [ + { + "doubleValue": 0.0, + "type": "INTEGER", + "longValue": 0, + "integerValue": 1948, + "name": "CPU" + }, + { + "doubleValue": 0.0, + "type": "INTEGER", + "longValue": 0, + "integerValue": 3668, + "name": "MEMORY" + }, + { + "name": "PORTS", + "longValue": 0, + "doubleValue": 0.0, + "stringSetValue": [ + "2376", + "22", + "80", + "51678", + "2375" + ], + "type": "STRINGSET", + "integerValue": 0 + } + ], + "runningTasksCount": 1 + } + ] + } + } + ] } }, "com.amazonaws.ecs#DescribeContainerInstancesRequest": { @@ -4462,6 +4661,57 @@ ], "traits": { "smithy.api#documentation": "Describes the specified services running in your cluster.
", + "smithy.api#examples": [ + { + "title": "To describe a service", + "documentation": "This example provides descriptive information about the service named ``ecs-simple-service``.", + "input": { + "services": [ + "ecs-simple-service" + ] + }, + "output": { + "failures": [], + "services": [ + { + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default", + "createdAt": "2016-08-29T16:25:52.130Z", + "deploymentConfiguration": { + "maximumPercent": 200, + "minimumHealthyPercent": 100 + }, + "deployments": [ + { + "createdAt": "2016-08-29T16:25:52.130Z", + "desiredCount": 1, + "id": "ecs-svc/9223370564341623665", + "pendingCount": 0, + "runningCount": 0, + "status": "PRIMARY", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", + "updatedAt": "2016-08-29T16:25:52.130Z" + } + ], + "desiredCount": 1, + "events": [ + { + "createdAt": "2016-08-29T16:25:58.520Z", + "id": "38c285e5-d335-4b68-8b15-e46dedc8e88d", + "message": "(service ecs-simple-service) was unable to place a task because no container instance met all of its requirements. The closest matching (container-instance 3f4de1c5-ffdd-4954-af7e-75b4be0c8841) is already using a port required by your task. For more information, see the Troubleshooting section of the Amazon ECS Developer Guide." + } + ], + "loadBalancers": [], + "pendingCount": 0, + "runningCount": 0, + "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service", + "serviceName": "ecs-simple-service", + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6" + } + ] + } + } + ], "smithy.waiters#waitable": { "ServicesInactive": { "acceptors": [ @@ -4603,7 +4853,61 @@ } ], "traits": { - "smithy.api#documentation": "Describes a task definition. You can specify a family and\n\t\t\t\trevision to find information about a specific task definition, or you\n\t\t\tcan simply specify the family to find the latest ACTIVE revision in that\n\t\t\tfamily.
You can only describe INACTIVE task definitions while an active task\n\t\t\t\tor service references them.
Describes a task definition. You can specify a family and\n\t\t\t\trevision to find information about a specific task definition, or you\n\t\t\tcan simply specify the family to find the latest ACTIVE revision in that\n\t\t\tfamily.
You can only describe INACTIVE task definitions while an active task\n\t\t\t\tor service references them.
Describes a specified task or tasks.
\nCurrently, stopped tasks appear in the returned results for at least one hour.
", + "smithy.api#documentation": "Describes a specified task or tasks.
\nCurrently, stopped tasks appear in the returned results for at least one hour.
\nIf you have tasks with tags, and then delete the cluster, the tagged tasks are\n\t\t\treturned in the response. If you create a new cluster with the same name as the deleted\n\t\t\tcluster, the tagged tasks are not included in the response.
", + "smithy.api#examples": [ + { + "title": "To describe a task", + "documentation": "This example provides a description of the specified task, using the task UUID as an identifier.", + "input": { + "tasks": [ + "c5cba4eb-5dad-405e-96db-71ef8eefe6a8" + ] + }, + "output": { + "failures": [], + "tasks": [ + { + "taskArn": "arn:aws:ecs:A list of files containing the environment variables to pass to a container. You can\n\t\t\tspecify up to ten environment files. The file must have a .env file\n\t\t\textension. Each line in an environment file should contain an environment variable in\n\t\t\t\tVARIABLE=VALUE format. Lines beginning with # are treated\n\t\t\tas comments and are ignored. For more information about the environment variable file\n\t\t\tsyntax, see Declare default\n\t\t\t\tenvironment variables in file.
If there are environment variables specified using the environment\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they're processed from the top down. We recommend that you use unique\n\t\t\tvariable names. For more information, see Specifying environment\n\t\t\t\tvariables in the Amazon Elastic Container Service Developer Guide.
This parameter is only supported for tasks hosted on Fargate using the\n\t\t\tfollowing platform versions:
\nLinux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
A list of files containing the environment variables to pass to a container. You can\n\t\t\tspecify up to ten environment files. The file must have a .env file\n\t\t\textension. Each line in an environment file should contain an environment variable in\n\t\t\t\tVARIABLE=VALUE format. Lines beginning with # are treated\n\t\t\tas comments and are ignored. For more information about the environment variable file\n\t\t\tsyntax, see Declare default\n\t\t\t\tenvironment variables in file.
If there are environment variables specified using the environment\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they're processed from the top down. We recommend that you use unique\n\t\t\tvariable names. For more information, see Specifying environment\n\t\t\t\tvariables in the Amazon Elastic Container Service Developer Guide.
You must use the following platforms for the Fargate launch type:
\nLinux platform version 1.4.0 or later.
Windows platform version 1.0.0 or later.
Retrieves the protection status of tasks in an Amazon ECS service.
" + "smithy.api#documentation": "Retrieves the protection status of tasks in an Amazon ECS service.
", + "smithy.api#examples": [ + { + "title": "To get the protection status of a task", + "documentation": "In this example, we get the protection status for a single task.", + "input": { + "cluster": "test-task-protection", + "tasks": [ + "b8b1cf532d0e46ba8d44a40d1de16772" + ] + }, + "output": { + "protectedTasks": [ + { + "taskArn": "arn:aws:ecs:us-west-2:012345678910:task/b8b1cf532d0e46ba8d44a40d1de16772", + "protectionEnabled": true, + "expirationDate": "2022-11-02T06:56:32.553Z" + } + ], + "failures": [] + } + } + ] } }, "com.amazonaws.ecs#GetTaskProtectionRequest": { @@ -6065,6 +6438,34 @@ ], "traits": { "smithy.api#documentation": "Lists the account settings for a specified principal.
", + "smithy.api#examples": [ + { + "title": "To view your effective account settings", + "documentation": "This example displays the effective account settings for your account.", + "input": { + "effectiveSettings": true + }, + "output": { + "settings": [ + { + "name": "containerInstanceLongArnFormat", + "value": "disabled", + "principalArn": "arn:aws:iam::Returns a list of existing clusters.
", + "smithy.api#examples": [ + { + "title": "To list your available clusters", + "documentation": "This example lists all of your available clusters in your default region.", + "output": { + "clusterArns": [ + "arn:aws:ecs:us-east-1:Returns a list of container instances in a specified cluster. You can filter the\n\t\t\tresults of a ListContainerInstances operation with cluster query language\n\t\t\tstatements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
Returns a list of services. You can filter the results by cluster, launch type, and\n\t\t\tscheduling strategy.
", + "smithy.api#examples": [ + { + "title": "To list the services in a cluster", + "documentation": "This example lists the services running in the default cluster for an account.", + "output": { + "serviceArns": [ + "arn:aws:ecs:us-east-1:012345678910:service/my-http-service" + ] + } + } + ], "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -6581,7 +7020,24 @@ } ], "traits": { - "smithy.api#documentation": "List the tags for an Amazon ECS resource.
" + "smithy.api#documentation": "List the tags for an Amazon ECS resource.
", + "smithy.api#examples": [ + { + "title": "To list the tags for a cluster.", + "documentation": "This example lists the tags for the 'dev' cluster.", + "input": { + "resourceArn": "arn:aws:ecs:region:aws_account_id:cluster/dev" + }, + "output": { + "tags": [ + { + "key": "team", + "value": "dev" + } + ] + } + } + ] } }, "com.amazonaws.ecs#ListTagsForResourceRequest": { @@ -6634,6 +7090,20 @@ ], "traits": { "smithy.api#documentation": "Returns a list of task definition families that are registered to your account. This\n\t\t\tlist includes task definition families that no longer have any ACTIVE task\n\t\t\tdefinition revisions.
You can filter out task definition families that don't contain any ACTIVE\n\t\t\ttask definition revisions by setting the status parameter to\n\t\t\t\tACTIVE. You can also filter the results with the\n\t\t\t\tfamilyPrefix parameter.
Returns a list of task definitions that are registered to your account. You can filter\n\t\t\tthe results by family name with the familyPrefix parameter or by status\n\t\t\twith the status parameter.
Returns a list of tasks. You can filter the results by cluster, task definition\n\t\t\tfamily, container instance, launch type, what IAM principal started the task, or by the\n\t\t\tdesired status of the task.
\nRecently stopped tasks might appear in the returned results. Currently, stopped tasks\n\t\t\tappear in the returned results for at least one hour.
", + "smithy.api#documentation": "Returns a list of tasks. You can filter the results by cluster, task definition\n\t\t\tfamily, container instance, launch type, what IAM principal started the task, or by the\n\t\t\tdesired status of the task.
\nRecently stopped tasks might appear in the returned results.
", + "smithy.api#examples": [ + { + "title": "To list the tasks in a cluster", + "documentation": "This example lists all of the tasks in a cluster.", + "input": { + "cluster": "default" + }, + "output": { + "taskArns": [ + "arn:aws:ecs:us-east-1:012345678910:task/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84", + "arn:aws:ecs:us-east-1:012345678910:task/6b809ef6-c67e-4467-921f-ee261c15a0a1" + ] + } + } + ], "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -6904,13 +7405,13 @@ "targetGroupArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or\n\t\t\ttask set.
\nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a\n\t\t\tClassic Load Balancer, omit the target group ARN.
\nFor services using the ECS deployment controller, you can specify one or\n\t\t\tmultiple target groups. For more information, see Registering multiple target groups with a service in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY deployment controller, you're required\n\t\t\tto define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
If your service's task definition uses the awsvpc network mode, you\n\t\t\t\tmust choose ip as the target type, not instance. Do this\n\t\t\t\twhen creating your target groups because tasks that use the awsvpc\n\t\t\t\tnetwork mode are associated with an elastic network interface, not an Amazon EC2\n\t\t\t\tinstance. This network mode is required for the Fargate launch\n\t\t\t\ttype.
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or\n\t\t\ttask set.
\nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.
\nFor services using the ECS deployment controller, you can specify one or\n\t\t\tmultiple target groups. For more information, see Registering multiple target groups with a service in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY deployment controller, you're required\n\t\t\tto define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
If your service's task definition uses the awsvpc network mode, you\n\t\t\t\tmust choose ip as the target type, not instance. Do this\n\t\t\t\twhen creating your target groups because tasks that use the awsvpc\n\t\t\t\tnetwork mode are associated with an elastic network interface, not an Amazon EC2\n\t\t\t\tinstance. This network mode is required for the Fargate launch\n\t\t\t\ttype.
The name of the load balancer to associate with the Amazon ECS service or task set.
\nA load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer\n\t\t\tor a Network Load Balancer the load balancer name parameter should be omitted.
" + "smithy.api#documentation": "The name of the load balancer to associate with the Amazon ECS service or task set.
\nIf you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be\n\t\t\tomitted.
" } }, "containerName": { @@ -6960,7 +7461,7 @@ } }, "traits": { - "smithy.api#documentation": "The log configuration for the container. This parameter maps to LogConfig\n\t\t\tin the Create a container section of the Docker Remote API and the\n\t\t\t\t--log-driver option to \n docker\n\t\t\t\t\trun\n .
By default, containers use the same logging driver that the Docker daemon uses.\n\t\t\tHowever, the container might use a different logging driver than the Docker daemon by\n\t\t\tspecifying a log driver configuration in the container definition. For more information\n\t\t\tabout the options for different supported log drivers, see Configure logging\n\t\t\t\tdrivers in the Docker documentation.
\nUnderstand the following when specifying a log configuration for your\n\t\t\tcontainers.
\nAmazon ECS currently supports a subset of the logging drivers available to the\n\t\t\t\t\tDocker daemon (shown in the valid values below). Additional log drivers may be\n\t\t\t\t\tavailable in future releases of the Amazon ECS container agent.
\nThis parameter requires version 1.18 of the Docker Remote API or greater on\n\t\t\t\t\tyour container instance.
\nFor tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must\n\t\t\t\t\tregister the available logging drivers with the\n\t\t\t\t\t\tECS_AVAILABLE_LOGGING_DRIVERS environment variable before\n\t\t\t\t\tcontainers placed on that instance can use these log configuration options. For\n\t\t\t\t\tmore information, see Amazon ECS container agent configuration in the\n\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
For tasks that are on Fargate, because you don't have access to the\n\t\t\t\t\tunderlying infrastructure your tasks are hosted on, any additional software\n\t\t\t\t\tneeded must be installed outside of the task. For example, the Fluentd output\n\t\t\t\t\taggregators or a remote host running Logstash to send Gelf logs to.
\nThe log configuration for the container. This parameter maps to LogConfig\n\t\t\tin the Create a container section of the Docker Remote API and the\n\t\t\t\t--log-driver option to \n docker\n\t\t\t\t\trun\n .
By default, containers use the same logging driver that the Docker daemon uses.\n\t\t\tHowever, the container might use a different logging driver than the Docker daemon by\n\t\t\tspecifying a log driver configuration in the container definition. For more information\n\t\t\tabout the options for different supported log drivers, see Configure logging\n\t\t\t\tdrivers in the Docker documentation.
\nUnderstand the following when specifying a log configuration for your\n\t\t\tcontainers.
\nAmazon ECS currently supports a subset of the logging drivers available to the Docker daemon.\n\t\t\t\t\tAdditional log drivers may be available in future releases of the Amazon ECS\n\t\t\t\t\tcontainer agent.
\nFor tasks on Fargate, the supported log drivers are awslogs,\n\t\t\t\t\t\tsplunk, and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are\n\t\t\t\t\t\tawslogs, fluentd, gelf,\n\t\t\t\t\t\tjson-file, journald,\n\t\t\t\t\t\tlogentries,syslog, splunk, and\n\t\t\t\t\t\tawsfirelens.
This parameter requires version 1.18 of the Docker Remote API or greater on\n\t\t\t\t\tyour container instance.
\nFor tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must\n\t\t\t\t\tregister the available logging drivers with the\n\t\t\t\t\t\tECS_AVAILABLE_LOGGING_DRIVERS environment variable before\n\t\t\t\t\tcontainers placed on that instance can use these log configuration options. For\n\t\t\t\t\tmore information, see Amazon ECS container agent configuration in the\n\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
For tasks that are on Fargate, because you don't have access to the\n\t\t\t\t\tunderlying infrastructure your tasks are hosted on, any additional software\n\t\t\t\t\tneeded must be installed outside of the task. For example, the Fluentd output\n\t\t\t\t\taggregators or a remote host running Logstash to send Gelf logs to.
\nThe maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale\n\t\t\tin process is not affected by this parameter. If this parameter is omitted, the default\n\t\t\tvalue of 1 is used.
The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in\n\t\t\tprocess is not affected by this parameter. If this parameter is omitted, the default\n\t\t\tvalue of 10000 is used.
The port number on the container instance to reserve for your container.
\nIf you specify a containerPortRange, leave this field empty and the value of\n\t\t\tthe hostPort is set as follows:
For containers in a task with the awsvpc network mode, the\n\t\t\t\t\t\thostPort is set to the same value as the\n\t\t\t\t\t\tcontainerPort. This is a static mapping strategy.
For containers in a task with the bridge network mode, the Amazon ECS agent finds\n\t\t\t\t\topen ports on the host and automatically binds them to the container ports. This\n\t\t\t\t\tis a dynamic mapping strategy.
If you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, the hostPort can either be left blank or set to the same\n\t\t\tvalue as the containerPort.
If you use containers in a task with the bridge network mode, you can\n\t\t\tspecify a non-reserved host port for your container port mapping, or you can omit the\n\t\t\t\thostPort (or set it to 0) while specifying a\n\t\t\t\tcontainerPort and your container automatically receives a port in the\n\t\t\tephemeral port range for your container instance operating system and Docker\n\t\t\tversion.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the\n\t\t\tinstance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel\n\t\t\tparameter is unavailable, the default ephemeral port range from 49153 through 65535 is\n\t\t\tused. Do not attempt to specify a host port in the ephemeral port range as these are\n\t\t\treserved for automatic assignment. In general, ports below 32768 are outside of the\n\t\t\tephemeral port range.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the\n\t\t\tAmazon ECS container agent ports 51678-51680. Any host port that was previously specified in\n\t\t\ta running task is also reserved while the task is running. That is, after a task stops,\n\t\t\tthe host port is released. The current reserved ports are displayed in the\n\t\t\tremainingResources of DescribeContainerInstances\n\t\t\toutput. A container instance can have up to 100 reserved ports at a time. This number\n\t\t\tincludes the default reserved ports. Automatically assigned ports aren't included in the\n\t\t\t100 reserved ports quota.
The port number on the container instance to reserve for your container.
\nIf you specify a containerPortRange, leave this field empty and the value of\n\t\t\tthe hostPort is set as follows:
For containers in a task with the awsvpc network mode, the\n\t\t\t\t\t\thostPort is set to the same value as the\n\t\t\t\t\t\tcontainerPort. This is a static mapping strategy.
For containers in a task with the bridge network mode, the Amazon ECS agent finds\n\t\t\t\t\topen ports on the host and automatically binds them to the container ports. This\n\t\t\t\t\tis a dynamic mapping strategy.
If you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, the hostPort can either be left blank or set to the same\n\t\t\tvalue as the containerPort.
If you use containers in a task with the bridge network mode, you can\n\t\t\tspecify a non-reserved host port for your container port mapping, or you can omit the\n\t\t\t\thostPort (or set it to 0) while specifying a\n\t\t\t\tcontainerPort and your container automatically receives a port in the\n\t\t\tephemeral port range for your container instance operating system and Docker\n\t\t\tversion.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the\n\t\t\tinstance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel\n\t\t\tparameter is unavailable, the default ephemeral port range from 49153 through 65535\n\t\t\t(Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port\n\t\t\tin the ephemeral port range as these are reserved for automatic assignment. In general,\n\t\t\tports below 32768 are outside of the ephemeral port range.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the\n\t\t\tAmazon ECS container agent ports 51678-51680. Any host port that was previously specified in\n\t\t\ta running task is also reserved while the task is running. That is, after a task stops,\n\t\t\tthe host port is released. The current reserved ports are displayed in the\n\t\t\tremainingResources of DescribeContainerInstances\n\t\t\toutput. A container instance can have up to 100 reserved ports at a time. This number\n\t\t\tincludes the default reserved ports. Automatically assigned ports aren't included in the\n\t\t\t100 reserved ports quota.
Modifies an account setting. Account settings are set on a per-Region basis.
\nIf you change the root user account setting, the default settings are reset for users\n\t\t\tand roles that do not have specified individual account settings. For more information,\n\t\t\tsee Account\n\t\t\t\tSettings in the Amazon Elastic Container Service Developer Guide.
\nWhen serviceLongArnFormat, taskLongArnFormat, or\n\t\t\t\tcontainerInstanceLongArnFormat are specified, the Amazon Resource Name\n\t\t\t(ARN) and resource ID format of the resource type for a specified user, role, or\n\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting must be\n\t\t\tset for each Amazon ECS resource separately. The ARN and resource ID format of a resource\n\t\t\tis defined by the opt-in status of the user or role that created the resource. You\n\t\t\tmust turn on this setting to use Amazon ECS features such as resource tagging.
When awsvpcTrunking is specified, the elastic network interface (ENI)\n\t\t\tlimit for any new container instances that support the feature is changed. If\n\t\t\t\tawsvpcTrunking is turned on, any new container instances that support the\n\t\t\tfeature are launched have the increased ENI limits available to them. For more\n\t\t\tinformation, see Elastic Network\n\t\t\t\tInterface Trunking in the Amazon Elastic Container Service Developer Guide.
When containerInsights is specified, the default setting indicating whether\n\t\t\tAmazon Web Services CloudWatch Container Insights is turned on for your clusters is changed. If\n\t\t\t\tcontainerInsights is turned on, any new clusters that are created will\n\t\t\thave Container Insights turned on unless you disable it during cluster creation. For\n\t\t\tmore information, see CloudWatch\n\t\t\t\tContainer Insights in the Amazon Elastic Container Service Developer Guide.
Amazon ECS is introducing tagging authorization for resource creation. Users must have\n\t\t\tpermissions for actions that create the resource, such as ecsCreateCluster.\n\t\t\tIf tags are specified when you create a resource, Amazon Web Services performs additional\n\t\t\tauthorization to verify if users or roles have permissions to create tags. Therefore,\n\t\t\tyou must grant explicit permissions to use the ecs:TagResource action. For\n\t\t\tmore information, see Grant\n\t\t\t\tpermission to tag resources on creation in the Amazon ECS Developer\n\t\t\t\t\tGuide.
Modifies an account setting. Account settings are set on a per-Region basis.
\nIf you change the root user account setting, the default settings are reset for users\n\t\t\tand roles that do not have specified individual account settings. For more information,\n\t\t\tsee Account\n\t\t\t\tSettings in the Amazon Elastic Container Service Developer Guide.
\nWhen serviceLongArnFormat, taskLongArnFormat, or\n\t\t\t\tcontainerInstanceLongArnFormat are specified, the Amazon Resource Name\n\t\t\t(ARN) and resource ID format of the resource type for a specified user, role, or\n\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting must be\n\t\t\tset for each Amazon ECS resource separately. The ARN and resource ID format of a resource\n\t\t\tis defined by the opt-in status of the user or role that created the resource. You\n\t\t\tmust turn on this setting to use Amazon ECS features such as resource tagging.
When awsvpcTrunking is specified, the elastic network interface (ENI)\n\t\t\tlimit for any new container instances that support the feature is changed. If\n\t\t\t\tawsvpcTrunking is turned on, any new container instances that support the\n\t\t\tfeature are launched have the increased ENI limits available to them. For more\n\t\t\tinformation, see Elastic Network\n\t\t\t\tInterface Trunking in the Amazon Elastic Container Service Developer Guide.
When containerInsights is specified, the default setting indicating whether\n\t\t\tAmazon Web Services CloudWatch Container Insights is turned on for your clusters is changed. If\n\t\t\t\tcontainerInsights is turned on, any new clusters that are created will\n\t\t\thave Container Insights turned on unless you disable it during cluster creation. For\n\t\t\tmore information, see CloudWatch\n\t\t\t\tContainer Insights in the Amazon Elastic Container Service Developer Guide.
Amazon ECS is introducing tagging authorization for resource creation. Users must have\n\t\t\tpermissions for actions that create the resource, such as ecsCreateCluster.\n\t\t\tIf tags are specified when you create a resource, Amazon Web Services performs additional\n\t\t\tauthorization to verify if users or roles have permissions to create tags. Therefore,\n\t\t\tyou must grant explicit permissions to use the ecs:TagResource action. For\n\t\t\tmore information, see Grant\n\t\t\t\tpermission to tag resources on creation in the Amazon ECS Developer\n\t\t\t\t\tGuide.
Modifies an account setting for all users on an account for whom no individual\n\t\t\taccount setting has been specified. Account settings are set on a per-Region\n\t\t\tbasis.
" + "smithy.api#documentation": "Modifies an account setting for all users on an account for whom no individual\n\t\t\taccount setting has been specified. Account settings are set on a per-Region\n\t\t\tbasis.
", + "smithy.api#examples": [ + { + "title": "To modify the default account settings for all IAM users or roles on an account", + "documentation": "This example modifies the default account setting for the specified resource for all IAM users or roles on an account. These changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.", + "input": { + "name": "serviceLongArnFormat", + "value": "enabled" + }, + "output": { + "setting": { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::Registers a new task definition from the supplied family and\n\t\t\t\tcontainerDefinitions. Optionally, you can add data volumes to your\n\t\t\tcontainers with the volumes parameter. For more information about task\n\t\t\tdefinition parameters and defaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.
You can specify a role for your task with the taskRoleArn parameter.\n\t\t\tWhen you specify a role for a task, its containers can then use the latest versions\n\t\t\tof the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in\n\t\t\tthe policy that's associated with the role. For more information, see IAM\n\t\t\t\tRoles for Tasks in the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition\n\t\t\twith the networkMode parameter. The available network modes correspond to\n\t\t\tthose described in Network\n\t\t\t\tsettings in the Docker run reference. If you specify the awsvpc\n\t\t\tnetwork mode, the task is allocated an elastic network interface, and you must specify a\n\t\t\t\tNetworkConfiguration when you create a service or run a task with\n\t\t\tthe task definition. For more information, see Task Networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
Registers a new task definition from the supplied family and\n\t\t\t\tcontainerDefinitions. Optionally, you can add data volumes to your\n\t\t\tcontainers with the volumes parameter. For more information about task\n\t\t\tdefinition parameters and defaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.
You can specify a role for your task with the taskRoleArn parameter.\n\t\t\tWhen you specify a role for a task, its containers can then use the latest versions\n\t\t\tof the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in\n\t\t\tthe policy that's associated with the role. For more information, see IAM\n\t\t\t\tRoles for Tasks in the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition\n\t\t\twith the networkMode parameter. The available network modes correspond to\n\t\t\tthose described in Network\n\t\t\t\tsettings in the Docker run reference. If you specify the awsvpc\n\t\t\tnetwork mode, the task is allocated an elastic network interface, and you must specify a\n\t\t\t\tNetworkConfiguration when you create a service or run a task with\n\t\t\tthe task definition. For more information, see Task Networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
Starts a new task using the specified task definition.
\nYou can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the Amazon Elastic Container Service Developer Guide.
\nAlternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.
\nStarting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
\nThe Amazon ECS API follows an eventual consistency model. This is because of the\n\t\t\tdistributed nature of the system supporting the API. This means that the result of an\n\t\t\tAPI command you run that affects your Amazon ECS resources might not be immediately visible\n\t\t\tto all subsequent commands you run. Keep this in mind when you carry out an API command\n\t\t\tthat immediately follows a previous API command.
\nTo manage eventual consistency, you can do the following:
\nConfirm the state of the resource before you run a command to modify it. Run\n\t\t\t\t\tthe DescribeTasks command using an exponential backoff algorithm to ensure that\n\t\t\t\t\tyou allow enough time for the previous command to propagate through the system.\n\t\t\t\t\tTo do this, run the DescribeTasks command repeatedly, starting with a couple of\n\t\t\t\t\tseconds of wait time and increasing gradually up to five minutes of wait\n\t\t\t\t\ttime.
\nAdd wait time between subsequent commands, even if the DescribeTasks command\n\t\t\t\t\treturns an accurate response. Apply an exponential backoff algorithm starting\n\t\t\t\t\twith a couple of seconds of wait time, and increase gradually up to about five\n\t\t\t\t\tminutes of wait time.
\nStarts a new task using the specified task definition.
\nYou can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the Amazon Elastic Container Service Developer Guide.
\nAlternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.
\nStarting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
\nThe Amazon ECS API follows an eventual consistency model. This is because of the\n\t\t\tdistributed nature of the system supporting the API. This means that the result of an\n\t\t\tAPI command you run that affects your Amazon ECS resources might not be immediately visible\n\t\t\tto all subsequent commands you run. Keep this in mind when you carry out an API command\n\t\t\tthat immediately follows a previous API command.
\nTo manage eventual consistency, you can do the following:
\nConfirm the state of the resource before you run a command to modify it. Run\n\t\t\t\t\tthe DescribeTasks command using an exponential backoff algorithm to ensure that\n\t\t\t\t\tyou allow enough time for the previous command to propagate through the system.\n\t\t\t\t\tTo do this, run the DescribeTasks command repeatedly, starting with a couple of\n\t\t\t\t\tseconds of wait time and increasing gradually up to five minutes of wait\n\t\t\t\t\ttime.
\nAdd wait time between subsequent commands, even if the DescribeTasks command\n\t\t\t\t\treturns an accurate response. Apply an exponential backoff algorithm starting\n\t\t\t\t\twith a couple of seconds of wait time, and increase gradually up to about five\n\t\t\t\t\tminutes of wait time.
\nAssociates the specified tags to a resource with the specified\n\t\t\t\tresourceArn. If existing tags on a resource aren't specified in the\n\t\t\trequest parameters, they aren't changed. When a resource is deleted, the tags that are\n\t\t\tassociated with that resource are deleted as well.
Associates the specified tags to a resource with the specified\n\t\t\t\tresourceArn. If existing tags on a resource aren't specified in the\n\t\t\trequest parameters, they aren't changed. When a resource is deleted, the tags that are\n\t\t\tassociated with that resource are deleted as well.
The stop code indicating why a task was stopped. The stoppedReason might\n\t\t\tcontain additional details.
The following are valid values:
\n\n TaskFailedToStart\n
\n EssentialContainerExited\n
\n UserInitiated\n
\n TerminationNotice\n
\n ServiceSchedulerInitiated\n
\n SpotInterruption\n
The stop code indicating why a task was stopped. The stoppedReason might\n\t\t\tcontain additional details.
For more information about stop code, see Stopped tasks error codes in the Amazon ECS User Guide.
\nThe following are valid values:
\n\n TaskFailedToStart\n
\n EssentialContainerExited\n
\n UserInitiated\n
\n TerminationNotice\n
\n ServiceSchedulerInitiated\n
\n SpotInterruption\n
The Unix timestamp for the time when the task stops. More specifically, it's for the\n\t\t\ttime when the task transitions from the RUNNING state to\n\t\t\t\tSTOPPED.
The Unix timestamp for the time when the task stops. More specifically, it's for the\n\t\t\ttime when the task transitions from the RUNNING state to\n\t\t\t\tSTOPPING.
The task launch types the task definition was validated against. For more information, see Amazon ECS launch types\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The task launch types the task definition was validated against. The valid values are\n\t\t\t\tEC2, FARGATE, and EXTERNAL. For more\n\t\t\tinformation, see Amazon ECS launch types\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
Deletes specified tags from a resource.
" + "smithy.api#documentation": "Deletes specified tags from a resource.
", + "smithy.api#examples": [ + { + "title": "To untag a cluster.", + "documentation": "This example deletes the 'team' tag from the 'dev' cluster.", + "input": { + "resourceArn": "arn:aws:ecs:region:aws_account_id:cluster/dev", + "tagKeys": [ + "team" + ] + }, + "output": {} + } + ] } }, "com.amazonaws.ecs#UntagResourceRequest": { @@ -11438,7 +12087,18 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the parameters of a service.
\nFor services using the rolling update (ECS) you can update the desired\n\t\t\tcount, deployment configuration, network configuration, load balancers, service\n\t\t\tregistries, enable ECS managed tags option, propagate tags option, task placement\n\t\t\tconstraints and strategies, and task definition. When you update any of these\n\t\t\tparameters, Amazon ECS starts new tasks with the new configuration.
For services using the blue/green (CODE_DEPLOY) deployment controller,\n\t\t\tonly the desired count, deployment configuration, health check grace period, task\n\t\t\tplacement constraints and strategies, enable ECS managed tags option, and propagate tags\n\t\t\tcan be updated using this API. If the network configuration, platform version, task\n\t\t\tdefinition, or load balancer need to be updated, create a new CodeDeploy deployment. For more\n\t\t\tinformation, see CreateDeployment in the CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired\n\t\t\tcount, task placement constraints and strategies, health check grace period, enable ECS\n\t\t\tmanaged tags option, and propagate tags option, using this API. If the launch type, load\n\t\t\tbalancer, network configuration, platform version, or task definition need to be\n\t\t\tupdated, create a new task set For more information, see CreateTaskSet.
\nYou can add to or subtract from the number of instantiations of a task definition in a\n\t\t\tservice by specifying the cluster that the service is running in and a new\n\t\t\t\tdesiredCount parameter.
If you have updated the Docker image of your application, you can create a new task\n\t\t\tdefinition with that image and deploy it to your service. The service scheduler uses the\n\t\t\tminimum healthy percent and maximum percent parameters (in the service's deployment\n\t\t\tconfiguration) to determine the deployment strategy.
\nIf your updated Docker image uses the same tag as what is in the existing task\n\t\t\t\tdefinition for your service (for example, my_image:latest), you don't\n\t\t\t\tneed to create a new revision of your task definition. You can update the service\n\t\t\t\tusing the forceNewDeployment option. The new tasks launched by the\n\t\t\t\tdeployment pull the current image/tag combination from your repository when they\n\t\t\t\tstart.
You can also update the deployment configuration of a service. When a deployment is\n\t\t\ttriggered by updating the task definition of a service, the service scheduler uses the\n\t\t\tdeployment configuration parameters, minimumHealthyPercent and\n\t\t\t\tmaximumPercent, to determine the deployment strategy.
If minimumHealthyPercent is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount temporarily during a deployment. For example, if\n\t\t\t\t\t\tdesiredCount is four tasks, a minimum of 50% allows the\n\t\t\t\t\tscheduler to stop two existing tasks before starting two new tasks. Tasks for\n\t\t\t\t\tservices that don't use a load balancer are considered healthy if they're in the\n\t\t\t\t\t\tRUNNING state. Tasks for services that use a load balancer are\n\t\t\t\t\tconsidered healthy if they're in the RUNNING state and are reported\n\t\t\t\t\tas healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the\n\t\t\t\t\tnumber of running tasks during a deployment. You can use it to define the\n\t\t\t\t\tdeployment batch size. For example, if desiredCount is four tasks,\n\t\t\t\t\ta maximum of 200% starts four new tasks before stopping the four older tasks\n\t\t\t\t\t(provided that the cluster resources required to do this are available).
When UpdateService stops a task during a deployment, the equivalent\n\t\t\tof docker stop is issued to the containers running in the task. This\n\t\t\tresults in a SIGTERM and a 30-second timeout. After this,\n\t\t\t\tSIGKILL is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM gracefully and exits within 30 seconds from\n\t\t\treceiving it, no SIGKILL is sent.
When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster with the following logic.
\nDetermine which of the container instances in your cluster can support your\n\t\t\t\t\tservice's task definition. For example, they have the required CPU, memory,\n\t\t\t\t\tports, and container instance attributes.
\nBy default, the service scheduler attempts to balance tasks across\n\t\t\t\t\tAvailability Zones in this manner even though you can choose a different\n\t\t\t\t\tplacement strategy.
\nSort the valid container instances by the fewest number of running\n\t\t\t\t\t\t\ttasks for this service in the same Availability Zone as the instance.\n\t\t\t\t\t\t\tFor example, if zone A has one running service task and zones B and C\n\t\t\t\t\t\t\teach have zero, valid container instances in either zone B or C are\n\t\t\t\t\t\t\tconsidered optimal for placement.
\nPlace the new service task on a valid container instance in an optimal\n\t\t\t\t\t\t\tAvailability Zone (based on the previous steps), favoring container\n\t\t\t\t\t\t\tinstances with the fewest number of running tasks for this\n\t\t\t\t\t\t\tservice.
\nWhen the service scheduler stops running tasks, it attempts to maintain balance across\n\t\t\tthe Availability Zones in your cluster using the following logic:
\nSort the container instances by the largest number of running tasks for this\n\t\t\t\t\tservice in the same Availability Zone as the instance. For example, if zone A\n\t\t\t\t\thas one running service task and zones B and C each have two, container\n\t\t\t\t\tinstances in either zone B or C are considered optimal for termination.
\nStop the task on a container instance in an optimal Availability Zone (based\n\t\t\t\t\ton the previous steps), favoring container instances with the largest number of\n\t\t\t\t\trunning tasks for this service.
\nYou must have a service-linked role when you update any of the following service\n\t\t\t\tproperties. If you specified a custom role when you created the service, Amazon ECS\n\t\t\t\tautomatically replaces the roleARN associated with the service with the ARN of your\n\t\t\t\tservice-linked role. For more information, see Service-linked roles in the Amazon Elastic Container Service Developer Guide.
\n\n loadBalancers,\n
\n serviceRegistries\n
Modifies the parameters of a service.
\nFor services using the rolling update (ECS) you can update the desired\n\t\t\tcount, deployment configuration, network configuration, load balancers, service\n\t\t\tregistries, enable ECS managed tags option, propagate tags option, task placement\n\t\t\tconstraints and strategies, and task definition. When you update any of these\n\t\t\tparameters, Amazon ECS starts new tasks with the new configuration.
For services using the blue/green (CODE_DEPLOY) deployment controller,\n\t\t\tonly the desired count, deployment configuration, health check grace period, task\n\t\t\tplacement constraints and strategies, enable ECS managed tags option, and propagate tags\n\t\t\tcan be updated using this API. If the network configuration, platform version, task\n\t\t\tdefinition, or load balancer need to be updated, create a new CodeDeploy deployment. For more\n\t\t\tinformation, see CreateDeployment in the CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired\n\t\t\tcount, task placement constraints and strategies, health check grace period, enable ECS\n\t\t\tmanaged tags option, and propagate tags option, using this API. If the launch type, load\n\t\t\tbalancer, network configuration, platform version, or task definition need to be\n\t\t\tupdated, create a new task set For more information, see CreateTaskSet.
\nYou can add to or subtract from the number of instantiations of a task definition in a\n\t\t\tservice by specifying the cluster that the service is running in and a new\n\t\t\t\tdesiredCount parameter.
If you have updated the Docker image of your application, you can create a new task\n\t\t\tdefinition with that image and deploy it to your service. The service scheduler uses the\n\t\t\tminimum healthy percent and maximum percent parameters (in the service's deployment\n\t\t\tconfiguration) to determine the deployment strategy.
\nIf your updated Docker image uses the same tag as what is in the existing task\n\t\t\t\tdefinition for your service (for example, my_image:latest), you don't\n\t\t\t\tneed to create a new revision of your task definition. You can update the service\n\t\t\t\tusing the forceNewDeployment option. The new tasks launched by the\n\t\t\t\tdeployment pull the current image/tag combination from your repository when they\n\t\t\t\tstart.
You can also update the deployment configuration of a service. When a deployment is\n\t\t\ttriggered by updating the task definition of a service, the service scheduler uses the\n\t\t\tdeployment configuration parameters, minimumHealthyPercent and\n\t\t\t\tmaximumPercent, to determine the deployment strategy.
If minimumHealthyPercent is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount temporarily during a deployment. For example, if\n\t\t\t\t\t\tdesiredCount is four tasks, a minimum of 50% allows the\n\t\t\t\t\tscheduler to stop two existing tasks before starting two new tasks. Tasks for\n\t\t\t\t\tservices that don't use a load balancer are considered healthy if they're in the\n\t\t\t\t\t\tRUNNING state. Tasks for services that use a load balancer are\n\t\t\t\t\tconsidered healthy if they're in the RUNNING state and are reported\n\t\t\t\t\tas healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the\n\t\t\t\t\tnumber of running tasks during a deployment. You can use it to define the\n\t\t\t\t\tdeployment batch size. For example, if desiredCount is four tasks,\n\t\t\t\t\ta maximum of 200% starts four new tasks before stopping the four older tasks\n\t\t\t\t\t(provided that the cluster resources required to do this are available).
When UpdateService stops a task during a deployment, the equivalent\n\t\t\tof docker stop is issued to the containers running in the task. This\n\t\t\tresults in a SIGTERM and a 30-second timeout. After this,\n\t\t\t\tSIGKILL is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM gracefully and exits within 30 seconds from\n\t\t\treceiving it, no SIGKILL is sent.
When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster with the following logic.
\nDetermine which of the container instances in your cluster can support your\n\t\t\t\t\tservice's task definition. For example, they have the required CPU, memory,\n\t\t\t\t\tports, and container instance attributes.
\nBy default, the service scheduler attempts to balance tasks across\n\t\t\t\t\tAvailability Zones in this manner even though you can choose a different\n\t\t\t\t\tplacement strategy.
\nSort the valid container instances by the fewest number of running\n\t\t\t\t\t\t\ttasks for this service in the same Availability Zone as the instance.\n\t\t\t\t\t\t\tFor example, if zone A has one running service task and zones B and C\n\t\t\t\t\t\t\teach have zero, valid container instances in either zone B or C are\n\t\t\t\t\t\t\tconsidered optimal for placement.
\nPlace the new service task on a valid container instance in an optimal\n\t\t\t\t\t\t\tAvailability Zone (based on the previous steps), favoring container\n\t\t\t\t\t\t\tinstances with the fewest number of running tasks for this\n\t\t\t\t\t\t\tservice.
\nWhen the service scheduler stops running tasks, it attempts to maintain balance across\n\t\t\tthe Availability Zones in your cluster using the following logic:
\nSort the container instances by the largest number of running tasks for this\n\t\t\t\t\tservice in the same Availability Zone as the instance. For example, if zone A\n\t\t\t\t\thas one running service task and zones B and C each have two, container\n\t\t\t\t\tinstances in either zone B or C are considered optimal for termination.
\nStop the task on a container instance in an optimal Availability Zone (based\n\t\t\t\t\ton the previous steps), favoring container instances with the largest number of\n\t\t\t\t\trunning tasks for this service.
\nYou must have a service-linked role when you update any of the following service\n\t\t\t\tproperties:
\n\n loadBalancers,
\n serviceRegistries\n
For more information about the role see the CreateService request parameter\n\t\t\t\t\n role\n .
Updates the protection status of a task. You can set protectionEnabled to\n\t\t\t\ttrue to protect your task from termination during scale-in events from\n\t\t\t\tService\n\t\t\t\tAutoscaling or deployments.
Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the\n\t\t\t\tprotectionEnabled property making the task eligible for termination by\n\t\t\ta subsequent scale-in event.
You can specify a custom expiration period for task protection from 1 minute to up to\n\t\t\t2,880 minutes (48 hours). To specify the custom expiration period, set the\n\t\t\t\texpiresInMinutes property. The expiresInMinutes property\n\t\t\tis always reset when you invoke this operation for a task that already has\n\t\t\t\tprotectionEnabled set to true. You can keep extending the\n\t\t\tprotection expiration period of a task by invoking this operation repeatedly.
To learn more about Amazon ECS task protection, see Task scale-in\n\t\t\t\tprotection in the \n Amazon Elastic Container Service Developer Guide\n .
\nThis operation is only supported for tasks belonging to an Amazon ECS service. Invoking\n\t\t\t\tthis operation for a standalone task will result in an TASK_NOT_VALID\n\t\t\t\tfailure. For more information, see API failure\n\t\t\t\t\treasons.
If you prefer to set task protection from within the container, we recommend using\n\t\t\t\tthe Task scale-in protection endpoint.
\nUpdates the protection status of a task. You can set protectionEnabled to\n\t\t\t\ttrue to protect your task from termination during scale-in events from\n\t\t\t\tService\n\t\t\t\tAutoscaling or deployments.
Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the\n\t\t\t\tprotectionEnabled property making the task eligible for termination by\n\t\t\ta subsequent scale-in event.
You can specify a custom expiration period for task protection from 1 minute to up to\n\t\t\t2,880 minutes (48 hours). To specify the custom expiration period, set the\n\t\t\t\texpiresInMinutes property. The expiresInMinutes property\n\t\t\tis always reset when you invoke this operation for a task that already has\n\t\t\t\tprotectionEnabled set to true. You can keep extending the\n\t\t\tprotection expiration period of a task by invoking this operation repeatedly.
To learn more about Amazon ECS task protection, see Task scale-in\n\t\t\t\tprotection in the \n Amazon Elastic Container Service Developer Guide\n .
\nThis operation is only supported for tasks belonging to an Amazon ECS service. Invoking\n\t\t\t\tthis operation for a standalone task will result in an TASK_NOT_VALID\n\t\t\t\tfailure. For more information, see API failure\n\t\t\t\t\treasons.
If you prefer to set task protection from within the container, we recommend using\n\t\t\t\tthe Task scale-in protection endpoint.
\nThe name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This name is referenced in the\n\t\t\t\tsourceVolume parameter of container definition\n\t\t\tmountPoints.
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This name is referenced in the\n\t\t\t\tsourceVolume parameter of container definition\n\t\t\tmountPoints.
This is required wwhen you use an Amazon EFS volume.
" } }, "host": { diff --git a/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.2015-12-01.json b/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.2015-12-01.json index f26c91a9244..6908eedf382 100644 --- a/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.2015-12-01.json +++ b/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.2015-12-01.json @@ -937,7 +937,7 @@ "SecurityGroups": { "target": "com.amazonaws.elasticloadbalancingv2#SecurityGroups", "traits": { - "smithy.api#documentation": "[Application Load Balancers] The IDs of the security groups for the load balancer.
" + "smithy.api#documentation": "[Application Load Balancers and Network Load Balancers] The IDs of the security groups for\n the load balancer.
" } }, "Scheme": { @@ -1459,7 +1459,7 @@ } ], "traits": { - "smithy.api#documentation": "Deregisters the specified targets from the specified target group. After the targets are\n deregistered, they no longer receive traffic from the load balancer.
" + "smithy.api#documentation": "Deregisters the specified targets from the specified target group. After the targets are\n deregistered, they no longer receive traffic from the load balancer.
\nNote: If the specified target does not exist, the action returns successfully.
" } }, "com.amazonaws.elasticloadbalancingv2#DeregisterTargetsInput": { @@ -3564,6 +3564,26 @@ } } }, + "com.amazonaws.elasticloadbalancingv2#EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic": { + "type": "string" + }, + "com.amazonaws.elasticloadbalancingv2#EnforceSecurityGroupInboundRulesOnPrivateLinkTrafficEnum": { + "type": "enum", + "members": { + "on": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "on" + } + }, + "off": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "off" + } + } + } + }, "com.amazonaws.elasticloadbalancingv2#ErrorDescription": { "type": "string" }, @@ -3910,7 +3930,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about an Elastic Load Balancing resource limit for your Amazon Web Services\n account.
" + "smithy.api#documentation": "Information about an Elastic Load Balancing resource limit for your Amazon Web Services\n account.
\nFor more information, see the following:
\n[Application Load Balancers on Outposts] The ID of the customer-owned address pool.
" } + }, + "EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic": { + "target": "com.amazonaws.elasticloadbalancingv2#EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic", + "traits": { + "smithy.api#documentation": "Indicates whether to evaluate inbound security group rules for traffic sent to a \n Network Load Balancer through Amazon Web Services PrivateLink.
" + } } }, "traits": { @@ -5338,7 +5364,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about a condition for a rule.
\nEach rule can optionally include up to one of each of the following conditions:\n http-request-method, host-header, path-pattern, and\n source-ip. Each rule can also optionally include one or more of each of the\n following conditions: http-header and query-string. Note that the\n value for a condition cannot be empty.
Information about a condition for a rule.
\nEach rule can optionally include up to one of each of the following conditions:\n http-request-method, host-header, path-pattern, and\n source-ip. Each rule can also optionally include one or more of each of the\n following conditions: http-header and query-string. Note that the\n value for a condition cannot be empty.
For more information, see Quotas for your\n Application Load Balancers.
" } }, "com.amazonaws.elasticloadbalancingv2#RuleConditionList": { @@ -5467,7 +5493,7 @@ "IpAddressType": { "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", "traits": { - "smithy.api#documentation": "The IP address type. The possible values are ipv4 (for IPv4 addresses) and\n dualstack (for IPv4 and IPv6 addresses).\n You can’t specify\n dualstack for a load balancer with a UDP or TCP_UDP listener.
The IP address type. The possible values are ipv4 (for IPv4 addresses) and\n dualstack (for IPv4 and IPv6 addresses). You can’t specify dualstack for a load balancer\n with a UDP or TCP_UDP listener.
Associates the specified security groups with the specified Application Load Balancer. The\n specified security groups override the previously associated security groups.
\nYou can't specify a security group for a Network Load Balancer or Gateway Load\n Balancer.
" + "smithy.api#documentation": "Associates the specified security groups with the specified Application Load Balancer or\n Network Load Balancer. The specified security groups override the previously associated\n security groups.
\nYou can't perform this operation on a Network Load Balancer unless you specified a\n security group for the load balancer when you created it.
\nYou can't associate a security group with a Gateway Load Balancer.
" } }, "com.amazonaws.elasticloadbalancingv2#SetSecurityGroupsInput": { @@ -5581,6 +5607,12 @@ "smithy.api#documentation": "The IDs of the security groups.
", "smithy.api#required": {} } + }, + "EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic": { + "target": "com.amazonaws.elasticloadbalancingv2#EnforceSecurityGroupInboundRulesOnPrivateLinkTrafficEnum", + "traits": { + "smithy.api#documentation": "Indicates whether to evaluate inbound security group rules for traffic sent to a \n Network Load Balancer through Amazon Web Services PrivateLink. The default is on.
The IDs of the security groups associated with the load balancer.
" } + }, + "EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic": { + "target": "com.amazonaws.elasticloadbalancingv2#EnforceSecurityGroupInboundRulesOnPrivateLinkTrafficEnum", + "traits": { + "smithy.api#documentation": "Indicates whether to evaluate inbound security group rules for traffic sent to a \n Network Load Balancer through Amazon Web Services PrivateLink.
" + } } }, "traits": { @@ -5658,7 +5696,7 @@ "IpAddressType": { "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", "traits": { - "smithy.api#documentation": "[Network Load Balancers] The type of IP addresses used by the subnets for your load\n balancer. The possible values are ipv4 (for IPv4 addresses) and\n dualstack (for IPv4 and IPv6 addresses). You can’t specify\n dualstack for a load balancer with a UDP or TCP_UDP listener.\n .
[Network Load Balancers] The type of IP addresses used by the subnets for your load\n balancer. The possible values are ipv4 (for IPv4 addresses) and\n dualstack (for IPv4 and IPv6 addresses). You can’t specify\n dualstack for a load balancer with a UDP or TCP_UDP listener.
The port on which the target is listening. If the target group protocol is GENEVE, the\n supported port is 6081. If the target type is alb, the targeted Application Load\n Balancer must have at least one listener whose port matches the target group port. Not used if\n the target is a Lambda function.
The port on which the target is listening. If the target group protocol is GENEVE, the\n supported port is 6081. If the target type is alb, the targeted Application Load\n Balancer must have at least one listener whose port matches the target group port. This \n parameter is not used if the target is a Lambda function.
The port on which the targets are listening. Not used if the target is a Lambda\n function.
" + "smithy.api#documentation": "The port on which the targets are listening. This parameter is not used if the target is \n a Lambda function.
" } }, "VpcId": { @@ -6036,7 +6074,7 @@ "LoadBalancerArns": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArns", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARN) of the load balancers that route traffic to this target\n group.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the load balancer that routes traffic to this target\n group. You can use each target group with only one load balancer.
" } }, "TargetType": { diff --git a/codegen/sdk-codegen/aws-models/elasticache.2015-02-02.json b/codegen/sdk-codegen/aws-models/elasticache.2015-02-02.json index 19aaeae5a00..e50ed4082f0 100644 --- a/codegen/sdk-codegen/aws-models/elasticache.2015-02-02.json +++ b/codegen/sdk-codegen/aws-models/elasticache.2015-02-02.json @@ -116,7 +116,7 @@ } ], "traits": { - "smithy.api#documentation": "A tag is a key-value pair where the key and value are case-sensitive. \n You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. \n For more information, see Resource-level permissions.
\n\n For example, you can use cost-allocation tags to your ElastiCache resources, \n Amazon generates a cost allocation report as a comma-separated value (CSV) file \n with your usage and costs aggregated by your tags. \n You can apply tags that represent business categories (such as cost centers, application names, or owners) \n to organize your costs across multiple services.
\nFor more information, \n see Using Cost Allocation Tags in Amazon ElastiCache \n in the ElastiCache User Guide.
" + "smithy.api#documentation": "A tag is a key-value pair where the key and value are case-sensitive. You can use tags\n to categorize and track all your ElastiCache resources, with the exception of global\n replication group. When you add or remove tags on replication groups, those actions will\n be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
\nFor example, you can use cost-allocation tags to your ElastiCache resources, Amazon\n generates a cost allocation report as a comma-separated value (CSV) file with your usage\n and costs aggregated by your tags. You can apply tags that represent business categories\n (such as cost centers, application names, or owners) to organize your costs across\n multiple services.
\nFor more information, see Using Cost Allocation Tags in\n Amazon ElastiCache in the ElastiCache User\n Guide.
" } }, "com.amazonaws.elasticache#AddTagsToResourceMessage": { @@ -125,14 +125,14 @@ "ResourceName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to which the tags are to be added, \n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster \n or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.\n ElastiCache resources are cluster and snapshot.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for\n example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or\n arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.\n ElastiCache resources are cluster and\n snapshot.
For more information about ARNs, see Amazon Resource Names (ARNs)\n and Amazon Service Namespaces.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. \n A tag key must be accompanied by a tag value, although null is accepted.
", + "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
", "smithy.api#required": {} } } @@ -157,18 +157,18 @@ "ScaleUpModifications": { "target": "com.amazonaws.elasticache#NodeTypeList", "traits": { - "smithy.api#documentation": "A string list, each element of which specifies a cache node type which you can use \n to scale your cluster or replication group.
\nWhen scaling up a Redis cluster or replication group using ModifyCacheCluster or\n ModifyReplicationGroup, \n use a value from this list for the CacheNodeType parameter.
A string list, each element of which specifies a cache node type which you can use to\n scale your cluster or replication group.
\nWhen scaling up a Redis cluster or replication group using\n ModifyCacheCluster or ModifyReplicationGroup, use a value\n from this list for the CacheNodeType parameter.
A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.\n \n When scaling down a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
" + "smithy.api#documentation": "A string list, each element of which specifies a cache node type which you can use to\n scale your cluster or replication group. When scaling down a Redis cluster or\n replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from\n this list for the CacheNodeType parameter.
" } } }, "traits": { - "smithy.api#documentation": "Represents the allowed node types you can use to modify your cluster or replication group.
" + "smithy.api#documentation": "Represents the allowed node types you can use to modify your cluster or replication\n group.
" } }, "com.amazonaws.elasticache#AmazonElastiCacheV9": { @@ -369,6 +369,9 @@ }, { "target": "com.amazonaws.elasticache#TestFailover" + }, + { + "target": "com.amazonaws.elasticache#TestMigration" } ], "traits": { @@ -383,7 +386,7 @@ "name": "elasticache" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "Amazon ElastiCache is a web service that makes it easier to set up, operate, \n and scale a distributed cache in the cloud.
\nWith ElastiCache, customers get all of the benefits of a high-performance, \n in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. \n The service makes setup, scaling, \n and cluster failure handling much simpler than in a self-managed cache deployment.
\nIn addition, through integration with Amazon CloudWatch, \n customers get enhanced visibility into the key performance statistics \n associated with their cache and can receive alarms if a part of their cache runs hot.
", + "smithy.api#documentation": "Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale\n a distributed cache in the cloud.
\nWith ElastiCache, customers get all of the benefits of a high-performance, in-memory\n cache with less of the administrative burden involved in launching and managing a\n distributed cache. The service makes setup, scaling, and cluster failure handling much\n simpler than in a self-managed cache deployment.
\nIn addition, through integration with Amazon CloudWatch, customers get enhanced\n visibility into the key performance statistics associated with their cache and can\n receive alarms if a part of their cache runs hot.
", "smithy.api#title": "Amazon ElastiCache", "smithy.api#xmlNamespace": { "uri": "http://elasticache.amazonaws.com/doc/2015-02-02/" @@ -1509,13 +1512,13 @@ "Type": { "target": "com.amazonaws.elasticache#InputAuthenticationType", "traits": { - "smithy.api#documentation": "Specifies the authentication type. Possible options are IAM authentication, password and no password.
" + "smithy.api#documentation": "Specifies the authentication type. Possible options are IAM authentication, password\n and no password.
" } }, "Passwords": { "target": "com.amazonaws.elasticache#PasswordListInput", "traits": { - "smithy.api#documentation": "Specifies the passwords to use for authentication if Type is set to password.
Specifies the passwords to use for authentication if Type is set to\n password.
The specified Amazon EC2 security group is already authorized for the specified cache security group.
", + "smithy.api#documentation": "The specified Amazon EC2 security group is already authorized for the specified cache\n security group.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1575,7 +1578,7 @@ "code": "AuthorizationNotFound", "httpResponseCode": 404 }, - "smithy.api#documentation": "The specified Amazon EC2 security group is not authorized for the specified cache security group.
", + "smithy.api#documentation": "The specified Amazon EC2 security group is not authorized for the specified cache\n security group.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -1606,7 +1609,7 @@ } ], "traits": { - "smithy.api#documentation": "Allows network ingress to a cache\n security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2\n security groups are used as the authorization mechanism.
\nYou cannot authorize ingress from an Amazon EC2 security group in one region to an\n ElastiCache cluster in another region.
\nAllows network ingress to a cache security group. Applications using ElastiCache must\n be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization\n mechanism.
\nYou cannot authorize ingress from an Amazon EC2 security group in one region to an\n ElastiCache cluster in another region.
\nThe Amazon EC2 security group to be authorized for ingress to the cache security group.
", + "smithy.api#documentation": "The Amazon EC2 security group to be authorized for ingress to the cache security\n group.
", "smithy.api#required": {} } }, "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The Amazon account number of the Amazon EC2 security group owner. \n Note that this is not the same thing as an Amazon access key ID - \n you must provide a valid Amazon account number for this parameter.
", + "smithy.api#documentation": "The Amazon account number of the Amazon EC2 security group owner. Note that this is\n not the same thing as an Amazon access key ID - you must provide a valid Amazon account\n number for this parameter.
", "smithy.api#required": {} } } @@ -1644,6 +1647,9 @@ "CacheSecurityGroup": { "target": "com.amazonaws.elasticache#CacheSecurityGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#AutomaticFailoverStatus": { @@ -1718,7 +1724,7 @@ } ], "traits": { - "smithy.api#documentation": "Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
" + "smithy.api#documentation": "Apply the service update. For more information on service updates and applying them,\n see Applying Service\n Updates.
" } }, "com.amazonaws.elasticache#BatchApplyUpdateActionMessage": { @@ -1762,7 +1768,7 @@ } ], "traits": { - "smithy.api#documentation": "Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
" + "smithy.api#documentation": "Stop the service update. For more information on service updates and stopping them,\n see Stopping\n Service Updates.
" } }, "com.amazonaws.elasticache#BatchStopUpdateActionMessage": { @@ -1804,31 +1810,31 @@ "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The user-supplied identifier of the cluster. \n This identifier is a unique key that identifies a cluster.
" + "smithy.api#documentation": "The user-supplied identifier of the cluster. This identifier is a unique key that\n identifies a cluster.
" } }, "ConfigurationEndpoint": { "target": "com.amazonaws.elasticache#Endpoint", "traits": { - "smithy.api#documentation": "Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster.\n The configuration endpoint will always have .cfg in it.
Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211\n
Represents a Memcached cluster endpoint which can be used by an application to connect\n to any node in the cluster. The configuration endpoint will always have\n .cfg in it.
Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211\n
The URL of the web page where you can download the latest ElastiCache client library.
" + "smithy.api#documentation": "The URL of the web page where you can download the latest ElastiCache client\n library.
" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the compute and memory capacity node type for the cluster.
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The name of the compute and memory capacity node type for the cluster.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1\n instances.
\nRedis configuration variables appendonly and\n appendfsync are not supported on Redis version 2.8.22 and\n later.
The name of the cache engine (memcached or \n redis) to be used for this cluster.
The name of the cache engine (memcached or redis) to be used\n for this cluster.
The current state of this cluster, one of the following values: \n available, \n creating, \n deleted, \n deleting,\n incompatible-network,\n modifying,\n rebooting cluster nodes,\n restore-failed, or \n snapshotting.
The current state of this cluster, one of the following values:\n available, creating, deleted,\n deleting, incompatible-network, modifying,\n rebooting cluster nodes, restore-failed, or\n snapshotting.
The number of cache nodes in the cluster.
\nFor clusters running Redis, this value must be 1. For clusters running Memcached, \n this value must be between 1 and 40.
" + "smithy.api#documentation": "The number of cache nodes in the cluster.
\nFor clusters running Redis, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.
" } }, "PreferredAvailabilityZone": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the Availability Zone in which the cluster is located or \"Multiple\" \n if the cache nodes are located in different Availability Zones.
" + "smithy.api#documentation": "The name of the Availability Zone in which the cluster is located or \"Multiple\" if the\n cache nodes are located in different Availability Zones.
" } }, "PreferredOutpostArn": { @@ -1870,7 +1876,7 @@ "PreferredMaintenanceWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.
\nValid values for ddd are:
\n sun\n
\n mon\n
\n tue\n
\n wed\n
\n thu\n
\n fri\n
\n sat\n
Example: sun:23:00-mon:01:30\n
Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
\nValid values for ddd are:
\n sun\n
\n mon\n
\n tue\n
\n wed\n
\n thu\n
\n fri\n
\n sat\n
Example: sun:23:00-mon:01:30\n
Describes a notification topic and its status. \n Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
" + "smithy.api#documentation": "Describes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).
" } }, "CacheSecurityGroups": { "target": "com.amazonaws.elasticache#CacheSecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "A list of cache security group elements, composed of name and status sub-elements.
" + "smithy.api#documentation": "A list of cache security group elements, composed of name and status\n sub-elements.
" } }, "CacheParameterGroup": { @@ -1910,7 +1916,7 @@ "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. \n
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.
" } }, "SecurityGroups": { @@ -1922,25 +1928,25 @@ "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The replication group to which this cluster belongs. \n If this field is empty, the cluster is not associated with any replication group.
" + "smithy.api#documentation": "The replication group to which this cluster belongs. If this field is empty, the\n cluster is not associated with any replication group.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.
\n If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
\nThe number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned\n off.
\nThe daily time range (in UTC) during which ElastiCache begins taking a \n daily snapshot of your cluster.
\nExample: 05:00-09:00\n
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your cluster.
\nExample: 05:00-09:00\n
A flag that enables using an AuthToken (password)\n when issuing Redis commands.
Default: false\n
A flag that enables using an AuthToken (password) when issuing Redis\n commands.
Default: false\n
A flag that enables in-transit encryption when set to true.
\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false\n
A flag that enables in-transit encryption when set to true.
\n Required: Only available when creating a replication\n group in an Amazon VPC using redis version 3.2.6, 4.x or\n later.
Default: false\n
A flag that enables encryption at-rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled\n after the cluster is created. To enable at-rest encryption on a cluster\n you must set AtRestEncryptionEnabled to true\n when you create a cluster.
\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false\n
A flag that enables encryption at-rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the cluster\n is created. To enable at-rest encryption on a cluster you must set\n AtRestEncryptionEnabled to true when you create a\n cluster.
\n Required: Only available when creating a replication\n group in an Amazon VPC using redis version 3.2.6, 4.x or\n later.
Default: false\n
A boolean value indicating whether log delivery is enabled for the replication group.
" + "smithy.api#documentation": "A boolean value indicating whether log delivery is enabled for the replication\n group.
" } }, "LogDeliveryConfigurations": { @@ -1983,19 +1989,19 @@ "NetworkType": { "target": "com.amazonaws.elasticache#NetworkType", "traits": { - "smithy.api#documentation": "Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Redis engine version 6.2 onward or Memcached engine\n version 1.6.6 on all instances built on the Nitro system.
The network type associated with the cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
The network type associated with the cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Redis engine version 6.2\n onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
" + "smithy.api#documentation": "A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.
" } } }, @@ -2053,7 +2059,7 @@ "CacheClusters": { "target": "com.amazonaws.elasticache#CacheClusterList", "traits": { - "smithy.api#documentation": "A list of clusters. Each item in the list contains detailed information about one cluster.
" + "smithy.api#documentation": "A list of clusters. Each item in the list contains detailed information about one\n cluster.
" } } }, @@ -2096,7 +2102,7 @@ "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the cache parameter group family associated with this cache engine.
\nValid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.x |\n redis7\n
The name of the cache parameter group family associated with this cache engine.
\nValid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.x | redis7\n
A list of cache engine version details. \n Each element in the list contains detailed information about one cache engine version.
" + "smithy.api#documentation": "A list of cache engine version details. Each element in the list contains detailed\n information about one cache engine version.
" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a DescribeCacheEngineVersions operation.
" + "smithy.api#documentation": "Represents the output of a DescribeCacheEngineVersions\n operation.
" } }, "com.amazonaws.elasticache#CacheNode": { @@ -2151,13 +2157,13 @@ "CacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's Amazon account.
" + "smithy.api#documentation": "The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's Amazon account.
" } }, "CacheNodeStatus": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The current state of this cache node, one of the following values: available, creating, rebooting, or deleting.
The current state of this cache node, one of the following values:\n available, creating, rebooting, or\n deleting.
The ID of the primary node to which this read replica node is synchronized. \n If this field is empty, this node is not associated with a primary cluster.
" + "smithy.api#documentation": "The ID of the primary node to which this read replica node is synchronized. If this\n field is empty, this node is not associated with a primary cluster.
" } }, "CustomerAvailabilityZone": { @@ -2198,7 +2204,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents an individual cache node within a cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
Represents an individual cache node within a cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1\n instances.
\nRedis configuration variables appendonly and\n appendfsync are not supported on Redis version 2.8.22 and\n later.
Indicates whether a change to the parameter is applied immediately\n or requires a reboot for the change to be applied. \n You can force a reboot or wait until the next maintenance window's reboot.\n For more information, see Rebooting a Cluster.
" + "smithy.api#documentation": "Indicates whether a change to the parameter is applied immediately or requires a\n reboot for the change to be applied. You can force a reboot or wait until the next\n maintenance window's reboot. For more information, see Rebooting a\n Cluster.
" } } }, @@ -2356,7 +2362,7 @@ "NodeUpdateInitiatedBy": { "target": "com.amazonaws.elasticache#NodeUpdateInitiatedBy", "traits": { - "smithy.api#documentation": "Reflects whether the update was initiated by the customer or automatically applied
" + "smithy.api#documentation": "Reflects whether the update was initiated by the customer or automatically\n applied
" } }, "NodeUpdateInitiatedDate": { @@ -2397,7 +2403,7 @@ "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the cache parameter group family that this cache parameter group is compatible with.
\nValid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.x | \n redis7\n
The name of the cache parameter group family that this cache parameter group is\n compatible with.
\nValid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.x | redis7\n
A list of parameters specific to a particular cache node type. \n Each element in the list contains detailed information about one parameter.
" + "smithy.api#documentation": "A list of parameters specific to a particular cache node type. Each element in the\n list contains detailed information about one parameter.
" } } }, @@ -2502,7 +2508,7 @@ "code": "CacheParameterGroupNotFound", "httpResponseCode": 404 }, - "smithy.api#documentation": "The requested cache parameter group name does not refer to an existing cache parameter group.
", + "smithy.api#documentation": "The requested cache parameter group name does not refer to an existing cache parameter\n group.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -2519,7 +2525,7 @@ "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#documentation": "The request cannot be processed because it would exceed the maximum number of cache\n security groups.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2542,7 +2548,7 @@ "CacheNodeIdsToReboot": { "target": "com.amazonaws.elasticache#CacheNodeIdsList", "traits": { - "smithy.api#documentation": "A list of the cache node IDs which need to be rebooted for parameter changes to be applied. \n A node ID is a numeric identifier (0001, 0002, etc.).
" + "smithy.api#documentation": "A list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).
" } } }, @@ -2562,7 +2568,7 @@ "CacheParameterGroups": { "target": "com.amazonaws.elasticache#CacheParameterGroupList", "traits": { - "smithy.api#documentation": "A list of cache parameter groups. Each element in the list contains detailed information \n about one cache parameter group.
" + "smithy.api#documentation": "A list of cache parameter groups. Each element in the list contains detailed\n information about one cache parameter group.
" } } }, @@ -2594,7 +2600,7 @@ "EC2SecurityGroups": { "target": "com.amazonaws.elasticache#EC2SecurityGroupList", "traits": { - "smithy.api#documentation": "A list of Amazon EC2 security groups that are associated with this cache security group.
" + "smithy.api#documentation": "A list of Amazon EC2 security groups that are associated with this cache security\n group.
" } }, "ARN": { @@ -2637,7 +2643,7 @@ "Status": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cluster are modified.
" + "smithy.api#documentation": "The membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cluster are\n modified.
" } } }, @@ -2666,7 +2672,7 @@ "CacheSecurityGroups": { "target": "com.amazonaws.elasticache#CacheSecurityGroups", "traits": { - "smithy.api#documentation": "A list of cache security groups. Each element in the list contains detailed information about one group.
" + "smithy.api#documentation": "A list of cache security groups. Each element in the list contains detailed\n information about one group.
" } } }, @@ -2695,7 +2701,7 @@ "code": "CacheSecurityGroupNotFound", "httpResponseCode": 404 }, - "smithy.api#documentation": "The requested cache security group name does not refer to an existing cache security group.
", + "smithy.api#documentation": "The requested cache security group name does not refer to an existing cache security\n group.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -2712,7 +2718,7 @@ "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#documentation": "The request cannot be processed because it would exceed the allowed number of cache\n security groups.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2762,7 +2768,7 @@ "SupportedNetworkTypes": { "target": "com.amazonaws.elasticache#NetworkTypeList", "traits": { - "smithy.api#documentation": "Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
Either ipv4 | ipv6 | dual_stack. IPv6 is\n supported for workloads using Redis engine version 6.2 onward or Memcached engine\n version 1.6.6 on all instances built on the Nitro system.
The requested cache subnet group name is already in use by an existing cache subnet group.
", + "smithy.api#documentation": "The requested cache subnet group name is already in use by an existing cache subnet\n group.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2816,7 +2822,7 @@ "CacheSubnetGroups": { "target": "com.amazonaws.elasticache#CacheSubnetGroups", "traits": { - "smithy.api#documentation": "A list of cache subnet groups. Each element in the list contains detailed information about one group.
" + "smithy.api#documentation": "A list of cache subnet groups. Each element in the list contains detailed information\n about one group.
" } } }, @@ -2836,7 +2842,7 @@ "code": "CacheSubnetGroupNotFoundFault", "httpResponseCode": 400 }, - "smithy.api#documentation": "The requested cache subnet group name does not refer to an existing cache subnet group.
", + "smithy.api#documentation": "The requested cache subnet group name does not refer to an existing cache subnet\n group.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2853,7 +2859,7 @@ "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#documentation": "The request cannot be processed because it would exceed the allowed number of cache\n subnet groups.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2879,7 +2885,7 @@ "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#documentation": "The request cannot be processed because it would exceed the allowed number of subnets\n in a cache subnet group.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2959,7 +2965,7 @@ "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#documentation": "The request cannot be processed because it would exceed the allowed number of clusters\n per customer.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3001,7 +3007,7 @@ "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.
" + "smithy.api#documentation": "Forces the migration to stop without ensuring that data is in sync. It is recommended\n to use this option only to abort the migration and not recommended when application\n wants to continue migration to ElastiCache.
" } } } @@ -3023,7 +3029,7 @@ "NodeGroupId": { "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { - "smithy.api#documentation": "The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) \n replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s \n node group's (shard's) id, see Finding a Shard's Id.
", + "smithy.api#documentation": "The 4-digit id for the node group you are configuring. For Redis (cluster mode\n disabled) replication groups, the node group id is always 0001. To find a Redis (cluster\n mode enabled)'s node group's (shard's) id, see Finding a Shard's\n Id.
", "smithy.api#required": {} } }, @@ -3031,14 +3037,14 @@ "target": "com.amazonaws.elasticache#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The number of replicas you want in this node group at the end of this operation. \n The maximum value for NewReplicaCount is 5.\n The minimum value depends upon the type of Redis replication group you are working with.
The minimum number of replicas in a shard or replication group is:
\nRedis (cluster mode disabled)
\nIf Multi-AZ: 1
\nIf Multi-AZ: 0
\nRedis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
\nThe number of replicas you want in this node group at the end of this operation.\n The maximum value for NewReplicaCount is 5. The minimum value depends upon\n the type of Redis replication group you are working with.
The minimum number of replicas in a shard or replication group is:
\nRedis (cluster mode disabled)
\nIf Multi-AZ: 1
\nIf Multi-AZ: 0
\nRedis (cluster mode enabled): 0 (though you will not be able to failover to\n a replica if your primary node fails)
\nA list of PreferredAvailabilityZone strings that specify which availability zones the \n replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must \n equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of \n ReplicaConfiguration is omitted, ElastiCache for Redis selects the availability zone for \n each of the replicas.
A list of PreferredAvailabilityZone strings that specify which\n availability zones the replication group's nodes are to be in. The nummber of\n PreferredAvailabilityZone values must equal the value of\n NewReplicaCount plus 1 to account for the primary node. If this member\n of ReplicaConfiguration is omitted, ElastiCache for Redis selects the\n availability zone for each of the replicas.
Node group (shard) configuration options when adding or removing replicas. \n Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.
" + "smithy.api#documentation": "Node group (shard) configuration options when adding or removing replicas. Each\n node group (shard) configuration has the following members: NodeGroupId,\n NewReplicaCount, and PreferredAvailabilityZones.
" } }, "com.amazonaws.elasticache#CopySnapshot": { @@ -3084,7 +3090,7 @@ } ], "traits": { - "smithy.api#documentation": "Makes a copy of an existing snapshot.
\nThis operation is valid for Redis only.
\nUsers or groups that have permissions to use the CopySnapshot operation \n can create their own Amazon S3 buckets and copy snapshots to it. \n To control access to your snapshots, use an IAM policy to control who has the ability to use \n the CopySnapshot operation. \n For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots \n and Authentication & Access Control.
You could receive the following error messages.
\n\n Error Messages\n
\n\n Error Message:\n The S3 bucket %s is outside of the region.
\n\n Solution:\n Create an Amazon S3 bucket in the same region as your snapshot. \n For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
\n\n Error Message:\n The S3 bucket %s does not exist.
\n\n Solution:\n Create an Amazon S3 bucket in the same region as your snapshot.\n For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
\n\n Error Message:\n The S3 bucket %s is not owned by the authenticated user.
\n\n Solution:\n Create an Amazon S3 bucket in the same region as your snapshot.\n For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
\n\n Error Message:\n The authenticated user does not have sufficient permissions to perform the desired activity.
\n\n Solution:\n Contact your system administrator to get the needed permissions.
\n\n Error Message:\n The S3 bucket %s already contains an object with key %s.
\n\n Solution:\n Give the TargetSnapshotName a new and unique value.\n If exporting a snapshot, \n you could alternatively create a new Amazon S3 bucket \n and use this same value for TargetSnapshotName.
\n Error Message: \n ElastiCache has not been granted READ permissions %s on the S3 Bucket.
\n\n Solution:\n Add List and Read permissions on the bucket.\n For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
\n\n Error Message: \n ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
\n\n Solution:\n Add Upload/Delete permissions on the bucket.\n For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
\n\n Error Message: \n ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
\n\n Solution:\n Add View Permissions on the bucket.\n For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
\nMakes a copy of an existing snapshot.
\nThis operation is valid for Redis only.
\nUsers or groups that have permissions to use the CopySnapshot\n operation can create their own Amazon S3 buckets and copy snapshots to it. To\n control access to your snapshots, use an IAM policy to control who has the ability\n to use the CopySnapshot operation. For more information about using IAM\n to control the use of ElastiCache operations, see Exporting\n Snapshots and Authentication & Access\n Control.
You could receive the following error messages.
\n\n Error Messages\n
\n\n Error Message: The S3 bucket %s is outside of\n the region.
\n\n Solution: Create an Amazon S3 bucket in the\n same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User\n Guide.
\n\n Error Message: The S3 bucket %s does not\n exist.
\n\n Solution: Create an Amazon S3 bucket in the\n same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User\n Guide.
\n\n Error Message: The S3 bucket %s is not owned\n by the authenticated user.
\n\n Solution: Create an Amazon S3 bucket in the\n same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User\n Guide.
\n\n Error Message: The authenticated user does\n not have sufficient permissions to perform the desired activity.
\n\n Solution: Contact your system administrator\n to get the needed permissions.
\n\n Error Message: The S3 bucket %s already\n contains an object with key %s.
\n\n Solution: Give the\n TargetSnapshotName a new and unique value. If exporting a\n snapshot, you could alternatively create a new Amazon S3 bucket and use this\n same value for TargetSnapshotName.
\n Error Message: ElastiCache has not been\n granted READ permissions %s on the S3 Bucket.
\n\n Solution: Add List and Read permissions on\n the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n ElastiCache User Guide.
\n\n Error Message: ElastiCache has not been\n granted WRITE permissions %s on the S3 Bucket.
\n\n Solution: Add Upload/Delete permissions on\n the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n ElastiCache User Guide.
\n\n Error Message: ElastiCache has not been\n granted READ_ACP permissions %s on the S3 Bucket.
\n\n Solution: Add View Permissions on the bucket.\n For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n ElastiCache User Guide.
\nA name for the snapshot copy.\n ElastiCache does not permit overwriting a snapshot, therefore\n this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.
", + "smithy.api#documentation": "A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot,\n therefore this name must be unique within its context - ElastiCache or an Amazon S3\n bucket if exporting.
", "smithy.api#required": {} } }, "TargetBucket": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The Amazon S3 bucket to which the snapshot is exported.\n This parameter is used only when exporting a snapshot for external access.
\nWhen using this parameter to export a snapshot, \n be sure Amazon ElastiCache has the needed permissions to this S3 bucket. \n For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.
\nFor more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.
" + "smithy.api#documentation": "The Amazon S3 bucket to which the snapshot is exported. This parameter is used only\n when exporting a snapshot for external access.
\nWhen using this parameter to export a snapshot, be sure Amazon ElastiCache has the\n needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n Amazon ElastiCache User Guide.
\nFor more information, see Exporting a\n Snapshot in the Amazon ElastiCache User Guide.
" } }, "KmsKeyId": { @@ -3119,7 +3125,7 @@ "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
" + "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, @@ -3133,6 +3139,9 @@ "Snapshot": { "target": "com.amazonaws.elasticache#Snapshot" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateCacheCluster": { @@ -3188,7 +3197,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a cluster. All nodes in the\n cluster run the same protocol-compliant cache engine software, either Memcached\n or Redis.
\nThis operation is not supported for Redis (cluster mode enabled) clusters.
" + "smithy.api#documentation": "Creates a cluster. All nodes in the cluster run the same protocol-compliant cache\n engine software, either Memcached or Redis.
\nThis operation is not supported for Redis (cluster mode enabled) clusters.
" } }, "com.amazonaws.elasticache#CreateCacheClusterMessage": { @@ -3197,80 +3206,80 @@ "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The node group (shard) identifier. This parameter is stored as a lowercase string.
\n\n Constraints:\n
\nA name must contain from 1 to 50 alphanumeric characters or hyphens.
\nThe first character must be a letter.
\nA name cannot end with a hyphen or contain two consecutive hyphens.
\nThe node group (shard) identifier. This parameter is stored as a lowercase\n string.
\n\n Constraints:\n
\nA name must contain from 1 to 50 alphanumeric characters or hyphens.
\nThe first character must be a letter.
\nA name cannot end with a hyphen or contain two consecutive hyphens.
\nThe ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.
\nIf the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.
\nThis parameter is only valid if the Engine parameter is redis.
The ID of the replication group to which this cluster should belong. If this parameter\n is specified, the cluster is added to the specified replication group as a read replica;\n otherwise, the cluster is a standalone primary that is not part of any replication\n group.
\nIf the specified replication group is Multi-AZ enabled and the Availability Zone is\n not specified, the cluster is created in Availability Zones that provide the best spread\n of read replicas across Availability Zones.
\nThis parameter is only valid if the Engine parameter is\n redis.
Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or \n created across multiple Availability Zones in the cluster's region.
\nThis parameter is only supported for Memcached clusters.
\nIf the AZMode and PreferredAvailabilityZones are not specified, \n ElastiCache assumes single-az mode.
Specifies whether the nodes in this Memcached cluster are created in a single\n Availability Zone or created across multiple Availability Zones in the cluster's\n region.
\nThis parameter is only supported for Memcached clusters.
\nIf the AZMode and PreferredAvailabilityZones are not\n specified, ElastiCache assumes single-az mode.
The EC2 Availability Zone in which the cluster is created.
\nAll nodes belonging to this cluster are placed in the preferred Availability Zone. \n If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.
Default: System chosen Availability Zone.
" + "smithy.api#documentation": "The EC2 Availability Zone in which the cluster is created.
\nAll nodes belonging to this cluster are placed in the preferred Availability Zone. If\n you want to create your nodes across multiple Availability Zones, use\n PreferredAvailabilityZones.
Default: System chosen Availability Zone.
" } }, "PreferredAvailabilityZones": { "target": "com.amazonaws.elasticache#PreferredAvailabilityZoneList", "traits": { - "smithy.api#documentation": "A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.
\nThis option is only supported on Memcached.
\nIf you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.
\nThe number of Availability Zones listed must equal the value of NumCacheNodes.
If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or \n repeat the Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
" + "smithy.api#documentation": "A list of the Availability Zones in which cache nodes are created. The order of the\n zones in the list is not important.
\nThis option is only supported on Memcached.
\nIf you are creating your cluster in an Amazon VPC (recommended) you can only\n locate nodes in Availability Zones that are associated with the subnets in the\n selected subnet group.
\nThe number of Availability Zones listed must equal the value of\n NumCacheNodes.
If you want all the nodes in the same Availability Zone, use\n PreferredAvailabilityZone instead, or repeat the Availability Zone\n multiple times in the list.
Default: System chosen Availability Zones.
" } }, "NumCacheNodes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The initial number of cache nodes that the cluster has.
\nFor clusters running Redis, this value must be 1. \n For clusters running Memcached, this value must be between 1 and 40.
\nIf you need more than 40 nodes for your Memcached cluster, \n please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
" + "smithy.api#documentation": "The initial number of cache nodes that the cluster has.
\nFor clusters running Redis, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.
\nIf you need more than 40 nodes for your Memcached cluster, please fill out the\n ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of the nodes in the node group (shard).
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The compute and memory capacity of the nodes in the node group (shard).
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1\n instances.
\nRedis configuration variables appendonly and\n appendfsync are not supported on Redis version 2.8.22 and\n later.
The name of the cache engine to be used for this cluster.
\nValid values for this parameter are: memcached | redis\n
The name of the cache engine to be used for this cluster.
\nValid values for this parameter are: memcached |\n redis\n
The version number of the cache engine to be used for this cluster. \n To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
\n\n Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version.\n If you want to use an earlier engine version, \n you must delete the existing cluster or replication group and create it anew with the earlier engine version.
" + "smithy.api#documentation": "The version number of the cache engine to be used for this cluster. To view the\n supported cache engine versions, use the DescribeCacheEngineVersions operation.
\n\n Important: You can upgrade to a newer engine version\n (see Selecting\n a Cache Engine and Version), but you cannot downgrade to an earlier engine\n version. If you want to use an earlier engine version, you must delete the existing\n cluster or replication group and create it anew with the earlier engine version.
" } }, "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the parameter group to associate with this cluster. \n If this argument is omitted, the default parameter group for the specified engine is used.\n You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.
The name of the parameter group to associate with this cluster. If this argument is\n omitted, the default parameter group for the specified engine is used. You cannot use\n any parameter group which has cluster-enabled='yes' when creating a\n cluster.
The name of the subnet group to be used for the cluster.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
\nIf you're going to launch your cluster in an Amazon VPC, \n you need to create a subnet group before you start creating a cluster. \n For more information, see Subnets and Subnet Groups.
\nThe name of the subnet group to be used for the cluster.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (Amazon VPC).
\nIf you're going to launch your cluster in an Amazon VPC, you need to create a\n subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
\nA list of security group names to associate with this cluster.
\nUse this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).
" + "smithy.api#documentation": "A list of security group names to associate with this cluster.
\nUse this parameter only when you are creating a cluster outside of an Amazon Virtual\n Private Cloud (Amazon VPC).
" } }, "SecurityGroupIds": { "target": "com.amazonaws.elasticache#SecurityGroupIdsList", "traits": { - "smithy.api#documentation": "One or more VPC security groups associated with the cluster.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
" + "smithy.api#documentation": "One or more VPC security groups associated with the cluster.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (Amazon VPC).
" } }, "Tags": { @@ -3282,61 +3291,61 @@ "SnapshotArns": { "target": "com.amazonaws.elasticache#SnapshotArnsList", "traits": { - "smithy.api#documentation": "A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies \n a Redis RDB snapshot file stored in Amazon S3.\n The snapshot file is used to populate the node group (shard). \n The Amazon S3 object name in the ARN cannot contain any commas.
\nThis parameter is only valid if the Engine parameter is redis.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n
A single-element string list containing an Amazon Resource Name (ARN) that uniquely\n identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to\n populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any\n commas.
\nThis parameter is only valid if the Engine parameter is\n redis.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n
The name of a Redis snapshot from which to restore data into the new node group (shard).\n The snapshot status changes to restoring while the new node group (shard) is being created.
This parameter is only valid if the Engine parameter is redis.
The name of a Redis snapshot from which to restore data into the new node group\n (shard). The snapshot status changes to restoring while the new node group\n (shard) is being created.
This parameter is only valid if the Engine parameter is\n redis.
Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.\n
" + "smithy.api#documentation": "Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
" } }, "Port": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number on which each of the cache nodes accepts connections.
" + "smithy.api#documentation": "The port number on which each of the cache nodes accepts connections.
" } }, "NotificationTopicArn": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic \n to which notifications are sent.
\nThe Amazon SNS topic owner must be the same as the cluster owner.
\nThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic\n to which notifications are sent.
\nThe Amazon SNS topic owner must be the same as the cluster owner.
\nIf you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. \n
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days for which ElastiCache retains automatic snapshots before deleting them. \n For example, if you set SnapshotRetentionLimit to 5,\n a snapshot taken today is retained for 5 days before being deleted.
This parameter is only valid if the Engine parameter is redis.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
" + "smithy.api#documentation": "The number of days for which ElastiCache retains automatic snapshots before deleting\n them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken\n today is retained for 5 days before being deleted.
This parameter is only valid if the Engine parameter is\n redis.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
" } }, "SnapshotWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
\nExample: 05:00-09:00\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
\nThis parameter is only valid if the Engine parameter is redis.
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your node group (shard).
\nExample: 05:00-09:00\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate\n time range.
\nThis parameter is only valid if the Engine parameter is\n redis.
\n Reserved parameter. \n The password used to access a password protected server.
\nPassword constraints:
\nMust be only printable ASCII characters.
\nMust be at least 16 characters and no more than 128\n characters in length.
\nThe only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
\nFor more information, see AUTH password at http://redis.io/commands/AUTH.
" + "smithy.api#documentation": "\n Reserved parameter. The password used to access a\n password protected server.
\nPassword constraints:
\nMust be only printable ASCII characters.
\nMust be at least 16 characters and no more than 128 characters in\n length.
\nThe only permitted printable special characters are !, &, #, $, ^, <,\n >, and -. Other printable special characters cannot be used in the AUTH\n token.
\nFor more information, see AUTH\n password at http://redis.io/commands/AUTH.
" } }, "OutpostMode": { "target": "com.amazonaws.elasticache#OutpostMode", "traits": { - "smithy.api#documentation": "Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
" + "smithy.api#documentation": "Specifies whether the nodes in the cluster are created in a single outpost or across\n multiple outposts.
" } }, "PreferredOutpostArn": { @@ -3366,13 +3375,13 @@ "NetworkType": { "target": "com.amazonaws.elasticache#NetworkType", "traits": { - "smithy.api#documentation": "Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Redis engine version 6.2 onward or Memcached engine\n version 1.6.6 on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Redis engine version 6.2\n onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Creates a new Amazon ElastiCache cache parameter group. An ElastiCache\n cache parameter group is a collection of parameters and their values that are applied to all of the nodes\n in any cluster or replication group using the CacheParameterGroup.
\nA newly created CacheParameterGroup is an exact duplicate of the default parameter group\n for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can\n change the values of specific parameters. For more information, see:
\n\n ModifyCacheParameterGroup in the ElastiCache API Reference.
\n\n Parameters and Parameter Groups in the ElastiCache User Guide.
\nCreates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter\n group is a collection of parameters and their values that are applied to all of the\n nodes in any cluster or replication group using the CacheParameterGroup.
\nA newly created CacheParameterGroup is an exact duplicate of the default parameter\n group for the CacheParameterGroupFamily. To customize the newly created\n CacheParameterGroup you can change the values of specific parameters. For more\n information, see:
\n\n ModifyCacheParameterGroup in the ElastiCache API Reference.
\n\n Parameters and\n Parameter Groups in the ElastiCache User Guide.
\nThe name of the cache parameter group family that the cache parameter group can be used with.
\nValid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.x |\n redis7\n
The name of the cache parameter group family that the cache parameter group can be\n used with.
\nValid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.x | redis7\n
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
" + "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, @@ -3461,6 +3473,9 @@ "CacheParameterGroup": { "target": "com.amazonaws.elasticache#CacheParameterGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateCacheSecurityGroup": { @@ -3489,7 +3504,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new cache security group. Use a\n cache security group to control access to one or more clusters.
\nCache security groups are only used when you are creating a cluster outside of an Amazon\n Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache\n subnet group instead. For more information, \n see CreateCacheSubnetGroup.
" + "smithy.api#documentation": "Creates a new cache security group. Use a cache security group to control access to\n one or more clusters.
\nCache security groups are only used when you are creating a cluster outside of an\n Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a\n VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.
" } }, "com.amazonaws.elasticache#CreateCacheSecurityGroupMessage": { @@ -3498,7 +3513,7 @@ "CacheSecurityGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "A name for the cache security group. This value is stored as a lowercase string.
\nConstraints: Must contain no more than 255 alphanumeric characters. Cannot be the word \"Default\".
\nExample: mysecuritygroup\n
A name for the cache security group. This value is stored as a lowercase\n string.
\nConstraints: Must contain no more than 255 alphanumeric characters. Cannot be the word\n \"Default\".
\nExample: mysecuritygroup\n
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
" + "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, @@ -3526,6 +3541,9 @@ "CacheSecurityGroup": { "target": "com.amazonaws.elasticache#CacheSecurityGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateCacheSubnetGroup": { @@ -3557,7 +3575,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new cache subnet group.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
" + "smithy.api#documentation": "Creates a new cache subnet group.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (Amazon VPC).
" } }, "com.amazonaws.elasticache#CreateCacheSubnetGroupMessage": { @@ -3587,7 +3605,7 @@ "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
" + "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, @@ -3601,6 +3619,9 @@ "CacheSubnetGroup": { "target": "com.amazonaws.elasticache#CacheSubnetGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateGlobalReplicationGroup": { @@ -3629,7 +3650,7 @@ } ], "traits": { - "smithy.api#documentation": "Global Datastore for Redis offers fully managed, fast, \n reliable and secure cross-region replication.\n Using Global Datastore for Redis, you can create cross-region\n read replica clusters for ElastiCache for Redis to enable low-latency reads\n and disaster recovery across regions. For more information,\n\n see Replication Across Regions Using Global Datastore.
\nThe GlobalReplicationGroupIdSuffix is the name of the Global datastore.
\nThe PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
\nGlobal Datastore for Redis offers fully managed, fast, reliable and secure\n cross-region replication. Using Global Datastore for Redis, you can create cross-region\n read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster\n recovery across regions. For more information, see Replication\n Across Regions Using Global Datastore.
\nThe GlobalReplicationGroupIdSuffix is the\n name of the Global datastore.
\nThe PrimaryReplicationGroupId represents the\n name of the primary cluster that accepts writes and will replicate updates to\n the secondary cluster.
\nThe suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix \n to the Global datastore ID when it is created. Each Amazon Region has its own prefix. For instance, a Global datastore ID created in the US-West-1 region will begin with \"dsdfu\" along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions.
\nFor a full list of Amazon Regions and their respective Global datastore iD prefixes, see Using the Amazon CLI with Global datastores .
", + "smithy.api#documentation": "The suffix name of a Global datastore. Amazon ElastiCache automatically applies a\n prefix to the Global datastore ID when it is created. Each Amazon Region has its own\n prefix. For instance, a Global datastore ID created in the US-West-1 region will begin\n with \"dsdfu\" along with the suffix name you provide. The suffix, combined with the\n auto-generated prefix, guarantees uniqueness of the Global datastore name across\n multiple regions.
\nFor a full list of Amazon Regions and their respective Global datastore iD prefixes,\n see Using the Amazon CLI with Global datastores .
", "smithy.api#required": {} } }, @@ -3651,7 +3672,7 @@ "PrimaryReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
", + "smithy.api#documentation": "The name of the primary cluster that accepts writes and will replicate updates to the\n secondary cluster.
", "smithy.api#required": {} } } @@ -3663,6 +3684,9 @@ "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateReplicationGroup": { @@ -3733,7 +3757,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
\nThis API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.
\nA Redis (cluster mode disabled) replication group is a collection of clusters, \n where one of the clusters is a read/write primary and the others are read-only replicas. \n Writes to the primary are asynchronously propagated to the replicas.
\nA Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). \n Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.\n \n
\nThe node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between \n 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. \n Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see \n Creating a Subnet Group. For versions below 5.0.6, \n the limit is 250 per cluster.
\nTo request a limit increase, see \n Amazon Service Limits \n and choose the limit type Nodes per cluster per instance type.
\nWhen a Redis (cluster mode disabled) replication group has been successfully created, \n you can add one or more read replicas to it, up to a total of 5 read replicas. \n If you need to increase or decrease the number of node groups (console: shards), \n you can avail yourself of ElastiCache for Redis' scaling. For more information,\n see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide.
\nThis operation is valid for Redis only.
\nCreates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication\n group.
\nThis API can be used to create a standalone regional replication group or a secondary\n replication group associated with a Global datastore.
\nA Redis (cluster mode disabled) replication group is a collection of clusters, where\n one of the clusters is a read/write primary and the others are read-only replicas.\n Writes to the primary are asynchronously propagated to the replicas.
\nA Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI:\n node groups). Each shard has a primary node and up to 5 read-only replica nodes. The\n configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which\n is the maximum number or replicas allowed.
\nThe node or shard limit can be increased to a maximum of 500 per cluster if the Redis\n engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node\n cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500\n shards (single primary and no replicas). Make sure there are enough available IP\n addresses to accommodate the increase. Common pitfalls include the subnets in the subnet\n group have too small a CIDR range or the subnets are shared and heavily used by other\n clusters. For more information, see Creating a Subnet\n Group. For versions below 5.0.6, the limit is 250 per cluster.
\nTo request a limit increase, see Amazon Service Limits and\n choose the limit type Nodes per cluster per instance\n type.
\nWhen a Redis (cluster mode disabled) replication group has been successfully created,\n you can add one or more read replicas to it, up to a total of 5 read replicas. If you\n need to increase or decrease the number of node groups (console: shards), you can avail\n yourself of ElastiCache for Redis' scaling. For more information, see Scaling\n ElastiCache for Redis Clusters in the ElastiCache User\n Guide.
\nThis operation is valid for Redis only.
\nThe replication group identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nA name must contain from 1 to 40 alphanumeric characters or hyphens.
\nThe first character must be a letter.
\nA name cannot end with a hyphen or contain two consecutive hyphens.
\nThe replication group identifier. This parameter is stored as a lowercase\n string.
\nConstraints:
\nA name must contain from 1 to 40 alphanumeric characters or hyphens.
\nThe first character must be a letter.
\nA name cannot end with a hyphen or contain two consecutive hyphens.
\nThe identifier of the cluster that serves as the primary for this replication\n group. This cluster must already exist and have a status of available.
This parameter is not required if NumCacheClusters,\n NumNodeGroups, or\n ReplicasPerNodeGroup is specified.
The identifier of the cluster that serves as the primary for this replication group.\n This cluster must already exist and have a status of available.
This parameter is not required if NumCacheClusters,\n NumNodeGroups, or ReplicasPerNodeGroup is\n specified.
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
\n\n AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
" + "smithy.api#documentation": "Specifies whether a read-only replica is automatically promoted to read/write primary\n if the existing primary fails.
\n\n AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled)\n replication groups.
Default: false
" } }, "MultiAZEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
" + "smithy.api#documentation": "A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more\n information, see Minimizing Downtime: Multi-AZ.
" } }, "NumCacheClusters": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of clusters this replication group initially has.
\nThis parameter is not used if there is more than one node group (shard). \n You should use ReplicasPerNodeGroup instead.
If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2.\n If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you\n can explicitly set it to a value between 2 and 6.
The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).
The number of clusters this replication group initially has.
\nThis parameter is not used if there is more than one node group (shard). You should\n use ReplicasPerNodeGroup instead.
If AutomaticFailoverEnabled is true, the value of this\n parameter must be at least 2. If AutomaticFailoverEnabled is\n false you can omit this parameter (it will default to 1), or you can\n explicitly set it to a value between 2 and 6.
The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5\n replicas).
A list of EC2 Availability Zones in which the replication group's clusters are created. \n The order of the Availability Zones in the list is the order in which clusters are allocated. \n The primary cluster is created in the first AZ in the list.
\nThis parameter is not used if there is more than one node group (shard). \n You should use NodeGroupConfiguration instead.
If you are creating your replication group in an Amazon VPC (recommended), \n you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.
\nThe number of Availability Zones listed must equal the value of NumCacheClusters.
Default: system chosen Availability Zones.
" + "smithy.api#documentation": "A list of EC2 Availability Zones in which the replication group's clusters are\n created. The order of the Availability Zones in the list is the order in which clusters\n are allocated. The primary cluster is created in the first AZ in the list.
\nThis parameter is not used if there is more than one node group (shard). You should\n use NodeGroupConfiguration instead.
If you are creating your replication group in an Amazon VPC (recommended), you can\n only locate clusters in Availability Zones associated with the subnets in the\n selected subnet group.
\nThe number of Availability Zones listed must equal the value of\n NumCacheClusters.
Default: system chosen Availability Zones.
" } }, "NumNodeGroups": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. \n For Redis (cluster mode disabled) either omit this parameter or set it to 1.
\nDefault: 1
" + "smithy.api#documentation": "An optional parameter that specifies the number of node groups (shards) for this Redis\n (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit\n this parameter or set it to 1.
\nDefault: 1
" } }, "ReplicasPerNodeGroup": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "An optional parameter that specifies the number of replica nodes in each node group (shard).\n Valid values are 0 to 5.
" + "smithy.api#documentation": "An optional parameter that specifies the number of replica nodes in each node group\n (shard). Valid values are 0 to 5.
" } }, "NodeGroupConfiguration": { "target": "com.amazonaws.elasticache#NodeGroupConfigurationList", "traits": { - "smithy.api#documentation": "A list of node group (shard) configuration options. \n Each node group (shard) configuration has the following members:\n PrimaryAvailabilityZone,\n ReplicaAvailabilityZones,\n ReplicaCount, and \n Slots.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to \n individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a \n Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter \n because you must specify the slots for each node group.
" + "smithy.api#documentation": "A list of node group (shard) configuration options. Each node group (shard)\n configuration has the following members: PrimaryAvailabilityZone,\n ReplicaAvailabilityZones, ReplicaCount, and\n Slots.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled)\n replication group, you can use this parameter to individually configure each node group\n (shard), or you can omit this parameter. However, it is required when seeding a Redis\n (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group\n (shard) using this parameter because you must specify the slots for each node\n group.
" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of the nodes in the node group (shard).
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The compute and memory capacity of the nodes in the node group (shard).
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1\n instances.
\nRedis configuration variables appendonly and\n appendfsync are not supported on Redis version 2.8.22 and\n later.
The name of the cache engine to be used for the clusters in this replication group. The value must be set to Redis.
The name of the cache engine to be used for the clusters in this replication group.\n The value must be set to Redis.
The version number of the cache engine to be used for the clusters in this replication group. \n To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
\n Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, \n but you cannot downgrade to an earlier engine version.\n If you want to use an earlier engine version, \n you must delete the existing cluster or replication group and \n create it anew with the earlier engine version.
" + "smithy.api#documentation": "The version number of the cache engine to be used for the clusters in this replication\n group. To view the supported cache engine versions, use the\n DescribeCacheEngineVersions operation.
\n Important: You can upgrade to a newer engine version\n (see Selecting\n a Cache Engine and Version) in the ElastiCache User\n Guide, but you cannot downgrade to an earlier engine version. If you want\n to use an earlier engine version, you must delete the existing cluster or replication\n group and create it anew with the earlier engine version.
" } }, "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the parameter group to associate with this replication group. \n If this argument is omitted, the default cache parameter group for the specified engine is\n used.
\nIf you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, \n we recommend that you specify the parameter group by name.
\nTo create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.
To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.
The name of the parameter group to associate with this replication group. If this\n argument is omitted, the default cache parameter group for the specified engine is\n used.
\nIf you are running Redis version 3.2.4 or later, only one node group (shard), and want\n to use a default parameter group, we recommend that you specify the parameter group by\n name.
\nTo create a Redis (cluster mode disabled) replication group, use\n CacheParameterGroupName=default.redis3.2.
To create a Redis (cluster mode enabled) replication group, use\n CacheParameterGroupName=default.redis3.2.cluster.on.
The name of the cache subnet group to be used for the replication group.
\nIf you're going to launch your cluster in an Amazon VPC, \n you need to create a subnet group before you start creating a cluster. \n For more information, see Subnets and Subnet Groups.
\nThe name of the cache subnet group to be used for the replication group.
\nIf you're going to launch your cluster in an Amazon VPC, you need to create a\n subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
\nOne or more Amazon VPC security groups associated with this replication group.
\nUse this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
" + "smithy.api#documentation": "One or more Amazon VPC security groups associated with this replication group.
\nUse this parameter only when you are creating a replication group in an Amazon Virtual\n Private Cloud (Amazon VPC).
" } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "A list of tags to be added to this resource. \n Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: \n Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue. Tags on replication groups will be replicated to all nodes.
A list of tags to be added to this resource. Tags are comma-separated key,value pairs\n (e.g. Key=myKey, Value=myKeyValue. You can include multiple\n tags as shown following: Key=myKey, Value=myKeyValue\n Key=mySecondKey, Value=mySecondKeyValue. Tags on\n replication groups will be replicated to all nodes.
A list of Amazon Resource Names (ARN) that uniquely identify \n the Redis RDB snapshot files stored in Amazon S3. \n The snapshot files are used to populate the new replication group. \n The Amazon S3 object name in the ARN cannot contain any commas. \n The new replication group will have the number of node groups (console: shards)\n specified by the parameter NumNodeGroups or the number of\n node groups configured by NodeGroupConfiguration regardless \n of the number of ARNs specified here.
\nExample of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n
A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot\n files stored in Amazon S3. The snapshot files are used to populate the new replication\n group. The Amazon S3 object name in the ARN cannot contain any commas. The new\n replication group will have the number of node groups (console: shards) specified by the\n parameter NumNodeGroups or the number of node groups configured by\n NodeGroupConfiguration regardless of the number of ARNs\n specified here.
\nExample of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n
The name of a snapshot from which to restore data into the new replication group.\n The snapshot status changes to restoring while the new replication group is being created.
The name of a snapshot from which to restore data into the new replication group. The\n snapshot status changes to restoring while the new replication group is\n being created.
Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.\n Valid values for ddd are:
Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.
\nValid values for ddd are:
\n sun\n
\n mon\n
\n tue\n
\n wed\n
\n thu\n
\n fri\n
\n sat\n
Example: sun:23:00-mon:01:30\n
Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period. Valid values for ddd\n are:
Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
\nValid values for ddd are:
\n sun\n
\n mon\n
\n tue\n
\n wed\n
\n thu\n
\n fri\n
\n sat\n
Example: sun:23:00-mon:01:30\n
The port number on which each member of the replication group accepts connections.
" + "smithy.api#documentation": "The port number on which each member of the replication group accepts\n connections.
" } }, "NotificationTopicArn": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) \n topic to which notifications are sent.
\nThe Amazon SNS topic owner must be the same as the cluster owner.
\nThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic\n to which notifications are sent.
\nThe Amazon SNS topic owner must be the same as the cluster owner.
\nIf you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. \n
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days for which ElastiCache retains automatic snapshots before deleting them. \n For example, if you set SnapshotRetentionLimit to 5, \n a snapshot that was taken today is retained for 5 days before being deleted.
Default: 0 (i.e., automatic backups are disabled for this cluster).
" + "smithy.api#documentation": "The number of days for which ElastiCache retains automatic snapshots before deleting\n them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that\n was taken today is retained for 5 days before being deleted.
Default: 0 (i.e., automatic backups are disabled for this cluster).
" } }, "SnapshotWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
\nExample: 05:00-09:00\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
" + "smithy.api#documentation": "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your node group (shard).
\nExample: 05:00-09:00\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate\n time range.
" } }, "AuthToken": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "\n Reserved parameter. \n The password used to access a password protected server.
\n\n AuthToken can be specified only on replication groups where TransitEncryptionEnabled is \n true.
For HIPAA compliance, you must specify TransitEncryptionEnabled as true, \n an AuthToken, and a CacheSubnetGroup.
Password constraints:
\nMust be only printable ASCII characters.
\nMust be at least 16 characters and no more than 128\n characters in length.
\nThe only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
\nFor more information, see AUTH password at http://redis.io/commands/AUTH.
" + "smithy.api#documentation": "\n Reserved parameter. The password used to access a\n password protected server.
\n\n AuthToken can be specified only on replication groups where\n TransitEncryptionEnabled is true.
For HIPAA compliance, you must specify TransitEncryptionEnabled as\n true, an AuthToken, and a\n CacheSubnetGroup.
Password constraints:
\nMust be only printable ASCII characters.
\nMust be at least 16 characters and no more than 128 characters in\n length.
\nThe only permitted printable special characters are !, &, #, $, ^, <,\n >, and -. Other printable special characters cannot be used in the AUTH\n token.
\nFor more information, see AUTH\n password at http://redis.io/commands/AUTH.
" } }, "TransitEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "A flag that enables in-transit encryption when set to true.
This parameter is valid only if the Engine parameter is redis,\n the EngineVersion parameter is 3.2.6, 4.x or later,\n and the cluster is being created in an Amazon VPC.
If you enable in-transit encryption, you must also specify a value for \n CacheSubnetGroup.
\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false\n
For HIPAA compliance, you must specify TransitEncryptionEnabled as true, \n an AuthToken, and a CacheSubnetGroup.
A flag that enables in-transit encryption when set to true.
This parameter is valid only if the Engine parameter is\n redis, the EngineVersion parameter is 3.2.6,\n 4.x or later, and the cluster is being created in an Amazon VPC.
If you enable in-transit encryption, you must also specify a value for\n CacheSubnetGroup.
\n Required: Only available when creating a replication\n group in an Amazon VPC using redis version 3.2.6, 4.x or\n later.
Default: false\n
For HIPAA compliance, you must specify TransitEncryptionEnabled as\n true, an AuthToken, and a\n CacheSubnetGroup.
A flag that enables encryption at rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the replication\n group is created. \n To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to \n true when you create the replication group.
\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false\n
A flag that enables encryption at rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the\n replication group is created. To enable encryption at rest on a replication group you\n must set AtRestEncryptionEnabled to true when you create the\n replication group.
\n Required: Only available when creating a replication\n group in an Amazon VPC using redis version 3.2.6, 4.x or\n later.
Default: false\n
Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes.\n For more information, see Data tiering.
" + "smithy.api#documentation": "Enables data tiering. Data tiering is only supported for replication groups using the\n r6gd node type. This parameter must be set to true when using r6gd nodes. For more\n information, see Data tiering.
" } }, "NetworkType": { "target": "com.amazonaws.elasticache#NetworkType", "traits": { - "smithy.api#documentation": "Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Redis engine version 6.2 onward or Memcached engine\n version 1.6.6 on all instances built on the Nitro system.
The network type you choose when creating a replication group, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
The network type you choose when creating a replication group, either\n ipv4 | ipv6. IPv6 is supported for workloads using Redis\n engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on\n the Nitro system.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
\nWhen setting TransitEncryptionEnabled to true, you can set your\n TransitEncryptionMode to preferred in the same request, to allow\n both encrypted and unencrypted connections at the same time. Once you migrate all your Redis\n clients to use encrypted connections you can modify the value to required to\n allow encrypted connections only.
Setting TransitEncryptionMode to required is a two-step\n process that requires you to first set the TransitEncryptionMode to preferred, \n after that you can set TransitEncryptionMode to required.
This process will not trigger the replacement of the replication group.
" + "smithy.api#documentation": "A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.
\nWhen setting TransitEncryptionEnabled to true, you can set\n your TransitEncryptionMode to preferred in the same request,\n to allow both encrypted and unencrypted connections at the same time. Once you migrate\n all your Redis clients to use encrypted connections you can modify the value to\n required to allow encrypted connections only.
Setting TransitEncryptionMode to required is a two-step\n process that requires you to first set the TransitEncryptionMode to\n preferred, after that you can set TransitEncryptionMode to\n required.
This process will not trigger the replacement of the replication group.
" } }, "ClusterMode": { "target": "com.amazonaws.elasticache#ClusterMode", "traits": { - "smithy.api#documentation": "Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible.\n \n Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
" + "smithy.api#documentation": "Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Redis\n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.
" } } }, @@ -3980,6 +4004,9 @@ "ReplicationGroup": { "target": "com.amazonaws.elasticache#ReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateSnapshot": { @@ -4023,7 +4050,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a copy of an entire cluster or replication group at a\n specific moment in time.
\nThis operation is valid for Redis only.
\nCreates a copy of an entire cluster or replication group at a specific moment in\n time.
\nThis operation is valid for Redis only.
\nThe identifier of an existing replication group. The snapshot is created from this replication group.
" + "smithy.api#documentation": "The identifier of an existing replication group. The snapshot is created from this\n replication group.
" } }, "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The identifier of an existing cluster. The snapshot is created from this cluster.
" + "smithy.api#documentation": "The identifier of an existing cluster. The snapshot is created from this\n cluster.
" } }, "SnapshotName": { @@ -4057,7 +4084,7 @@ "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
" + "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, @@ -4071,6 +4098,9 @@ "Snapshot": { "target": "com.amazonaws.elasticache#Snapshot" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateUser": { @@ -4105,7 +4135,7 @@ } ], "traits": { - "smithy.api#documentation": "For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).
" + "smithy.api#documentation": "For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see\n Using Role Based Access Control (RBAC).
" } }, "com.amazonaws.elasticache#CreateUserGroup": { @@ -4143,7 +4173,7 @@ } ], "traits": { - "smithy.api#documentation": "For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC)\n
" + "smithy.api#documentation": "For Redis engine version 6.0 onwards: Creates a Redis user group. For more\n information, see Using Role Based Access Control (RBAC)\n
" } }, "com.amazonaws.elasticache#CreateUserGroupMessage": { @@ -4172,7 +4202,7 @@ "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
" + "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } } @@ -4223,7 +4253,7 @@ "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
" + "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } }, "AuthenticationMode": { @@ -4317,27 +4347,27 @@ "target": "com.amazonaws.elasticache#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The number of node groups (shards) that results from the modification of the shard configuration
", + "smithy.api#documentation": "The number of node groups (shards) that results from the modification of the shard\n configuration
", "smithy.api#required": {} } }, "GlobalNodeGroupsToRemove": { "target": "com.amazonaws.elasticache#GlobalNodeGroupIdList", "traits": { - "smithy.api#documentation": "If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.\n \n ElastiCache for Redis will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster.
" + "smithy.api#documentation": "If the value of NodeGroupCount is less than the current number of node groups\n (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.\n GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.\n ElastiCache for Redis will attempt to remove all node groups listed by\n GlobalNodeGroupsToRemove from the cluster.
" } }, "GlobalNodeGroupsToRetain": { "target": "com.amazonaws.elasticache#GlobalNodeGroupIdList", "traits": { - "smithy.api#documentation": "If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache for Redis will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster. \n \n\n
" + "smithy.api#documentation": "If the value of NodeGroupCount is less than the current number of node groups\n (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.\n GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster.\n ElastiCache for Redis will attempt to retain all node groups listed by\n GlobalNodeGroupsToRetain from the cluster.
" } }, "ApplyImmediately": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.
", + "smithy.api#documentation": "Indicates that the shard reconfiguration process begins immediately. At present, the\n only permitted value for this parameter is true.
", "smithy.api#required": {} } } @@ -4349,6 +4379,9 @@ "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#DecreaseReplicaCount": { @@ -4398,7 +4431,7 @@ } ], "traits": { - "smithy.api#documentation": "Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of\n replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation\n is performed with no cluster down time.
" + "smithy.api#documentation": "Dynamically decreases the number of replicas in a Redis (cluster mode disabled)\n replication group or the number of replica nodes in one or more node groups (shards) of\n a Redis (cluster mode enabled) replication group. This operation is performed with no\n cluster down time.
" } }, "com.amazonaws.elasticache#DecreaseReplicaCountMessage": { @@ -4407,33 +4440,33 @@ "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The id of the replication group from which you want to remove replica nodes.
", + "smithy.api#documentation": "The id of the replication group from which you want to remove replica\n nodes.
", "smithy.api#required": {} } }, "NewReplicaCount": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of read replica nodes you want at the completion of this operation.\n For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the\n replication group. For Redis (cluster mode enabled) replication groups, this is the number of \n replica nodes in each of the replication group's node groups.
\nThe minimum number of replicas in a shard or replication group is:
\nRedis (cluster mode disabled)
\nIf Multi-AZ is enabled: 1
\nIf Multi-AZ is not enabled: 0
\nRedis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
\nThe number of read replica nodes you want at the completion of this operation. For\n Redis (cluster mode disabled) replication groups, this is the number of replica nodes in\n the replication group. For Redis (cluster mode enabled) replication groups, this is the\n number of replica nodes in each of the replication group's node groups.
\nThe minimum number of replicas in a shard or replication group is:
\nRedis (cluster mode disabled)
\nIf Multi-AZ is enabled: 1
\nIf Multi-AZ is not enabled: 0
\nRedis (cluster mode enabled): 0 (though you will not be able to failover to\n a replica if your primary node fails)
\nA list of ConfigureShard objects that can be used to configure each shard\n in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members:\n NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
A list of ConfigureShard objects that can be used to configure each\n shard in a Redis (cluster mode enabled) replication group. The\n ConfigureShard has three members: NewReplicaCount,\n NodeGroupId, and PreferredAvailabilityZones.
A list of the node ids to remove from the replication group or node group (shard).
" + "smithy.api#documentation": "A list of the node ids to remove from the replication group or node group\n (shard).
" } }, "ApplyImmediately": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "If True, the number of replica nodes is decreased immediately. \n\n ApplyImmediately=False is not currently supported.
If True, the number of replica nodes is decreased immediately.\n ApplyImmediately=False is not currently supported.
Deletes a previously provisioned cluster.\n DeleteCacheCluster deletes all associated cache nodes, node endpoints and the\n cluster itself. When you receive a successful response from this operation,\n Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert\n this operation.
This operation is not valid for:
\nRedis (cluster mode enabled) clusters
\nRedis (cluster mode disabled) clusters
\nA cluster that is the last read replica of a replication group
\nA cluster that is the primary node of a replication group
\nA node group (shard) that has Multi-AZ mode enabled
\nA cluster from a Redis (cluster mode enabled) replication group
\nA cluster that is not in the available state
Deletes a previously provisioned cluster. DeleteCacheCluster deletes all\n associated cache nodes, node endpoints and the cluster itself. When you receive a\n successful response from this operation, Amazon ElastiCache immediately begins deleting\n the cluster; you cannot cancel or revert this operation.
This operation is not valid for:
\nRedis (cluster mode enabled) clusters
\nRedis (cluster mode disabled) clusters
\nA cluster that is the last read replica of a replication group
\nA cluster that is the primary node of a replication group
\nA node group (shard) that has Multi-AZ mode enabled
\nA cluster from a Redis (cluster mode enabled) replication group
\nA cluster that is not in the available state
The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.
", + "smithy.api#documentation": "The cluster identifier for the cluster to be deleted. This parameter is not case\n sensitive.
", "smithy.api#required": {} } }, "FinalSnapshotIdentifier": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. \n ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.
" + "smithy.api#documentation": "The user-supplied name of a final cluster snapshot. This is the unique name that\n identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster\n immediately afterward.
" } } }, @@ -4543,6 +4579,9 @@ "CacheCluster": { "target": "com.amazonaws.elasticache#CacheCluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#DeleteCacheParameterGroup": { @@ -4568,7 +4607,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified cache parameter\n group. You cannot delete a cache parameter group if it is associated with any cache\n clusters. You cannot delete the default cache parameter groups in your account.
" + "smithy.api#documentation": "Deletes the specified cache parameter group. You cannot delete a cache parameter group\n if it is associated with any cache clusters. You cannot delete the default cache\n parameter groups in your account.
" } }, "com.amazonaws.elasticache#DeleteCacheParameterGroupMessage": { @@ -4577,7 +4616,7 @@ "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the cache parameter group to delete.
\nThe specified cache security group must not be associated with any clusters.
\nThe name of the cache parameter group to delete.
\nThe specified cache security group must not be associated with any\n clusters.
\nDeletes a cache security group.
\nYou cannot delete a cache security group if it is associated with any clusters.
\nDeletes a cache security group.
\nYou cannot delete a cache security group if it is associated with any\n clusters.
\nDeletes a cache subnet group.
\nYou cannot delete a default cache subnet group or one that is associated with any clusters.
\nDeletes a cache subnet group.
\nYou cannot delete a default cache subnet group or one that is associated with any\n clusters.
\nDeleting a Global datastore is a two-step process:
\nFirst, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.
\nOnce the Global datastore contains only the primary cluster, you can use the DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the primary cluster using RetainPrimaryReplicationGroup=true.
Since the Global Datastore has only a primary cluster, you can delete the Global Datastore\n while retaining the primary by setting RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when deleting a \n Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; \n you cannot cancel or revert this operation.
" + "smithy.api#documentation": "Deleting a Global datastore is a two-step process:
\nFirst, you must DisassociateGlobalReplicationGroup to remove\n the secondary clusters in the Global datastore.
\nOnce the Global datastore contains only the primary cluster, you can use the\n DeleteGlobalReplicationGroup API to delete the Global datastore\n while retainining the primary cluster using\n RetainPrimaryReplicationGroup=true.
Since the Global Datastore has only a primary cluster, you can delete the Global\n Datastore while retaining the primary by setting\n RetainPrimaryReplicationGroup=true. The primary cluster is never\n deleted when deleting a Global Datastore. It can only be deleted when it no longer is\n associated with any Global Datastore.
When you receive a successful response from this operation, Amazon ElastiCache\n immediately begins deleting the selected resources; you cannot cancel or revert this\n operation.
" } }, "com.amazonaws.elasticache#DeleteGlobalReplicationGroupMessage": { @@ -4711,6 +4750,9 @@ "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#DeleteReplicationGroup": { @@ -4745,7 +4787,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing replication group. \n By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. \n If the replication group has only one primary, \n you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true.
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; \n you cannot cancel or revert this operation.
\nThis operation is valid for Redis only.
\nDeletes an existing replication group. By default, this operation deletes the entire\n replication group, including the primary/primaries and all of the read replicas. If the\n replication group has only one primary, you can optionally delete only the read\n replicas, while retaining the primary by setting\n RetainPrimaryCluster=true.
When you receive a successful response from this operation, Amazon ElastiCache\n immediately begins deleting the selected resources; you cannot cancel or revert this\n operation.
\nThis operation is valid for Redis only.
\nThe identifier for the cluster to be deleted. This parameter is not case sensitive.
", + "smithy.api#documentation": "The identifier for the cluster to be deleted. This parameter is not case\n sensitive.
", "smithy.api#required": {} } }, "RetainPrimaryCluster": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "If set to true, all of the read replicas are deleted, \n but the primary node is retained.
If set to true, all of the read replicas are deleted, but the primary\n node is retained.
The name of a final node group (shard) snapshot. \n ElastiCache creates the snapshot from the primary node in the cluster, \n rather than one of the replicas; this is to ensure that it captures the freshest data. \n After the final snapshot is taken, the replication group is immediately deleted.
" + "smithy.api#documentation": "The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from\n the primary node in the cluster, rather than one of the replicas; this is to ensure that\n it captures the freshest data. After the final snapshot is taken, the replication group\n is immediately deleted.
" } } }, @@ -4781,6 +4823,9 @@ "ReplicationGroup": { "target": "com.amazonaws.elasticache#ReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#DeleteSnapshot": { @@ -4806,7 +4851,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing snapshot. When you receive a\n successful response from this operation, ElastiCache immediately begins deleting the snapshot;\n you cannot cancel or revert this operation.
\nThis operation is valid for Redis only.
\nDeletes an existing snapshot. When you receive a successful response from this\n operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or\n revert this operation.
\nThis operation is valid for Redis only.
\nFor Redis engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).
" + "smithy.api#documentation": "For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from\n all user groups and in turn removed from all replication groups. For more information,\n see Using Role Based Access Control (RBAC).
" } }, "com.amazonaws.elasticache#DeleteUserGroup": { @@ -4884,7 +4932,7 @@ } ], "traits": { - "smithy.api#documentation": "For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).
" + "smithy.api#documentation": "For Redis engine version 6.0 onwards: Deletes a user group. The user group must first\n be disassociated from the replication group before it can be deleted. For more\n information, see Using Role Based Access Control (RBAC).
" } }, "com.amazonaws.elasticache#DeleteUserGroupMessage": { @@ -4931,7 +4979,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about all provisioned\n clusters if no cluster identifier is specified, or about a specific cache\n cluster if a cluster identifier is supplied.
\nBy default, abbreviated information about the clusters is returned. You can\n use the optional ShowCacheNodeInfo flag to retrieve detailed information about the\n cache nodes associated with the clusters. These details include the DNS address\n and port for the cache node endpoint.
\nIf the cluster is in the creating state, only cluster-level information is displayed \n until all of the nodes are successfully provisioned.
\nIf the cluster is in the deleting state, only cluster-level information is displayed.
\nIf cache nodes are currently being added to the cluster, node endpoint information\n and creation time for the additional nodes are not displayed until they are\n completely provisioned. When the cluster state is available, the cluster is\n ready for use.
\nIf cache nodes are currently being removed from the cluster, no endpoint information \n for the removed nodes is displayed.
", + "smithy.api#documentation": "Returns information about all provisioned clusters if no cluster identifier is\n specified, or about a specific cache cluster if a cluster identifier is supplied.
\nBy default, abbreviated information about the clusters is returned. You can use the\n optional ShowCacheNodeInfo flag to retrieve detailed information\n about the cache nodes associated with the clusters. These details include the DNS\n address and port for the cache node endpoint.
\nIf the cluster is in the creating state, only cluster-level\n information is displayed until all of the nodes are successfully provisioned.
\nIf the cluster is in the deleting state, only cluster-level\n information is displayed.
\nIf cache nodes are currently being added to the cluster, node endpoint information and\n creation time for the additional nodes are not displayed until they are completely\n provisioned. When the cluster state is available, the cluster is\n ready for use.
\nIf cache nodes are currently being removed from the cluster, no endpoint information\n for the removed nodes is displayed.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5095,25 +5143,25 @@ "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
An optional flag that can be included in the DescribeCacheCluster request \n to retrieve information about the individual cache nodes.
An optional flag that can be included in the DescribeCacheCluster request\n to retrieve information about the individual cache nodes.
An optional flag that can be included in the DescribeCacheCluster request\n to show only nodes (API/CLI: clusters) that are not members of a replication group.\n In practice, this mean Memcached and single node Redis clusters.
An optional flag that can be included in the DescribeCacheCluster request\n to show only nodes (API/CLI: clusters) that are not members of a replication group. In\n practice, this mean Memcached and single node Redis clusters.
Returns a list of the available cache\n engines and their versions.
", + "smithy.api#documentation": "Returns a list of the available cache engines and their versions.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5145,7 +5193,7 @@ "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The cache engine to return. Valid values: memcached | redis\n
The cache engine to return. Valid values: memcached |\n redis\n
The name of a specific cache parameter group family to return details for.
\nValid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.x | \n redis6.2 |\n redis7\n
Constraints:
\nMust be 1 to 255 alphanumeric characters
\nFirst character must be a letter
\nCannot end with a hyphen or contain two consecutive hyphens
\nThe name of a specific cache parameter group family to return details for.
\nValid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.x | redis6.2 | redis7\n
Constraints:
\nMust be 1 to 255 alphanumeric characters
\nFirst character must be a letter
\nCannot end with a hyphen or contain two consecutive hyphens
\nThe maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
If true, specifies that only the default version of the specified engine or engine\n and major version combination is to be returned.
If true, specifies that only the default version of the specified engine\n or engine and major version combination is to be returned.
Returns a list of cache parameter group\n descriptions. If a cache parameter group name is specified, the list contains only\n the descriptions for that group.
", + "smithy.api#documentation": "Returns a list of cache parameter group descriptions. If a cache parameter group name\n is specified, the list contains only the descriptions for that group.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5225,13 +5273,13 @@ "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Returns the detailed parameter list for a\n particular cache parameter group.
", + "smithy.api#documentation": "Returns the detailed parameter list for a particular cache parameter group.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5281,19 +5329,19 @@ "Source": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The parameter types to return.
\nValid values: user | system | engine-default\n
The parameter types to return.
\nValid values: user | system |\n engine-default\n
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Returns a list of cache security group\n descriptions. If a cache security group name is specified, the list contains only\n the description of that group. This applicable only when you have ElastiCache in Classic setup\n
", + "smithy.api#documentation": "Returns a list of cache security group descriptions. If a cache security group name is\n specified, the list contains only the description of that group. This applicable only\n when you have ElastiCache in Classic setup
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5342,13 +5390,13 @@ "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Returns a list of cache subnet group\n descriptions. If a subnet group name is specified, the list contains only the\n description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.\n
", + "smithy.api#documentation": "Returns a list of cache subnet group descriptions. If a subnet group name is\n specified, the list contains only the description of that group. This is applicable only\n when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by\n default.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5391,13 +5439,13 @@ "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Returns the default engine and\n system parameter information for the specified cache engine.
", + "smithy.api#documentation": "Returns the default engine and system parameter information for the specified cache\n engine.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "EngineDefaults.Marker", @@ -5437,25 +5485,25 @@ "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the cache parameter group family.
\nValid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.x | \n redis6.2 |\n redis7\n
The name of the cache parameter group family.
\nValid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.x | redis6.2 | redis7\n
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Represents the input of a DescribeEngineDefaultParameters operation.
Represents the input of a DescribeEngineDefaultParameters\n operation.
Returns events related to clusters, cache\n security groups, and cache parameter groups. You can obtain events specific to a\n particular cluster, cache security group, or cache parameter group by providing\n the name as a parameter.
\nBy default, only the events occurring within the last hour are returned; \n however, you can retrieve up to 14 days' worth of events if necessary.
", + "smithy.api#documentation": "Returns events related to clusters, cache security groups, and cache parameter groups.\n You can obtain events specific to a particular cluster, cache security group, or cache\n parameter group by providing the name as a parameter.
\nBy default, only the events occurring within the last hour are returned; however, you\n can retrieve up to 14 days' worth of events if necessary.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5498,25 +5549,25 @@ "SourceIdentifier": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The identifier of the event source for which events are returned. \n If not specified, all sources are included in the response.
" + "smithy.api#documentation": "The identifier of the event source for which events are returned. If not specified,\n all sources are included in the response.
" } }, "SourceType": { "target": "com.amazonaws.elasticache#SourceType", "traits": { - "smithy.api#documentation": "The event source to retrieve events for. \n If no value is specified, all events are returned.
" + "smithy.api#documentation": "The event source to retrieve events for. If no value is specified, all events are\n returned.
" } }, "StartTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
\n\n Example: 2017-03-30T07:03:49.555Z
" + "smithy.api#documentation": "The beginning of the time interval to retrieve events for, specified in ISO 8601\n format.
\n\n Example: 2017-03-30T07:03:49.555Z
" } }, "EndTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "The end of the time interval for which to retrieve events, specified in ISO 8601 format.
\n\n Example: 2017-03-30T07:03:49.555Z
" + "smithy.api#documentation": "The end of the time interval for which to retrieve events, specified in ISO 8601\n format.
\n\n Example: 2017-03-30T07:03:49.555Z
" } }, "Duration": { @@ -5528,13 +5579,13 @@ "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
", + "smithy.api#documentation": "Returns information about a particular global replication group. If no identifier is\n specified, returns information about all Global datastores.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5583,13 +5634,13 @@ "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so that the\n remaining results can be retrieved.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
" + "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >
" } }, "GlobalReplicationGroups": { @@ -5615,6 +5666,9 @@ "smithy.api#documentation": "Indicates the slot configuration and global identifier for each slice group.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#DescribeReplicationGroups": { @@ -5637,7 +5691,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about a particular\n replication group. If no identifier is specified, DescribeReplicationGroups\n returns information about all replication groups.
This operation is valid for Redis only.
\nReturns information about a particular replication group. If no identifier is\n specified, DescribeReplicationGroups returns information about all\n replication groups.
This operation is valid for Redis only.
\nThe identifier for the replication group to be described. This parameter is not case sensitive.
\nIf you do not specify this parameter, information about all replication groups is returned.
" + "smithy.api#documentation": "The identifier for the replication group to be described. This parameter is not case\n sensitive.
\nIf you do not specify this parameter, information about all replication groups is\n returned.
" } }, "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Returns information about reserved cache\n nodes for this account, or about a specified reserved cache node.
", + "smithy.api#documentation": "Returns information about reserved cache nodes for this account, or about a specified\n reserved cache node.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5767,49 +5821,49 @@ "ReservedCacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The reserved cache node identifier filter value. \n Use this parameter to show only the reservation that matches the specified reservation ID.
" + "smithy.api#documentation": "The reserved cache node identifier filter value. Use this parameter to show only the\n reservation that matches the specified reservation ID.
" } }, "ReservedCacheNodesOfferingId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The offering identifier filter value. \n Use this parameter to show only purchased reservations matching the specified offering identifier.
" + "smithy.api#documentation": "The offering identifier filter value. Use this parameter to show only purchased\n reservations matching the specified offering identifier.
" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The cache node type filter value. \n Use this parameter to show only those reservations matching the specified cache node type.
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The cache node type filter value. Use this parameter to show only those reservations\n matching the specified cache node type.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1\n instances.
\nRedis configuration variables appendonly and\n appendfsync are not supported on Redis version 2.8.22 and\n later.
The duration filter value, specified in years or seconds. \n Use this parameter to show only reservations for this duration.
\nValid Values: 1 | 3 | 31536000 | 94608000\n
The duration filter value, specified in years or seconds. Use this parameter to show\n only reservations for this duration.
\nValid Values: 1 | 3 | 31536000 | 94608000\n
The product description filter value. Use this parameter to show only those reservations matching the specified product description.
" + "smithy.api#documentation": "The product description filter value. Use this parameter to show only those\n reservations matching the specified product description.
" } }, "OfferingType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The offering type filter value. \n Use this parameter to show only the available offerings matching the specified offering type.
\nValid values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\"|\"All Upfront\"|\"Partial Upfront\"| \"No Upfront\"\n
The offering type filter value. Use this parameter to show only the available\n offerings matching the specified offering type.
\nValid values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\"|\"All\n Upfront\"|\"Partial Upfront\"| \"No Upfront\"\n
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Lists available reserved cache\n node offerings.
", + "smithy.api#documentation": "Lists available reserved cache node offerings.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5852,48 +5906,48 @@ "ReservedCacheNodesOfferingId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The offering identifier filter value. \n Use this parameter to show only the available offering that matches the specified reservation identifier.
\nExample: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n
The offering identifier filter value. Use this parameter to show only the available\n offering that matches the specified reservation identifier.
\nExample: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n
The cache node type filter value. \n Use this parameter to show only the available offerings matching the specified cache node type.
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The cache node type filter value. Use this parameter to show only the available\n offerings matching the specified cache node type.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1\n instances.
\nRedis configuration variables appendonly and\n appendfsync are not supported on Redis version 2.8.22 and\n later.
Duration filter value, specified in years or seconds. \n Use this parameter to show only reservations for a given duration.
\nValid Values: 1 | 3 | 31536000 | 94608000\n
Duration filter value, specified in years or seconds. Use this parameter to show only\n reservations for a given duration.
\nValid Values: 1 | 3 | 31536000 | 94608000\n
The product description filter value. \n Use this parameter to show only the available offerings matching the specified product description.
" + "smithy.api#documentation": "The product description filter value. Use this parameter to show only the available\n offerings matching the specified product description.
" } }, "OfferingType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The offering type filter value. \n Use this parameter to show only the available offerings matching the specified offering type.
\nValid Values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\" |\"All Upfront\"|\"Partial Upfront\"| \"No Upfront\"\n
The offering type filter value. Use this parameter to show only the available\n offerings matching the specified offering type.
\nValid Values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\" |\"All\n Upfront\"|\"Partial Upfront\"| \"No Upfront\"\n
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Represents the input of a DescribeReservedCacheNodesOfferings operation.
Represents the input of a DescribeReservedCacheNodesOfferings\n operation.
An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Returns information about cluster or replication group snapshots.\n By default, DescribeSnapshots lists all of your snapshots; it can optionally\n describe a single snapshot, or just the snapshots associated with a particular cache\n cluster.
This operation is valid for Redis only.
\nReturns information about cluster or replication group snapshots. By default,\n DescribeSnapshots lists all of your snapshots; it can optionally\n describe a single snapshot, or just the snapshots associated with a particular cache\n cluster.
This operation is valid for Redis only.
\nAn optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
A list of snapshots. Each item in the list contains detailed information about one snapshot.
" + "smithy.api#documentation": "A list of snapshots. Each item in the list contains detailed information about one\n snapshot.
" } } }, @@ -6012,43 +6066,43 @@ "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "A user-supplied replication group identifier.\n If this parameter is specified, only snapshots associated with that specific replication group are described.
" + "smithy.api#documentation": "A user-supplied replication group identifier. If this parameter is specified, only\n snapshots associated with that specific replication group are described.
" } }, "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "A user-supplied cluster identifier. \n If this parameter is specified, only snapshots associated with that specific cluster are described.
" + "smithy.api#documentation": "A user-supplied cluster identifier. If this parameter is specified, only snapshots\n associated with that specific cluster are described.
" } }, "SnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "A user-supplied name of the snapshot. \n If this parameter is specified, only this snapshot are described.
" + "smithy.api#documentation": "A user-supplied name of the snapshot. If this parameter is specified, only this\n snapshot are described.
" } }, "SnapshotSource": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "If set to system, the output shows snapshots that were automatically created by ElastiCache. \n If set to user the output shows snapshots that were manually created. \n If omitted, the output shows both automatically and manually created snapshots.
If set to system, the output shows snapshots that were automatically\n created by ElastiCache. If set to user the output shows snapshots that were\n manually created. If omitted, the output shows both automatically and manually created\n snapshots.
An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 50
\nConstraints: minimum 20; maximum 50.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 50
\nConstraints: minimum 20; maximum 50.
" } }, "ShowNodeGroupConfig": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
" + "smithy.api#documentation": "A Boolean value which if true, the node group (shard) configuration is included in the\n snapshot description.
" } } }, @@ -6118,7 +6172,7 @@ "ServiceUpdateTimeRange": { "target": "com.amazonaws.elasticache#TimeRangeFilter", "traits": { - "smithy.api#documentation": "The range of time specified to search for service updates that are in available status
" + "smithy.api#documentation": "The range of time specified to search for service updates that are in available\n status
" } }, "UpdateActionStatus": { @@ -6142,7 +6196,7 @@ "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so that the\n remaining results can be retrieved.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
" + "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >
" } } } @@ -6211,9 +6265,12 @@ "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
" + "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#DescribeUsers": { @@ -6269,13 +6326,13 @@ "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so that the\n remaining results can be retrieved.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
" + "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >
" } } } @@ -6292,9 +6349,12 @@ "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
" + "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#DestinationDetails": { @@ -6314,7 +6374,7 @@ } }, "traits": { - "smithy.api#documentation": "Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
" + "smithy.api#documentation": "Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose\n destination.
" } }, "com.amazonaws.elasticache#DestinationType": { @@ -6357,7 +6417,7 @@ } ], "traits": { - "smithy.api#documentation": "Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.
" + "smithy.api#documentation": "Remove a secondary cluster from the Global datastore using the Global datastore name.\n The secondary cluster will no longer receive updates from the primary cluster, but will\n remain as a standalone cluster in that Amazon region.
" } }, "com.amazonaws.elasticache#DisassociateGlobalReplicationGroupMessage": { @@ -6380,7 +6440,7 @@ "ReplicationGroupRegion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The Amazon region of secondary cluster you wish to remove from the Global datastore
", + "smithy.api#documentation": "The Amazon region of secondary cluster you wish to remove from the Global\n datastore
", "smithy.api#required": {} } } @@ -6392,6 +6452,9 @@ "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#Double": { @@ -6470,7 +6533,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the information required for client programs to connect to a cache node.
" + "smithy.api#documentation": "Represents the information required for client programs to connect to a cache\n node.
" } }, "com.amazonaws.elasticache#EngineDefaults": { @@ -6479,7 +6542,7 @@ "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "Specifies the name of the cache parameter group family to which the engine default parameters apply.
\nValid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.0 | \n redis6.x | \n redis7\n
Specifies the name of the cache parameter group family to which the engine default\n parameters apply.
\nValid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.0 | redis6.x | redis7\n
A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
" + "smithy.api#documentation": "A list of parameters specific to a particular cache node type. Each element in the\n list contains detailed information about one parameter.
" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a DescribeEngineDefaultParameters operation.
Represents the output of a DescribeEngineDefaultParameters\n operation.
The identifier for the source of the event. \n For example, if the event occurred at the cluster level, \n the identifier would be the name of the cluster.
" + "smithy.api#documentation": "The identifier for the source of the event. For example, if the event occurred at the\n cluster level, the identifier would be the name of the cluster.
" } }, "SourceType": { "target": "com.amazonaws.elasticache#SourceType", "traits": { - "smithy.api#documentation": "Specifies the origin of this event - a cluster, a parameter group, a security group, etc.
" + "smithy.api#documentation": "Specifies the origin of this event - a cluster, a parameter group, a security group,\n etc.
" } }, "Message": { @@ -6540,7 +6603,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a single occurrence of something interesting within the system. \n Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.
" + "smithy.api#documentation": "Represents a single occurrence of something interesting within the system. Some\n examples of events are creating a cluster, adding or removing a cache node, or rebooting\n a node.
" } }, "com.amazonaws.elasticache#EventList": { @@ -6564,7 +6627,7 @@ "Events": { "target": "com.amazonaws.elasticache#EventList", "traits": { - "smithy.api#documentation": "A list of events. Each element in the list contains detailed information about one event.
" + "smithy.api#documentation": "A list of events. Each element in the list contains detailed information about one\n event.
" } } }, @@ -6598,7 +6661,7 @@ } ], "traits": { - "smithy.api#documentation": "Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.
" + "smithy.api#documentation": "Used to failover the primary region to a secondary region. The secondary region will\n become primary, and all other clusters will become secondary.
" } }, "com.amazonaws.elasticache#FailoverGlobalReplicationGroupMessage": { @@ -6633,6 +6696,9 @@ "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#Filter": { @@ -6784,19 +6850,19 @@ "AuthTokenEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "A flag that enables using an AuthToken (password)\n when issuing Redis commands.
Default: false\n
A flag that enables using an AuthToken (password) when issuing Redis\n commands.
Default: false\n
A flag that enables in-transit encryption when set to true.
\n\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
A flag that enables in-transit encryption when set to true.
\n\n Required: Only available when creating a replication\n group in an Amazon VPC using redis version 3.2.6, 4.x or\n later.
A flag that enables encryption at rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the replication\n group is created. \n To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to \n true when you create the replication group.
\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
A flag that enables encryption at rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the\n replication group is created. To enable encryption at rest on a replication group you\n must set AtRestEncryptionEnabled to true when you create the\n replication group.
\n Required: Only available when creating a replication\n group in an Amazon VPC using redis version 3.2.6, 4.x or\n later.
Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary\n cluster automatically replicates updates to the secondary cluster.
\nThe GlobalReplicationGroupIdSuffix represents the name of the Global datastore,\n which is what you use to associate a secondary cluster.
\nConsists of a primary cluster that accepts writes and an associated secondary cluster\n that resides in a different Amazon region. The secondary cluster accepts only reads. The\n primary cluster automatically replicates updates to the secondary cluster.
\nThe GlobalReplicationGroupIdSuffix represents\n the name of the Global datastore, which is what you use to associate a secondary\n cluster.
\nThe role of the replication group in a Global datastore. Can be primary or secondary.
" + "smithy.api#documentation": "The role of the replication group in a Global datastore. Can be primary or\n secondary.
" } } }, "traits": { - "smithy.api#documentation": "The name of the Global datastore and role of this replication group in the Global datastore.
" + "smithy.api#documentation": "The name of the Global datastore and role of this replication group in the Global\n datastore.
" } }, "com.amazonaws.elasticache#GlobalReplicationGroupList": { @@ -6891,7 +6957,7 @@ } }, "traits": { - "smithy.api#documentation": "A member of a Global datastore. It contains the Replication Group Id, the Amazon region and the role of the replication group.
" + "smithy.api#documentation": "A member of a Global datastore. It contains the Replication Group Id, the Amazon\n region and the role of the replication group.
" } }, "com.amazonaws.elasticache#GlobalReplicationGroupMemberList": { @@ -6957,21 +7023,21 @@ "target": "com.amazonaws.elasticache#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The number of node groups you wish to add
", + "smithy.api#documentation": "Total number of node groups you want
", "smithy.api#required": {} } }, "RegionalConfigurations": { "target": "com.amazonaws.elasticache#RegionalConfigurationList", "traits": { - "smithy.api#documentation": "Describes the replication group IDs, the Amazon regions where they are stored and the shard configuration for each that comprise the Global datastore
" + "smithy.api#documentation": "Describes the replication group IDs, the Amazon regions where they are stored and the\n shard configuration for each that comprise the Global datastore
" } }, "ApplyImmediately": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.
", + "smithy.api#documentation": "Indicates that the process begins immediately. At present, the only permitted value\n for this parameter is true.
", "smithy.api#required": {} } } @@ -6983,6 +7049,9 @@ "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#IncreaseReplicaCount": { @@ -7032,7 +7101,7 @@ } ], "traits": { - "smithy.api#documentation": "Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of\n replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation\n is performed with no cluster down time.
" + "smithy.api#documentation": "Dynamically increases the number of replicas in a Redis (cluster mode disabled)\n replication group or the number of replica nodes in one or more node groups (shards) of\n a Redis (cluster mode enabled) replication group. This operation is performed with no\n cluster down time.
" } }, "com.amazonaws.elasticache#IncreaseReplicaCountMessage": { @@ -7048,20 +7117,20 @@ "NewReplicaCount": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of read replica nodes you want at the completion of this operation.\n For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the\n replication group. For Redis (cluster mode enabled) replication groups, this is the number of \n replica nodes in each of the replication group's node groups.
" + "smithy.api#documentation": "The number of read replica nodes you want at the completion of this operation. For\n Redis (cluster mode disabled) replication groups, this is the number of replica nodes in\n the replication group. For Redis (cluster mode enabled) replication groups, this is the\n number of replica nodes in each of the replication group's node groups.
" } }, "ReplicaConfiguration": { "target": "com.amazonaws.elasticache#ReplicaConfigurationList", "traits": { - "smithy.api#documentation": "A list of ConfigureShard objects that can be used to configure each shard\n in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members:\n NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
A list of ConfigureShard objects that can be used to configure each\n shard in a Redis (cluster mode enabled) replication group. The\n ConfigureShard has three members: NewReplicaCount,\n NodeGroupId, and PreferredAvailabilityZones.
If True, the number of replica nodes is increased immediately. \n\n ApplyImmediately=False is not currently supported.
If True, the number of replica nodes is increased immediately.\n ApplyImmediately=False is not currently supported.
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#documentation": "The requested cache node type is not available in the specified Availability Zone. For\n more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7136,7 +7208,7 @@ "code": "InvalidARN", "httpResponseCode": 400 }, - "smithy.api#documentation": "The requested Amazon Resource Name (ARN) does not refer to an existing resource.
", + "smithy.api#documentation": "The requested Amazon Resource Name (ARN) does not refer to an existing\n resource.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7170,7 +7242,7 @@ "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#documentation": "The current state of the cache parameter group does not allow the requested operation\n to occur.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7295,7 +7367,7 @@ "code": "InvalidSnapshotState", "httpResponseCode": 400 }, - "smithy.api#documentation": "The current state of the snapshot does not allow the requested operation to occur.
", + "smithy.api#documentation": "The current state of the snapshot does not allow the requested operation to\n occur.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7428,7 +7500,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all available node types that you\n can scale your Redis cluster's or replication group's current node type.
\nWhen you use the ModifyCacheCluster or ModifyReplicationGroup operations to\n scale your cluster or replication group, the value of the CacheNodeType parameter\n must be one of the node types returned by this operation.
Lists all available node types that you can scale your Redis cluster's or replication\n group's current node type.
\nWhen you use the ModifyCacheCluster or\n ModifyReplicationGroup operations to scale your cluster or replication\n group, the value of the CacheNodeType parameter must be one of the node\n types returned by this operation.
The name of the cluster you want to scale up to a larger node instanced type. \n ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to.
\nYou must provide a value for either the CacheClusterId or the\n ReplicationGroupId.
The name of the cluster you want to scale up to a larger node instanced type.\n ElastiCache uses the cluster id to identify the current node type of this cluster and\n from that to create a list of node types you can scale up to.
\nYou must provide a value for either the CacheClusterId or the\n ReplicationGroupId.
The name of the replication group want to scale up to a larger node type.\n ElastiCache uses the replication group id to identify the current node type being used by\n this replication group, and from that to create a list of node types you can scale up to.
\nYou must provide a value for either the CacheClusterId or the\n ReplicationGroupId.
The name of the replication group want to scale up to a larger node type. ElastiCache\n uses the replication group id to identify the current node type being used by this\n replication group, and from that to create a list of node types you can scale up\n to.
\nYou must provide a value for either the CacheClusterId or the\n ReplicationGroupId.
The input parameters for the ListAllowedNodeTypeModifications operation.
The input parameters for the ListAllowedNodeTypeModifications\n operation.
Lists all tags currently on a named resource.
\nA tag is a key-value pair where the key and value are case-sensitive. \n You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. \n For more information, see Resource-level permissions.
\nIf the cluster is not in the available state, ListTagsForResource\n returns an error.
Lists all tags currently on a named resource.
\nA tag is a key-value pair where the key and value are case-sensitive. You can use\n tags to categorize and track all your ElastiCache resources, with the exception of\n global replication group. When you add or remove tags on replication groups, those\n actions will be replicated to all nodes in the replication group. For more information,\n see Resource-level permissions.
\nIf the cluster is not in the available state,\n ListTagsForResource returns an error.
The Amazon Resource Name (ARN) of the resource for which you want the list of tags, \n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster \n or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which you want the list of tags,\n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or\n arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
For more information about ARNs, see Amazon Resource Names (ARNs)\n and Amazon Web\n Services Service Namespaces.
", "smithy.api#required": {} } } @@ -7519,19 +7591,19 @@ "LogType": { "target": "com.amazonaws.elasticache#LogType", "traits": { - "smithy.api#documentation": "Refers to slow-log or engine-log.
" + "smithy.api#documentation": "Refers to slow-log or\n engine-log.
" } }, "DestinationType": { "target": "com.amazonaws.elasticache#DestinationType", "traits": { - "smithy.api#documentation": "Returns the destination type, either cloudwatch-logs or kinesis-firehose.
Returns the destination type, either cloudwatch-logs or\n kinesis-firehose.
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
" + "smithy.api#documentation": "Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose\n destination.
" } }, "LogFormat": { @@ -7543,7 +7615,7 @@ "Status": { "target": "com.amazonaws.elasticache#LogDeliveryConfigurationStatus", "traits": { - "smithy.api#documentation": "Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error\n
Returns the log delivery configuration status. Values are one of enabling\n | disabling | modifying | active |\n error\n
Refers to slow-log or engine-log..
" + "smithy.api#documentation": "Refers to slow-log or\n engine-log..
" } }, "DestinationType": { "target": "com.amazonaws.elasticache#DestinationType", "traits": { - "smithy.api#documentation": "Specify either cloudwatch-logs or kinesis-firehose as the destination type.
Specify either cloudwatch-logs or kinesis-firehose as the\n destination type.
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
" + "smithy.api#documentation": "Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose\n destination.
" } }, "LogFormat": { @@ -7726,7 +7798,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the settings for a cluster. You\n can use this operation to change one or more cluster configuration parameters by\n specifying the parameters and the new values.
" + "smithy.api#documentation": "Modifies the settings for a cluster. You can use this operation to change one or more\n cluster configuration parameters by specifying the parameters and the new values.
" } }, "com.amazonaws.elasticache#ModifyCacheClusterMessage": { @@ -7742,55 +7814,55 @@ "NumCacheNodes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of cache nodes that the cluster should have. \n If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and \n the number of cache nodes pending creation (which may be zero), more nodes are added. \n If the value is less than the number of existing cache nodes, nodes are removed. \n If the value is equal to the number of current cache nodes, \n any pending add or remove requests are canceled.
If you are removing cache nodes, you must\n use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.
For clusters running Redis, this value must be 1. \n For clusters running Memcached, this value must be between 1 and 40.
\nAdding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).
A pending operation to modify the number of cache nodes in a cluster during its maintenance window, \n whether by adding or removing nodes in accordance with the scale out architecture, is not queued. \n The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the \n number of cache nodes in the cluster. \n For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. \n Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. \n As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, \n a request to add nodes does not automatically override a previous pending operation to add nodes. \n The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and \n retry the new request. \n To cancel pending operations to modify the number of cache nodes in a cluster, \n use the ModifyCacheCluster request and \n set NumCacheNodes equal to the number of cache nodes currently in the cluster.
The number of cache nodes that the cluster should have. If the value for\n NumCacheNodes is greater than the sum of the number of current cache\n nodes and the number of cache nodes pending creation (which may be zero), more nodes are\n added. If the value is less than the number of existing cache nodes, nodes are removed.\n If the value is equal to the number of current cache nodes, any pending add or remove\n requests are canceled.
If you are removing cache nodes, you must use the CacheNodeIdsToRemove\n parameter to provide the IDs of the specific cache nodes to remove.
For clusters running Redis, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.
\nAdding or removing Memcached cache nodes can be applied immediately or as a\n pending operation (see ApplyImmediately).
A pending operation to modify the number of cache nodes in a cluster during its\n maintenance window, whether by adding or removing nodes in accordance with the scale\n out architecture, is not queued. The customer's latest request to add or remove\n nodes to the cluster overrides any previous pending operations to modify the number\n of cache nodes in the cluster. For example, a request to remove 2 nodes would\n override a previous pending operation to remove 3 nodes. Similarly, a request to add\n 2 nodes would override a previous pending operation to remove 3 nodes and vice\n versa. As Memcached cache nodes may now be provisioned in different Availability\n Zones with flexible cache node placement, a request to add nodes does not\n automatically override a previous pending operation to add nodes. The customer can\n modify the previous pending operation to add more nodes or explicitly cancel the\n pending request and retry the new request. To cancel pending operations to modify\n the number of cache nodes in a cluster, use the ModifyCacheCluster\n request and set NumCacheNodes equal to the number of cache nodes\n currently in the cluster.
A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002,\n etc.). This parameter is only valid when NumCacheNodes is less than the existing number\n of cache nodes. The number of cache node IDs supplied in this parameter must match the\n difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is\n greater, and the value of NumCacheNodes in the request.
For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this \n ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.
A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002,\n etc.). This parameter is only valid when NumCacheNodes is less than the\n existing number of cache nodes. The number of cache node IDs supplied in this parameter\n must match the difference between the existing number of cache nodes in the cluster or\n pending cache nodes, whichever is greater, and the value of NumCacheNodes\n in the request.
For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number\n of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 -\n 5) cache node IDs to remove.
Specifies whether the new nodes in this Memcached cluster are all created in a \n single Availability Zone or created across multiple Availability Zones.
\nValid values: single-az | cross-az.
This option is only supported for Memcached clusters.
\nYou cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. \n If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.
Only newly created nodes are located in different Availability Zones. \n
\nSpecifies whether the new nodes in this Memcached cluster are all created in a single\n Availability Zone or created across multiple Availability Zones.
\nValid values: single-az | cross-az.
This option is only supported for Memcached clusters.
\nYou cannot specify single-az if the Memcached cluster already has\n cache nodes in different Availability Zones. If cross-az is specified,\n existing Memcached nodes remain in their current Availability Zone.
Only newly created nodes are located in different Availability Zones.
\nThis option is only supported on Memcached clusters.
\nThe list of Availability Zones where the new Memcached cache nodes are created.
\nThis parameter is only valid when NumCacheNodes in the request is greater \n than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). \n The number of Availability Zones supplied in this list must match the cache nodes being added in this request.
Scenarios:
\n\n Scenario 1: You have 3 active nodes and wish to add 2 nodes. \n Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones \n for the two new nodes.
\n Scenario 2: You have 3 active nodes and 2 nodes pending creation \n (from the scenario 1 call) and want to add 1 more node. \n Specify NumCacheNodes=6 ((3 + 2) + 1) and \n optionally specify an Availability Zone for the new node.
\n Scenario 3: You want to cancel all pending operations. \n Specify NumCacheNodes=3 to cancel all pending operations.
The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, \n add 0 nodes by setting NumCacheNodes to the number of current nodes.
If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. \n Only newly created nodes can be located in different Availability Zones. \n For guidance on how to move existing Memcached nodes to different Availability Zones, see the\n Availability Zone Considerations section of Cache Node Considerations for Memcached.
\n Impact of new add/remove requests upon pending requests\n
\nScenario-1
\nPending Action: Delete
\nNew Request: Delete
\nResult: The new delete, pending or immediate, replaces the pending delete.
\nScenario-2
\nPending Action: Delete
\nNew Request: Create
\nResult: The new create, pending or immediate, replaces the pending delete.
\nScenario-3
\nPending Action: Create
\nNew Request: Delete
\nResult: The new delete, pending or immediate, replaces the pending create.
\nScenario-4
\nPending Action: Create
\nNew Request: Create
\nResult: The new create is added to the pending create.
\n\n Important:\n If the new create request is Apply Immediately - Yes, \n all creates are performed immediately. \n If the new create request is Apply Immediately - No, \n all creates are pending.
\nThis option is only supported on Memcached clusters.
\nThe list of Availability Zones where the new Memcached cache nodes are created.
\nThis parameter is only valid when NumCacheNodes in the request is greater\n than the sum of the number of active cache nodes and the number of cache nodes pending\n creation (which may be zero). The number of Availability Zones supplied in this list\n must match the cache nodes being added in this request.
Scenarios:
\n\n Scenario 1: You have 3 active nodes and wish\n to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally\n specify two Availability Zones for the two new nodes.
\n Scenario 2: You have 3 active nodes and 2\n nodes pending creation (from the scenario 1 call) and want to add 1 more node.\n Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an\n Availability Zone for the new node.
\n Scenario 3: You want to cancel all pending\n operations. Specify NumCacheNodes=3 to cancel all pending\n operations.
The Availability Zone placement of nodes pending creation cannot be modified. If you\n wish to cancel any nodes pending creation, add 0 nodes by setting\n NumCacheNodes to the number of current nodes.
If cross-az is specified, existing Memcached nodes remain in their\n current Availability Zone. Only newly created nodes can be located in different\n Availability Zones. For guidance on how to move existing Memcached nodes to different\n Availability Zones, see the Availability Zone\n Considerations section of Cache Node\n Considerations for Memcached.
\n Impact of new add/remove requests upon pending requests\n
\nScenario-1
\nPending Action: Delete
\nNew Request: Delete
\nResult: The new delete, pending or immediate, replaces the pending\n delete.
\nScenario-2
\nPending Action: Delete
\nNew Request: Create
\nResult: The new create, pending or immediate, replaces the pending\n delete.
\nScenario-3
\nPending Action: Create
\nNew Request: Delete
\nResult: The new delete, pending or immediate, replaces the pending\n create.
\nScenario-4
\nPending Action: Create
\nNew Request: Create
\nResult: The new create is added to the pending create.
\n\n Important: If the new create\n request is Apply Immediately - Yes,\n all creates are performed immediately. If the new create request is\n Apply Immediately - No, all\n creates are pending.
\nA list of cache security group names to authorize on this cluster. \n This change is asynchronously applied as soon as possible.
\nYou can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).
\nConstraints: Must contain no more than 255 alphanumeric characters. Must not be \"Default\".
" + "smithy.api#documentation": "A list of cache security group names to authorize on this cluster. This change is\n asynchronously applied as soon as possible.
\nYou can use this parameter only with clusters that are created outside of an Amazon\n Virtual Private Cloud (Amazon VPC).
\nConstraints: Must contain no more than 255 alphanumeric characters. Must not be\n \"Default\".
" } }, "SecurityGroupIds": { "target": "com.amazonaws.elasticache#SecurityGroupIdsList", "traits": { - "smithy.api#documentation": "Specifies the VPC Security Groups associated with the cluster.
\nThis parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
" + "smithy.api#documentation": "Specifies the VPC Security Groups associated with the cluster.
\nThis parameter can be used only with clusters that are created in an Amazon Virtual\n Private Cloud (Amazon VPC).
" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.
\nValid values for ddd are:
\n sun\n
\n mon\n
\n tue\n
\n wed\n
\n thu\n
\n fri\n
\n sat\n
Example: sun:23:00-mon:01:30\n
Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
\nValid values for ddd are:
\n sun\n
\n mon\n
\n tue\n
\n wed\n
\n thu\n
\n fri\n
\n sat\n
Example: sun:23:00-mon:01:30\n
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
\nThe Amazon SNS topic owner must be same as the cluster owner.
\nThe Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are\n sent.
\nThe Amazon SNS topic owner must be same as the cluster owner.
\nThe name of the cache parameter group to apply to this cluster. This change is\n asynchronously applied as soon as possible for parameters when the\n ApplyImmediately parameter is specified as true for this request.
The name of the cache parameter group to apply to this cluster. This change is\n asynchronously applied as soon as possible for parameters when the\n ApplyImmediately parameter is specified as true for this\n request.
If true, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the PreferredMaintenanceWindow setting for the cluster.
If false, changes to the cluster are applied on the next\n maintenance reboot, or the next failure reboot, whichever occurs first.
If you perform a ModifyCacheCluster before a pending modification is applied, \n the pending modification is replaced by the newer modification.
Valid values: true | false\n
Default: false\n
If true, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the PreferredMaintenanceWindow setting for the cluster.
If false, changes to the cluster are applied on the next maintenance\n reboot, or the next failure reboot, whichever occurs first.
If you perform a ModifyCacheCluster before a pending modification is\n applied, the pending modification is replaced by the newer modification.
Valid values: true | false\n
Default: false\n
The upgraded version of the cache engine to be run on the cache nodes.
\n\n Important: You can upgrade to a newer engine version \n (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version.\n If you want to use an earlier engine version, \n you must delete the existing cluster and create it anew with the earlier engine version.
" + "smithy.api#documentation": "The upgraded version of the cache engine to be run on the cache nodes.
\n\n Important: You can upgrade to a newer engine version\n (see Selecting\n a Cache Engine and Version), but you cannot downgrade to an earlier engine\n version. If you want to use an earlier engine version, you must delete the existing\n cluster and create it anew with the earlier engine version.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. \n
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit is set to zero (0), backups\n are turned off.
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of\n your cluster.
" + "smithy.api#documentation": "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your cluster.
" } }, "CacheNodeType": { @@ -7839,13 +7911,13 @@ "AuthToken": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter.\n Password constraints:
Must be only printable ASCII characters
\nMust be at least 16 characters and no more than 128 characters in length
\nCannot contain any of the following characters: '/', '\"', or '@', '%'
\n\n \n For more information, see AUTH password at AUTH.
" + "smithy.api#documentation": "Reserved parameter. The password used to access a password protected server. This\n parameter must be specified with the auth-token-update parameter. Password\n constraints:
Must be only printable ASCII characters
\nMust be at least 16 characters and no more than 128 characters in\n length
\nCannot contain any of the following characters: '/', '\"', or '@', '%'
\nFor more information, see AUTH password at AUTH.
" } }, "AuthTokenUpdateStrategy": { "target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType", "traits": { - "smithy.api#documentation": "Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter.\n Possible values:
Rotate
\nSet
\n\n For more information, see Authenticating Users with Redis AUTH\n
" + "smithy.api#documentation": "Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token parameter. Possible values:
Rotate
\nSet
\nFor more information, see Authenticating Users with Redis AUTH\n
" } }, "LogDeliveryConfigurations": { @@ -7857,7 +7929,7 @@ "IpDiscovery": { "target": "com.amazonaws.elasticache#IpDiscovery", "traits": { - "smithy.api#documentation": "The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Redis engine version 6.2\n onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Modifies the parameters of a cache\n parameter group. You can modify up to 20 parameters in a single request by submitting a\n list parameter name and value pairs.
" + "smithy.api#documentation": "Modifies the parameters of a cache parameter group. You can modify up to 20 parameters\n in a single request by submitting a list parameter name and value pairs.
" } }, "com.amazonaws.elasticache#ModifyCacheParameterGroupMessage": { @@ -7915,7 +7990,7 @@ "ParameterNameValues": { "target": "com.amazonaws.elasticache#ParameterNameValueList", "traits": { - "smithy.api#documentation": "An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.
", + "smithy.api#documentation": "An array of parameter names and values for the parameter update. You must supply at\n least one parameter name and value; subsequent arguments are optional. A maximum of 20\n parameters may be modified per request.
", "smithy.api#required": {} } } @@ -7959,7 +8034,7 @@ "CacheSubnetGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name for the cache subnet group. This value is stored as a lowercase string.
\nConstraints: Must contain no more than 255 alphanumeric characters or hyphens.
\nExample: mysubnetgroup\n
The name for the cache subnet group. This value is stored as a lowercase\n string.
\nConstraints: Must contain no more than 255 alphanumeric characters or hyphens.
\nExample: mysubnetgroup\n
This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global \n Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.\n
", + "smithy.api#documentation": "This parameter causes the modifications in this request and any pending modifications\n to be applied, asynchronously and as soon as possible. Modifications to Global\n Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.\n
", "smithy.api#required": {} } }, @@ -8038,13 +8116,13 @@ "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The upgraded version of the cache engine to be run on the clusters in the Global datastore.
" + "smithy.api#documentation": "The upgraded version of the cache engine to be run on the clusters in the Global\n datastore.
" } }, "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.
" + "smithy.api#documentation": "The name of the cache parameter group to use with the Global datastore. It must be\n compatible with the major engine version used by the Global datastore.
" } }, "GlobalReplicationGroupDescription": { @@ -8056,7 +8134,7 @@ "AutomaticFailoverEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
" + "smithy.api#documentation": "Determines whether a read replica is automatically promoted to read/write primary if\n the existing primary encounters a failure.
" } } } @@ -8067,6 +8145,9 @@ "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#ModifyReplicationGroup": { @@ -8128,7 +8209,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the settings for a replication group.
\n\n Scaling for Amazon ElastiCache for Redis (cluster mode enabled)\n in the ElastiCache User Guide
\n\n ModifyReplicationGroupShardConfiguration\n in the ElastiCache API Reference
\nThis operation is valid for Redis only.
\nModifies the settings for a replication group.
\n\n Scaling for Amazon ElastiCache for Redis (cluster mode enabled) in\n the ElastiCache User Guide
\n\n ModifyReplicationGroupShardConfiguration in the ElastiCache API\n Reference
\nThis operation is valid for Redis only.
\nFor replication groups with a single primary, \n if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. \n The nodes of all other clusters in the replication group are read replicas.
" + "smithy.api#documentation": "For replication groups with a single primary, if this parameter is specified,\n ElastiCache promotes the specified cluster in the specified replication group to the\n primary role. The nodes of all other clusters in the replication group are read\n replicas.
" } }, "SnapshottingClusterId": { @@ -8162,7 +8243,7 @@ "AutomaticFailoverEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
\nValid values: true | false\n
Determines whether a read replica is automatically promoted to read/write primary if\n the existing primary encounters a failure.
\nValid values: true | false\n
A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.
\nThis parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).
\nConstraints: Must contain no more than 255 alphanumeric characters. Must not be Default.
A list of cache security group names to authorize for the clusters in this replication\n group. This change is asynchronously applied as soon as possible.
\nThis parameter can be used only with replication group containing clusters running\n outside of an Amazon Virtual Private Cloud (Amazon VPC).
\nConstraints: Must contain no more than 255 alphanumeric characters. Must not be\n Default.
Specifies the VPC Security Groups associated with the clusters in the replication group.
\nThis parameter can be used only with replication group containing clusters running in \n an Amazon Virtual Private Cloud (Amazon VPC).
" + "smithy.api#documentation": "Specifies the VPC Security Groups associated with the clusters in the replication\n group.
\nThis parameter can be used only with replication group containing clusters running in\n an Amazon Virtual Private Cloud (Amazon VPC).
" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.
\nValid values for ddd are:
\n sun\n
\n mon\n
\n tue\n
\n wed\n
\n thu\n
\n fri\n
\n sat\n
Example: sun:23:00-mon:01:30\n
Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
\nValid values for ddd are:
\n sun\n
\n mon\n
\n tue\n
\n wed\n
\n thu\n
\n fri\n
\n sat\n
Example: sun:23:00-mon:01:30\n
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
\nThe Amazon SNS topic owner must be same as the replication group owner.
\nThe Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are\n sent.
\nThe Amazon SNS topic owner must be same as the replication group owner.
\nThe name of the cache parameter group to apply to all of the clusters in this replication group. \n This change is asynchronously applied as soon as possible for parameters when the \n ApplyImmediately parameter is specified as true for this request.
The name of the cache parameter group to apply to all of the clusters in this\n replication group. This change is asynchronously applied as soon as possible for\n parameters when the ApplyImmediately parameter is specified as\n true for this request.
The status of the Amazon SNS notification topic for the replication group. \n Notifications are sent only if the status is active.
Valid values: active | inactive\n
The status of the Amazon SNS notification topic for the replication group.\n Notifications are sent only if the status is active.
Valid values: active | inactive\n
The upgraded version of the cache engine to be run on the clusters in the replication group.
\n\n Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version.\n If you want to use an earlier engine version, \n you must delete the existing replication group and create it anew with the earlier engine version.
" + "smithy.api#documentation": "The upgraded version of the cache engine to be run on the clusters in the replication\n group.
\n\n Important: You can upgrade to a newer engine version\n (see Selecting\n a Cache Engine and Version), but you cannot downgrade to an earlier engine\n version. If you want to use an earlier engine version, you must delete the existing\n replication group and create it anew with the earlier engine version.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. \n
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days for which ElastiCache retains automatic node group (shard) snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.
\n Important If the value of SnapshotRetentionLimit is set to zero (0), \n backups are turned off.
" + "smithy.api#documentation": "The number of days for which ElastiCache retains automatic node group (shard)\n snapshots before deleting them. For example, if you set\n SnapshotRetentionLimit to 5, a snapshot that was taken today is\n retained for 5 days before being deleted.
\n Important If the value of SnapshotRetentionLimit is\n set to zero (0), backups are turned off.
" } }, "SnapshotWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of\n the node group (shard) specified by SnapshottingClusterId.
Example: 05:00-09:00\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
" + "smithy.api#documentation": "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of the node group (shard) specified by SnapshottingClusterId.
Example: 05:00-09:00\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate\n time range.
" } }, "CacheNodeType": { @@ -8254,13 +8335,13 @@ "AuthToken": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy \n parameter.\n Password constraints:
Must be only printable ASCII characters
\nMust be at least 16 characters and no more than 128 characters in length
\nCannot contain any of the following characters: '/', '\"', or '@', '%'
\n\n \n For more information, see AUTH password at AUTH.
" + "smithy.api#documentation": "Reserved parameter. The password used to access a password protected server. This\n parameter must be specified with the auth-token-update-strategy parameter.\n Password constraints:
Must be only printable ASCII characters
\nMust be at least 16 characters and no more than 128 characters in\n length
\nCannot contain any of the following characters: '/', '\"', or '@', '%'
\nFor more information, see AUTH password at AUTH.
" } }, "AuthTokenUpdateStrategy": { "target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType", "traits": { - "smithy.api#documentation": "Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter.\n Possible values:
Rotate
\nSet
\n\n For more information, see Authenticating Users with Redis AUTH\n
" + "smithy.api#documentation": "Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token parameter. Possible values:
Rotate
\nSet
\nFor more information, see Authenticating Users with Redis AUTH\n
" } }, "UserGroupIdsToAdd": { @@ -8272,7 +8353,7 @@ "UserGroupIdsToRemove": { "target": "com.amazonaws.elasticache#UserGroupIdList", "traits": { - "smithy.api#documentation": "The ID of the user group to disassociate from the replication group, meaning the users in the group no longer can access the replication group.
" + "smithy.api#documentation": "The ID of the user group to disassociate from the replication group, meaning the users\n in the group no longer can access the replication group.
" } }, "RemoveUserGroups": { @@ -8290,25 +8371,25 @@ "IpDiscovery": { "target": "com.amazonaws.elasticache#IpDiscovery", "traits": { - "smithy.api#documentation": "The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Redis engine version 6.2\n onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
A flag that enables in-transit encryption when set to true. If you are enabling in-transit encryption for an existing cluster, you must also set TransitEncryptionMode to preferred.
A flag that enables in-transit encryption when set to true. If you are enabling\n in-transit encryption for an existing cluster, you must also set\n TransitEncryptionMode to preferred.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
\nYou must set TransitEncryptionEnabled to true, for your existing cluster, and set TransitEncryptionMode to preferred in the same request to allow both encrypted and \nunencrypted connections at the same time. Once you migrate all your Redis clients to use encrypted connections you can set the value to required to allow encrypted connections only.
Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred, after that you can set TransitEncryptionMode to required.\n
A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.
\nYou must set TransitEncryptionEnabled to true, for your\n existing cluster, and set TransitEncryptionMode to preferred\n in the same request to allow both encrypted and unencrypted connections at the same\n time. Once you migrate all your Redis clients to use encrypted connections you can set\n the value to required to allow encrypted connections only.
Setting TransitEncryptionMode to required is a two-step\n process that requires you to first set the TransitEncryptionMode to\n preferred, after that you can set TransitEncryptionMode to\n required.
Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible.\n \n Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
" + "smithy.api#documentation": "Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Redis\n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.
" } } }, @@ -8322,6 +8403,9 @@ "ReplicationGroup": { "target": "com.amazonaws.elasticache#ReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#ModifyReplicationGroupShardConfiguration": { @@ -8365,7 +8449,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies a replication group's shards (node groups) by allowing you to\n add shards, remove shards, or rebalance the keyspaces among existing shards.
" + "smithy.api#documentation": "Modifies a replication group's shards (node groups) by allowing you to add shards,\n remove shards, or rebalance the keyspaces among existing shards.
" } }, "com.amazonaws.elasticache#ModifyReplicationGroupShardConfigurationMessage": { @@ -8374,7 +8458,7 @@ "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the Redis (cluster mode enabled) cluster (replication group)\n on which the shards are to be configured.
", + "smithy.api#documentation": "The name of the Redis (cluster mode enabled) cluster (replication group) on which the\n shards are to be configured.
", "smithy.api#required": {} } }, @@ -8382,7 +8466,7 @@ "target": "com.amazonaws.elasticache#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The number of node groups (shards) that results from the modification of the\n shard configuration.
", + "smithy.api#documentation": "The number of node groups (shards) that results from the modification of the shard\n configuration.
", "smithy.api#required": {} } }, @@ -8390,31 +8474,31 @@ "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates that the shard reconfiguration process begins immediately. \n At present, the only permitted value for this parameter is true.
Value: true
", + "smithy.api#documentation": "Indicates that the shard reconfiguration process begins immediately. At present, the\n only permitted value for this parameter is true.
Value: true
", "smithy.api#required": {} } }, "ReshardingConfiguration": { "target": "com.amazonaws.elasticache#ReshardingConfigurationList", "traits": { - "smithy.api#documentation": "Specifies the preferred availability zones for each node group in the cluster.\n If the value of NodeGroupCount is greater than the current number\n of node groups (shards), you can use this parameter to specify the preferred \n availability zones of the cluster's shards. \n If you omit this parameter ElastiCache selects availability zones for you.
You can specify this parameter only if the value of NodeGroupCount\n is greater than the current number of node groups (shards).
Specifies the preferred availability zones for each node group in the cluster. If the\n value of NodeGroupCount is greater than the current number of node groups\n (shards), you can use this parameter to specify the preferred availability zones of the\n cluster's shards. If you omit this parameter ElastiCache selects availability zones for\n you.
You can specify this parameter only if the value of NodeGroupCount is\n greater than the current number of node groups (shards).
If the value of NodeGroupCount is less than the \n current number of node groups (shards), then either NodeGroupsToRemove or\n NodeGroupsToRetain is required.\n NodeGroupsToRemove is a list of NodeGroupIds to remove \n from the cluster.
ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove\n from the cluster.
If the value of NodeGroupCount is less than the current number of node\n groups (shards), then either NodeGroupsToRemove or\n NodeGroupsToRetain is required. NodeGroupsToRemove is a\n list of NodeGroupIds to remove from the cluster.
ElastiCache for Redis will attempt to remove all node groups listed by\n NodeGroupsToRemove from the cluster.
If the value of NodeGroupCount is less than the \n current number of node groups (shards), then either NodeGroupsToRemove or\n NodeGroupsToRetain is required.\n NodeGroupsToRetain is a list of NodeGroupIds to retain \n in the cluster.
ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain\n from the cluster.
If the value of NodeGroupCount is less than the current number of node\n groups (shards), then either NodeGroupsToRemove or\n NodeGroupsToRetain is required. NodeGroupsToRetain is a\n list of NodeGroupIds to retain in the cluster.
ElastiCache for Redis will attempt to remove all node groups except those listed by\n NodeGroupsToRetain from the cluster.
Represents the input for a ModifyReplicationGroupShardConfiguration operation.
Represents the input for a ModifyReplicationGroupShardConfiguration\n operation.
The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001.\n A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for\n a node group.
" + "smithy.api#documentation": "The identifier for the node group (shard). A Redis (cluster mode disabled) replication\n group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster\n mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090.\n Optionally, the user can provide the id for a node group.
" } }, "Status": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The current state of this replication group - creating, \n available, modifying, deleting.
The current state of this replication group - creating,\n available, modifying, deleting.
A list containing information about individual nodes within the node group (shard).
" + "smithy.api#documentation": "A list containing information about individual nodes within the node group\n (shard).
" } } }, "traits": { - "smithy.api#documentation": "Represents a collection of cache nodes in a replication group.\n One node in the node group is the read/write primary node. \n All the other nodes are read-only Replica nodes.
" + "smithy.api#documentation": "Represents a collection of cache nodes in a replication group. One node in the node\n group is the read/write primary node. All the other nodes are read-only Replica\n nodes.
" } }, "com.amazonaws.elasticache#NodeGroupConfiguration": { @@ -8671,13 +8758,13 @@ "NodeGroupId": { "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { - "smithy.api#documentation": "Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these \n configuration values apply to.
" + "smithy.api#documentation": "Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the\n node group these configuration values apply to.
" } }, "Slots": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "A string that specifies the keyspace for a particular node group.\n Keyspaces range from 0 to 16,383.\n The string is in the format startkey-endkey.
Example: \"0-3999\"\n
A string that specifies the keyspace for a particular node group. Keyspaces range from\n 0 to 16,383. The string is in the format startkey-endkey.
Example: \"0-3999\"\n
The Availability Zone where the primary node of this node group (shard) is launched.
" + "smithy.api#documentation": "The Availability Zone where the primary node of this node group (shard) is\n launched.
" } }, "ReplicaAvailabilityZones": { "target": "com.amazonaws.elasticache#AvailabilityZonesList", "traits": { - "smithy.api#documentation": "A list of Availability Zones to be used for the read replicas.\n The number of Availability Zones in this list must match the value of ReplicaCount\n or ReplicasPerNodeGroup if not specified.
A list of Availability Zones to be used for the read replicas. The number of\n Availability Zones in this list must match the value of ReplicaCount or\n ReplicasPerNodeGroup if not specified.
Node group (shard) configuration options. \n Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.
Node group (shard) configuration options. Each node group (shard) configuration has\n the following: Slots, PrimaryAvailabilityZone,\n ReplicaAvailabilityZones, ReplicaCount.
The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
" + "smithy.api#documentation": "The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002,\n etc.).
" } }, "ReadEndpoint": { @@ -8769,7 +8856,7 @@ "CurrentRole": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The role that is currently assigned to the node - primary or \n replica. This member is only applicable for Redis (cluster mode disabled) \n replication groups.
The role that is currently assigned to the node - primary or\n replica. This member is only applicable for Redis (cluster mode\n disabled) replication groups.
Reflects whether the update was initiated by the customer or automatically applied
" + "smithy.api#documentation": "Reflects whether the update was initiated by the customer or automatically\n applied
" } }, "NodeUpdateInitiatedDate": { @@ -8845,7 +8932,7 @@ } }, "traits": { - "smithy.api#documentation": "The status of the service update on the node group member
" + "smithy.api#documentation": "The status of the service update on the node group member
" } }, "com.amazonaws.elasticache#NodeGroupMemberUpdateStatusList": { @@ -8869,7 +8956,7 @@ "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.
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\n NodeGroupId value correctly.
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#documentation": "The request cannot be processed because it would exceed the maximum allowed number of\n node groups (shards) in a single replication group. The default maximum is 90
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -8950,7 +9037,7 @@ "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#documentation": "The request cannot be processed because it would exceed the allowed number of cache\n nodes in a single cluster.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -8967,7 +9054,7 @@ "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#documentation": "The request cannot be processed because it would exceed the allowed number of cache\n nodes per customer.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -9014,7 +9101,7 @@ "SnapshotCreateTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "The date and time when the source node's metadata and cache data set was obtained for the snapshot.
" + "smithy.api#documentation": "The date and time when the source node's metadata and cache data set was obtained for\n the snapshot.
" } } }, @@ -9112,7 +9199,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes a notification topic and its status. \n Notification topics are used for publishing ElastiCache events to subscribers \n using Amazon Simple Notification Service (SNS).
" + "smithy.api#documentation": "Describes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).
" } }, "com.amazonaws.elasticache#OutpostArnsList": { @@ -9184,7 +9271,7 @@ "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether (true) or not (false) the parameter can be modified. \n Some parameters have security or operational implications that prevent them from being changed.
Indicates whether (true) or not (false) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.
Indicates whether a change to the parameter is applied immediately\n or requires a reboot for the change to be applied. \n You can force a reboot or wait until the next maintenance window's reboot.\n For more information, see Rebooting a Cluster.
" + "smithy.api#documentation": "Indicates whether a change to the parameter is applied immediately or requires a\n reboot for the change to be applied. You can force a reboot or wait until the next\n maintenance window's reboot. For more information, see Rebooting a\n Cluster.
" } } }, "traits": { - "smithy.api#documentation": "Describes an individual setting that controls some aspect of ElastiCache behavior.
" + "smithy.api#documentation": "Describes an individual setting that controls some aspect of ElastiCache\n behavior.
" } }, "com.amazonaws.elasticache#ParameterNameValue": { @@ -9276,7 +9363,7 @@ "LogType": { "target": "com.amazonaws.elasticache#LogType", "traits": { - "smithy.api#documentation": "Refers to slow-log or engine-log..
" + "smithy.api#documentation": "Refers to slow-log or\n engine-log..
" } }, "DestinationType": { @@ -9288,7 +9375,7 @@ "DestinationDetails": { "target": "com.amazonaws.elasticache#DestinationDetails", "traits": { - "smithy.api#documentation": "Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
" + "smithy.api#documentation": "Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose\n destination.
" } }, "LogFormat": { @@ -9314,19 +9401,19 @@ "NumCacheNodes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The new number of cache nodes for the cluster.
\nFor clusters running Redis, this value must be 1. \n For clusters running Memcached, this value must be between 1 and 40.
" + "smithy.api#documentation": "The new number of cache nodes for the cluster.
\nFor clusters running Redis, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.
" } }, "CacheNodeIdsToRemove": { "target": "com.amazonaws.elasticache#CacheNodeIdsList", "traits": { - "smithy.api#documentation": "A list of cache node IDs that are being removed (or will be removed) from the cluster. \n A node ID is a 4-digit numeric identifier (0001, 0002, etc.).
" + "smithy.api#documentation": "A list of cache node IDs that are being removed (or will be removed) from the cluster.\n A node ID is a 4-digit numeric identifier (0001, 0002, etc.).
" } }, "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The new cache engine version that the cluster runs.
" + "smithy.api#documentation": "The new cache engine version that the cluster runs.
" } }, "CacheNodeType": { @@ -9356,12 +9443,12 @@ "TransitEncryptionMode": { "target": "com.amazonaws.elasticache#TransitEncryptionMode", "traits": { - "smithy.api#documentation": "A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
" + "smithy.api#documentation": "A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.
" } } }, "traits": { - "smithy.api#documentation": "A group of settings that are applied to the cluster in the future, \n or that are currently being applied.
" + "smithy.api#documentation": "A group of settings that are applied to the cluster in the future, or that are\n currently being applied.
" } }, "com.amazonaws.elasticache#PreferredAvailabilityZoneList": { @@ -9452,7 +9539,7 @@ } ], "traits": { - "smithy.api#documentation": "Allows you to purchase a reserved\n cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, \n see Managing Costs with Reserved Nodes for Redis or \n Managing Costs with Reserved Nodes for Memcached.
" + "smithy.api#documentation": "Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible\n for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes for Redis or Managing Costs with\n Reserved Nodes for Memcached.
" } }, "com.amazonaws.elasticache#PurchaseReservedCacheNodesOfferingMessage": { @@ -9468,7 +9555,7 @@ "ReservedCacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "A customer-specified identifier to track this reservation.
\nThe Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. \n If this parameter is not specified, \n ElastiCache automatically generates an identifier for the reservation.
\nExample: myreservationID
" + "smithy.api#documentation": "A customer-specified identifier to track this reservation.
\nThe Reserved Cache Node ID is an unique customer-specified identifier to track\n this reservation. If this parameter is not specified, ElastiCache automatically\n generates an identifier for the reservation.
\nExample: myreservationID
" } }, "CacheNodeCount": { @@ -9480,12 +9567,12 @@ "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
" + "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, "traits": { - "smithy.api#documentation": "Represents the input of a PurchaseReservedCacheNodesOffering operation.
Represents the input of a PurchaseReservedCacheNodesOffering\n operation.
Redistribute slots to ensure uniform distribution across existing shards in the cluster.
" + "smithy.api#documentation": "Redistribute slots to ensure uniform distribution across existing shards in the\n cluster.
" } }, "com.amazonaws.elasticache#RebalanceSlotsInGlobalReplicationGroupMessage": { @@ -9545,6 +9635,9 @@ "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#RebootCacheCluster": { @@ -9564,7 +9657,7 @@ } ], "traits": { - "smithy.api#documentation": "Reboots some, or all, of the cache nodes\n within a provisioned cluster. This operation applies any modified cache parameter\n groups to the cluster. The reboot operation takes place as soon as possible, and\n results in a momentary outage to the cluster. During the reboot, the cluster\n status is set to REBOOTING.
\nThe reboot causes the contents of the cache (for each cache node being rebooted) to be lost.
\nWhen the reboot is complete, a cluster event is created.
\nRebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters.\n Rebooting is not supported on Redis (cluster mode enabled) clusters.
\nIf you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied,\n see Rebooting a Cluster for an alternate process.
" + "smithy.api#documentation": "Reboots some, or all, of the cache nodes within a provisioned cluster. This operation\n applies any modified cache parameter groups to the cluster. The reboot operation takes\n place as soon as possible, and results in a momentary outage to the cluster. During the\n reboot, the cluster status is set to REBOOTING.
\nThe reboot causes the contents of the cache (for each cache node being rebooted) to be\n lost.
\nWhen the reboot is complete, a cluster event is created.
\nRebooting a cluster is currently supported on Memcached and Redis (cluster mode\n disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled)\n clusters.
\nIf you make changes to parameters that require a Redis (cluster mode enabled) cluster\n reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.
" } }, "com.amazonaws.elasticache#RebootCacheClusterMessage": { @@ -9580,7 +9673,7 @@ "CacheNodeIdsToReboot": { "target": "com.amazonaws.elasticache#CacheNodeIdsList", "traits": { - "smithy.api#documentation": "A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.
", + "smithy.api#documentation": "A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002,\n etc.). To reboot an entire cluster, specify all of the cache node IDs.
", "smithy.api#required": {} } } @@ -9595,6 +9688,9 @@ "CacheCluster": { "target": "com.amazonaws.elasticache#CacheCluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#RecurringCharge": { @@ -9615,7 +9711,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the specific price and frequency of a recurring charges for a reserved cache node, \n or for a reserved cache node offering.
" + "smithy.api#documentation": "Contains the specific price and frequency of a recurring charges for a reserved cache\n node, or for a reserved cache node offering.
" } }, "com.amazonaws.elasticache#RecurringChargeList": { @@ -9647,7 +9743,7 @@ "ReshardingConfiguration": { "target": "com.amazonaws.elasticache#ReshardingConfigurationList", "traits": { - "smithy.api#documentation": "A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.
A list of PreferredAvailabilityZones objects that specifies the\n configuration of a node group in the resharded cluster.
Removes the tags identified by the TagKeys \n list from the named resource. A tag is a key-value pair where the key and value are case-sensitive. \n You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. \n For more information, see Resource-level permissions.
Removes the tags identified by the TagKeys list from the named resource.\n A tag is a key-value pair where the key and value are case-sensitive. You can use tags\n to categorize and track all your ElastiCache resources, with the exception of global\n replication group. When you add or remove tags on replication groups, those actions will\n be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
The Amazon Resource Name (ARN) of the resource from which you want the tags removed, \n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster \n or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which you want the tags removed,\n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or\n arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
For more information about ARNs, see Amazon Resource Names (ARNs)\n and Amazon Service Namespaces.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.elasticache#KeyList", "traits": { - "smithy.api#documentation": "A list of TagKeys identifying the tags you want removed from the named resource.
A list of TagKeys identifying the tags you want removed from the named\n resource.
The name of the Global datastore and role of this replication group in the Global datastore.
" + "smithy.api#documentation": "The name of the Global datastore and role of this replication group in the Global\n datastore.
" } }, "Status": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The current state of this replication group - \n creating, \n available, \n modifying, \n deleting, \n create-failed,\n snapshotting.
The current state of this replication group - creating,\n available, modifying, deleting,\n create-failed, snapshotting.
A group of settings to be applied to the replication group, \n either immediately or during the next maintenance window.
" + "smithy.api#documentation": "A group of settings to be applied to the replication group, either immediately or\n during the next maintenance window.
" } }, "MemberClusters": { @@ -9794,13 +9890,13 @@ "NodeGroups": { "target": "com.amazonaws.elasticache#NodeGroupList", "traits": { - "smithy.api#documentation": "A list of node groups in this replication group.\n For Redis (cluster mode disabled) replication groups, this is a single-element list.\n For Redis (cluster mode enabled) replication groups, the list contains an entry for each\n node group (shard).
" + "smithy.api#documentation": "A list of node groups in this replication group. For Redis (cluster mode disabled)\n replication groups, this is a single-element list. For Redis (cluster mode enabled)\n replication groups, the list contains an entry for each node group (shard).
" } }, "SnapshottingClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The cluster ID that is used as the daily snapshot source for the replication group.
" + "smithy.api#documentation": "The cluster ID that is used as the daily snapshot source for the replication\n group.
" } }, "AutomaticFailover": { @@ -9812,43 +9908,43 @@ "MultiAZ": { "target": "com.amazonaws.elasticache#MultiAZStatus", "traits": { - "smithy.api#documentation": "A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ\n
" + "smithy.api#documentation": "A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more\n information, see Minimizing Downtime: Multi-AZ\n
" } }, "ConfigurationEndpoint": { "target": "com.amazonaws.elasticache#Endpoint", "traits": { - "smithy.api#documentation": "The configuration endpoint for this replication group. \n Use the configuration endpoint to connect to this replication group.
" + "smithy.api#documentation": "The configuration endpoint for this replication group. Use the configuration endpoint\n to connect to this replication group.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.
\n If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit is set to zero (0), backups\n are turned off.
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
\nExample: 05:00-09:00\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
\nThis parameter is only valid if the Engine parameter is redis.
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your node group (shard).
\nExample: 05:00-09:00\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate\n time range.
\nThis parameter is only valid if the Engine parameter is\n redis.
A flag indicating whether or not this replication group is cluster enabled; \n i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).
\nValid values: true | false\n
A flag indicating whether or not this replication group is cluster enabled; i.e.,\n whether its data can be partitioned across multiple shards (API/CLI: node\n groups).
\nValid values: true | false\n
The name of the compute and memory capacity node type for each node in the replication group.
" + "smithy.api#documentation": "The name of the compute and memory capacity node type for each node in the replication\n group.
" } }, "AuthTokenEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "A flag that enables using an AuthToken (password)\n when issuing Redis commands.
Default: false\n
A flag that enables using an AuthToken (password) when issuing Redis\n commands.
Default: false\n
A flag that enables in-transit encryption when set to true.
\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false\n
A flag that enables in-transit encryption when set to true.
\n Required: Only available when creating a replication\n group in an Amazon VPC using redis version 3.2.6, 4.x or\n later.
Default: false\n
A flag that enables encryption at-rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled\n after the cluster is created. To enable encryption at-rest on a cluster\n you must set AtRestEncryptionEnabled to true\n when you create a cluster.
\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false\n
A flag that enables encryption at-rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the cluster\n is created. To enable encryption at-rest on a cluster you must set\n AtRestEncryptionEnabled to true when you create a\n cluster.
\n Required: Only available when creating a replication\n group in an Amazon VPC using redis version 3.2.6, 4.x or\n later.
Default: false\n
Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes.\n For more information, see Data tiering.
" + "smithy.api#documentation": "Enables data tiering. Data tiering is only supported for replication groups using the\n r6gd node type. This parameter must be set to true when using r6gd nodes. For more\n information, see Data tiering.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if you\n want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.
" } }, "NetworkType": { "target": "com.amazonaws.elasticache#NetworkType", "traits": { - "smithy.api#documentation": "Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Redis engine version 6.2 onward or Memcached engine\n version 1.6.6 on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Redis engine version 6.2\n onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
" + "smithy.api#documentation": "A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.
" } }, "ClusterMode": { "target": "com.amazonaws.elasticache#ClusterMode", "traits": { - "smithy.api#documentation": "Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible.\n \n Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
" + "smithy.api#documentation": "Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Redis\n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.
" } } }, @@ -10014,7 +10110,7 @@ "ReplicationGroups": { "target": "com.amazonaws.elasticache#ReplicationGroupList", "traits": { - "smithy.api#documentation": "A list of replication groups. Each item in the list contains detailed information about one replication group.
" + "smithy.api#documentation": "A list of replication groups. Each item in the list contains detailed information\n about one replication group.
" } } }, @@ -10071,7 +10167,7 @@ "PrimaryClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The primary cluster ID that is applied immediately (if --apply-immediately \n was specified), or during the next maintenance window.
The primary cluster ID that is applied immediately (if\n --apply-immediately was specified), or during the next maintenance\n window.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
" + "smithy.api#documentation": "A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.
" } }, "ClusterMode": { "target": "com.amazonaws.elasticache#ClusterMode", "traits": { - "smithy.api#documentation": "Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible.\n \n Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
" + "smithy.api#documentation": "Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Redis\n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.
" } } }, "traits": { - "smithy.api#documentation": "The settings to be applied to the Redis replication group, \n either immediately or during the next maintenance window.
" + "smithy.api#documentation": "The settings to be applied to the Redis replication group, either immediately or\n during the next maintenance window.
" } }, "com.amazonaws.elasticache#ReservedCacheNode": { @@ -10145,7 +10241,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The cache node type for the reserved cache nodes.
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The cache node type for the reserved cache nodes.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1\n instances.
\nRedis configuration variables appendonly and\n appendfsync are not supported on Redis version 2.8.22 and\n later.
The Amazon Resource Name (ARN) of the reserved cache node.
\nExample: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582\n
The Amazon Resource Name (ARN) of the reserved cache node.
\nExample:\n arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582\n
Represents the output of a PurchaseReservedCacheNodesOffering operation.
Represents the output of a PurchaseReservedCacheNodesOffering\n operation.
A list of reserved cache nodes. Each element in the list contains detailed information about one node.
" + "smithy.api#documentation": "A list of reserved cache nodes. Each element in the list contains detailed information\n about one node.
" } } }, @@ -10292,7 +10388,7 @@ "code": "ReservedCacheNodeQuotaExceeded", "httpResponseCode": 400 }, - "smithy.api#documentation": "The request cannot be processed because it would exceed the user's cache node quota.
", + "smithy.api#documentation": "The request cannot be processed because it would exceed the user's cache node\n quota.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -10309,7 +10405,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The cache node type for the reserved cache node.
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The cache node type for the reserved cache node.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1\n instances.
\nRedis configuration variables appendonly and\n appendfsync are not supported on Redis version 2.8.22 and\n later.
A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.
" + "smithy.api#documentation": "A list of reserved cache node offerings. Each element in the list contains detailed\n information about one offering.
" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a DescribeReservedCacheNodesOfferings operation.
Represents the output of a DescribeReservedCacheNodesOfferings\n operation.
Modifies the parameters of a cache\n parameter group to the engine or system default value. You can reset specific parameters\n by submitting a list of parameter names. To reset the entire cache parameter group,\n specify the ResetAllParameters and CacheParameterGroupName parameters.
Modifies the parameters of a cache parameter group to the engine or system default\n value. You can reset specific parameters by submitting a list of parameter names. To\n reset the entire cache parameter group, specify the ResetAllParameters and\n CacheParameterGroupName parameters.
If true, \n all parameters in the cache parameter group are reset to their default values.\n If false, only the parameters listed by ParameterNameValues\n are reset to their default values.
Valid values: true | false\n
If true, all parameters in the cache parameter group are reset to their\n default values. If false, only the parameters listed by\n ParameterNameValues are reset to their default values.
Valid values: true | false\n
An array of parameter names to reset to their default values. \n If ResetAllParameters is true, \n do not use ParameterNameValues.\n If ResetAllParameters is false, \n you must specify the name of at least one parameter to reset.
An array of parameter names to reset to their default values. If\n ResetAllParameters is true, do not use\n ParameterNameValues. If ResetAllParameters is\n false, you must specify the name of at least one parameter to\n reset.
Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these \n configuration values apply to.
" + "smithy.api#documentation": "Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the\n node group these configuration values apply to.
" } }, "PreferredAvailabilityZones": { @@ -10476,7 +10572,7 @@ } }, "traits": { - "smithy.api#documentation": "A list of PreferredAvailabilityZones objects that specifies\n the configuration of a node group in the resharded cluster.
A list of PreferredAvailabilityZones objects that specifies the\n configuration of a node group in the resharded cluster.
Revokes ingress from a cache security group. \n Use this operation to disallow access from an Amazon EC2 security group\n that had been previously authorized.
" + "smithy.api#documentation": "Revokes ingress from a cache security group. Use this operation to disallow access\n from an Amazon EC2 security group that had been previously authorized.
" } }, "com.amazonaws.elasticache#RevokeCacheSecurityGroupIngressMessage": { @@ -10551,13 +10647,13 @@ "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The Amazon account number of the Amazon EC2 security group owner. \n Note that this is not the same thing as an Amazon access key ID - you must provide \n a valid Amazon account number for this parameter.
", + "smithy.api#documentation": "The Amazon account number of the Amazon EC2 security group owner. Note that this is\n not the same thing as an Amazon access key ID - you must provide a valid Amazon account\n number for this parameter.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a RevokeCacheSecurityGroupIngress operation.
Represents the input of a RevokeCacheSecurityGroupIngress\n operation.
The status of the cache security group membership. \n The status changes whenever a cache security group is modified, \n or when the cache security groups assigned to a cluster are modified.
" + "smithy.api#documentation": "The status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cluster are\n modified.
" } } }, @@ -10650,7 +10749,7 @@ "ServiceUpdateRecommendedApplyByDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "The recommendend date to apply the service update in order to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
" + "smithy.api#documentation": "The recommendend date to apply the service update in order to ensure compliance. For\n information on compliance, see Self-Service Security Updates for Compliance.
" } }, "ServiceUpdateStatus": { @@ -10680,13 +10779,13 @@ "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The Elasticache engine version to which the update applies. Either Redis or Memcached engine version
" + "smithy.api#documentation": "The Elasticache engine version to which the update applies. Either Redis or Memcached\n engine version
" } }, "AutoUpdateAfterRecommendedApplyByDate": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "Indicates whether the service update will be automatically applied once the recommended apply-by date has expired.
" + "smithy.api#documentation": "Indicates whether the service update will be automatically applied once the\n recommended apply-by date has expired.
" } }, "EstimatedUpdateTime": { @@ -10807,7 +10906,7 @@ "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
The name of a snapshot. \n For an automatic snapshot, the name is system-generated. \n For a manual snapshot, this is the user-provided name.
" + "smithy.api#documentation": "The name of a snapshot. For an automatic snapshot, the name is system-generated. For a\n manual snapshot, this is the user-provided name.
" } }, "ReplicationGroupId": { @@ -10886,25 +10985,25 @@ "SnapshotStatus": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The status of the snapshot. Valid values: creating | available\n | restoring | copying | deleting.
The status of the snapshot. Valid values: creating |\n available | restoring | copying |\n deleting.
Indicates whether the snapshot is from an automatic backup (automated) \n or was created manually (manual).
Indicates whether the snapshot is from an automatic backup (automated) or\n was created manually (manual).
The name of the compute and memory capacity node type for the source cluster.
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.
The name of the compute and memory capacity node type for the source cluster.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n
\n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n
\n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n
\n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro\n
\n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n
\n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n
\n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n
\n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1\n instances.
\nRedis configuration variables appendonly and\n appendfsync are not supported on Redis version 2.8.22 and\n later.
The name of the cache engine (memcached or \n redis) used by the source cluster.
The name of the cache engine (memcached or redis) used by\n the source cluster.
The number of cache nodes in the source cluster.
\nFor clusters running Redis, this value must be 1. \n For clusters running Memcached, this value must be between 1 and 40.
" + "smithy.api#documentation": "The number of cache nodes in the source cluster.
\nFor clusters running Redis, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.
" } }, "PreferredAvailabilityZone": { @@ -10940,13 +11039,13 @@ "PreferredMaintenanceWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.
\nValid values for ddd are:
\n sun\n
\n mon\n
\n tue\n
\n wed\n
\n thu\n
\n fri\n
\n sat\n
Example: sun:23:00-mon:01:30\n
Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
\nValid values for ddd are:
\n sun\n
\n mon\n
\n tue\n
\n wed\n
\n thu\n
\n fri\n
\n sat\n
Example: sun:23:00-mon:01:30\n
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing\n notifications.
" } }, "Port": { @@ -10970,38 +11069,38 @@ "VpcId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
" + "smithy.api#documentation": "The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the\n source cluster.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. \n
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
\nFor manual snapshots, this field reflects the SnapshotRetentionLimit for the\n source cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot\n operation.
\n Important\n If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
" + "smithy.api#documentation": "For an automatic snapshot, the number of days for which ElastiCache retains the\n snapshot before deleting it.
\nFor manual snapshots, this field reflects the SnapshotRetentionLimit for\n the source cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the\n DeleteSnapshot operation.
\n Important If the value of SnapshotRetentionLimit is set\n to zero (0), backups are turned off.
" } }, "SnapshotWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The daily time range during which ElastiCache takes daily snapshots of the source cluster.
" + "smithy.api#documentation": "The daily time range during which ElastiCache takes daily snapshots of the source\n cluster.
" } }, "NumNodeGroups": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of node groups (shards) in this snapshot.\n When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored \n replication group must be the same.
" + "smithy.api#documentation": "The number of node groups (shards) in this snapshot. When restoring from a snapshot,\n the number of node groups (shards) in the snapshot and in the restored replication group\n must be the same.
" } }, "AutomaticFailover": { "target": "com.amazonaws.elasticache#AutomaticFailoverStatus", "traits": { - "smithy.api#documentation": "Indicates the status of automatic failover for the source Redis replication group.
" + "smithy.api#documentation": "Indicates the status of automatic failover for the source Redis replication\n group.
" } }, "NodeSnapshots": { @@ -11025,12 +11124,12 @@ "DataTiering": { "target": "com.amazonaws.elasticache#DataTieringStatus", "traits": { - "smithy.api#documentation": "Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes.\n For more information, see Data tiering.
" + "smithy.api#documentation": "Enables data tiering. Data tiering is only supported for replication groups using the\n r6gd node type. This parameter must be set to true when using r6gd nodes. For more\n information, see Data tiering.
" } } }, "traits": { - "smithy.api#documentation": "Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
" + "smithy.api#documentation": "Represents a copy of an entire Redis cluster as of the time when the snapshot was\n taken.
" } }, "com.amazonaws.elasticache#SnapshotAlreadyExistsFault": { @@ -11071,7 +11170,7 @@ "code": "SnapshotFeatureNotSupportedFault", "httpResponseCode": 400 }, - "smithy.api#documentation": "You attempted one of the following operations:
\nCreating a snapshot of a Redis cluster running on a cache.t1.micro cache\n node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
\nNeither of these are supported by ElastiCache.
", + "smithy.api#documentation": "You attempted one of the following operations:
\nCreating a snapshot of a Redis cluster running on a\n cache.t1.micro cache node.
Creating a snapshot of a cluster that is running Memcached rather than\n Redis.
\nNeither of these are supported by ElastiCache.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -11114,7 +11213,7 @@ "code": "SnapshotQuotaExceededFault", "httpResponseCode": 400 }, - "smithy.api#documentation": "The request cannot be processed because it would exceed the maximum number of snapshots.
", + "smithy.api#documentation": "The request cannot be processed because it would exceed the maximum number of\n snapshots.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -11205,7 +11304,7 @@ "CustomerNodeEndpointList": { "target": "com.amazonaws.elasticache#CustomerNodeEndpointList", "traits": { - "smithy.api#documentation": "List of endpoints from which data should be migrated. For Redis (cluster mode disabled), list should have only one element.
", + "smithy.api#documentation": "List of endpoints from which data should be migrated. For Redis (cluster mode\n disabled), list should have only one element.
", "smithy.api#required": {} } } @@ -11249,12 +11348,12 @@ "SupportedNetworkTypes": { "target": "com.amazonaws.elasticache#NetworkTypeList", "traits": { - "smithy.api#documentation": "Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
Either ipv4 | ipv6 | dual_stack. IPv6 is\n supported for workloads using Redis engine version 6.2 onward or Memcached engine\n version 1.6.6 on all instances built on the Nitro system.
Represents the subnet associated with a cluster. \n This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
" + "smithy.api#documentation": "Represents the subnet associated with a cluster. This parameter refers to subnets\n defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
" } }, "com.amazonaws.elasticache#SubnetIdentifierList": { @@ -11304,7 +11403,7 @@ "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#documentation": "At least one subnet ID does not match the other subnet IDs. This mismatch typically\n occurs when a user sets one subnet ID to a regional Availability Zone and a different\n one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed\n on this service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -11343,7 +11442,7 @@ } }, "traits": { - "smithy.api#documentation": "A tag that can be added to an ElastiCache cluster or replication group. \n Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.
" + "smithy.api#documentation": "A tag that can be added to an ElastiCache cluster or replication group. Tags are\n composed of a Key/Value pair. You can use tags to categorize and track all your\n ElastiCache resources, with the exception of global replication group. When you add or\n remove tags on replication groups, those actions will be replicated to all nodes in the\n replication group. A tag with a null Value is permitted.
" } }, "com.amazonaws.elasticache#TagList": { @@ -11366,7 +11465,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the output from the AddTagsToResource, \n ListTagsForResource, and RemoveTagsFromResource operations.
Represents the output from the AddTagsToResource,\n ListTagsForResource, and RemoveTagsFromResource\n operations.
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#documentation": "The request cannot be processed because it would cause the resource to have more than\n the allowed number of tags. The maximum number of tags permitted on a resource is\n 50.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -11441,7 +11540,7 @@ } ], "traits": { - "smithy.api#documentation": "Represents the input of a TestFailover operation which test automatic failover on\n a specified node group (called shard in the console) in a replication group (called cluster in the console).
This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool \n for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.
\n\n Note the following\n
\nA customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and Amazon CLI) \n in any rolling 24-hour period.
\nIf calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
\n\n
If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, \n the first node replacement must complete before a subsequent call can be made.
\nTo determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console,\n the Amazon CLI, or the ElastiCache API.\n Look for the following automatic failover related events, listed here in order of occurrance:
\nReplication group message: Test Failover API called for node group \n
Cache cluster message: Failover from primary node \n
Replication group message: Failover from primary node \n
Cache cluster message: Recovering cache nodes \n
Cache cluster message: Finished recovery for cache nodes \n
For more information see:
\n\n Viewing ElastiCache Events\n in the ElastiCache User Guide\n
\n\n DescribeEvents in the ElastiCache API Reference
\nAlso see, Testing Multi-AZ in the ElastiCache User Guide.
" + "smithy.api#documentation": "Represents the input of a TestFailover operation which test automatic\n failover on a specified node group (called shard in the console) in a replication group\n (called cluster in the console).
This API is designed for testing the behavior of your application in case of\n ElastiCache failover. It is not designed to be an operational tool for initiating a\n failover to overcome a problem you may have with the cluster. Moreover, in certain\n conditions such as large-scale operational events, Amazon may block this API.
\n\n Note the following\n
\nA customer can use this operation to test automatic failover on up to 5 shards\n (called node groups in the ElastiCache API and Amazon CLI) in any rolling\n 24-hour period.
\nIf calling this operation on shards in different clusters (called replication\n groups in the API and CLI), the calls can be made concurrently.
\n\n
If calling this operation multiple times on different shards in the same Redis\n (cluster mode enabled) replication group, the first node replacement must\n complete before a subsequent call can be made.
\nTo determine whether the node replacement is complete you can check Events\n using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API.\n Look for the following automatic failover related events, listed here in order\n of occurrance:
\nReplication group message: Test Failover API called for node\n group \n
Cache cluster message: Failover from primary node\n \n
Replication group message: Failover from primary node\n \n
Cache cluster message: Recovering cache nodes\n \n
Cache cluster message: Finished recovery for cache nodes\n \n
For more information see:
\n\n Viewing\n ElastiCache Events in the ElastiCache User\n Guide\n
\n\n DescribeEvents in the ElastiCache API Reference
\nAlso see, Testing\n Multi-AZ in the ElastiCache User Guide.
" } }, "com.amazonaws.elasticache#TestFailoverMessage": { @@ -11457,7 +11556,7 @@ "NodeGroupId": { "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { - "smithy.api#documentation": "The name of the node group (called shard in the console) in this replication group on\n which automatic failover is to be tested.\n You may test automatic failover on up to 5 node groups in any rolling 24-hour period.
", + "smithy.api#documentation": "The name of the node group (called shard in the console) in this replication group on\n which automatic failover is to be tested. You may test automatic failover on up to 5\n node groups in any rolling 24-hour period.
", "smithy.api#required": {} } } @@ -11486,6 +11585,65 @@ "ReplicationGroup": { "target": "com.amazonaws.elasticache#ReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#TestMigration": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#TestMigrationMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#TestMigrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupAlreadyUnderMigrationFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Async API to test connection between source and target replication group.
" + } + }, + "com.amazonaws.elasticache#TestMigrationMessage": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "The ID of the replication group to which data is to be migrated.
", + "smithy.api#required": {} + } + }, + "CustomerNodeEndpointList": { + "target": "com.amazonaws.elasticache#CustomerNodeEndpointList", + "traits": { + "smithy.api#documentation": "List of endpoints from which data should be migrated. List should have only one\n element.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.elasticache#TestMigrationResponse": { + "type": "structure", + "members": { + "ReplicationGroup": { + "target": "com.amazonaws.elasticache#ReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#TimeRangeFilter": { @@ -11505,7 +11663,7 @@ } }, "traits": { - "smithy.api#documentation": "Filters update actions from the service updates that are in available status during the time range.
" + "smithy.api#documentation": "Filters update actions from the service updates that are in available status during\n the time range.
" } }, "com.amazonaws.elasticache#TransitEncryptionMode": { @@ -11566,7 +11724,7 @@ } }, "traits": { - "smithy.api#documentation": "Update action that has failed to be processed for the corresponding apply/stop request
" + "smithy.api#documentation": "Update action that has failed to be processed for the corresponding apply/stop\n request
" } }, "com.amazonaws.elasticache#UnprocessedUpdateActionList": { @@ -11620,13 +11778,13 @@ "ServiceUpdateRecommendedApplyByDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
" + "smithy.api#documentation": "The recommended date to apply the service update to ensure compliance. For information\n on compliance, see Self-Service Security Updates for Compliance.
" } }, "ServiceUpdateType": { "target": "com.amazonaws.elasticache#ServiceUpdateType", "traits": { - "smithy.api#documentation": "Reflects the nature of the service update
" + "smithy.api#documentation": "Reflects the nature of the service update
" } }, "UpdateActionAvailableDate": { @@ -11656,7 +11814,7 @@ "SlaMet": { "target": "com.amazonaws.elasticache#SlaMet", "traits": { - "smithy.api#documentation": "If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the\n recommended apply-by date.
" + "smithy.api#documentation": "If yes, all nodes in the replication group have been updated by the recommended\n apply-by date. If no, at least one node in the replication group have not been updated\n by the recommended apply-by date. If N/A, the replication group was created after the\n recommended apply-by date.
" } }, "NodeGroupUpdateStatus": { @@ -11791,7 +11949,7 @@ "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.
Indicates user group status. Can be \"creating\", \"active\", \"modifying\", \"deleting\".
" + "smithy.api#documentation": "Indicates user group status. Can be \"creating\", \"active\", \"modifying\",\n \"deleting\".
" } }, "Engine": { diff --git a/codegen/sdk-codegen/aws-models/fsx.2018-03-01.json b/codegen/sdk-codegen/aws-models/fsx.2018-03-01.json index 2896b60298a..f22591de037 100644 --- a/codegen/sdk-codegen/aws-models/fsx.2018-03-01.json +++ b/codegen/sdk-codegen/aws-models/fsx.2018-03-01.json @@ -242,52 +242,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -295,13 +299,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -311,224 +324,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://fsx-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://fsx-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://fsx-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://fsx-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://fsx.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://fsx.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://fsx.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://fsx.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -1408,10 +1372,28 @@ "traits": { "smithy.api#enumValue": "VOLUME_RESTORE" } + }, + "THROUGHPUT_OPTIMIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THROUGHPUT_OPTIMIZATION" + } + }, + "IOPS_OPTIMIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IOPS_OPTIMIZATION" + } + }, + "STORAGE_TYPE_OPTIMIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STORAGE_TYPE_OPTIMIZATION" + } } }, "traits": { - "smithy.api#documentation": "Describes the type of administrative action, as follows:
\n\n FILE_SYSTEM_UPDATE - A file system update administrative action\n initiated from the Amazon FSx console, API\n (UpdateFileSystem), or CLI\n (update-file-system).
\n STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's storage capacity has been completed\n successfully, a STORAGE_OPTIMIZATION task starts.
For Windows and ONTAP, storage optimization is the process of migrating the file system data\n to newer larger disks.
\nFor Lustre, storage optimization consists of rebalancing the data across the existing and\n newly added file servers.
\nYou can track the storage-optimization progress using the\n ProgressPercent property. When\n STORAGE_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED. For more information, see Managing\n storage capacity in the Amazon FSx for Windows\n File Server User Guide, Managing storage\n and throughput capacity in the Amazon FSx for\n Lustre User Guide, and\n Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User\n Guide.
\n FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain\n Name System (DNS) alias with the file system. For more information, see \n AssociateFileSystemAliases.
\n FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system.\n For more information, see DisassociateFileSystemAliases.
\n VOLUME_UPDATE - A volume update to an Amazon FSx for NetApp ONTAP or\n Amazon FSx for OpenZFS volume initiated from the Amazon FSx\n console, API (UpdateVolume), or CLI\n (update-volume).
\n VOLUME_RESTORE - An Amazon FSx for OpenZFS volume\n is returned to the state saved by the specified snapshot, initiated from an\n API (RestoreVolumeFromSnapshot) or CLI\n (restore-volume-from-snapshot).
\n SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for\n OpenZFS volume initiated from the Amazon FSx console, API\n (UpdateSnapshot), or CLI (update-snapshot).
\n RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System\n (NFS) V3 locks on an Amazon FSx for OpenZFS file system.
Describes the type of administrative action, as follows:
\n\n FILE_SYSTEM_UPDATE - A file system update administrative action\n initiated from the Amazon FSx console, API\n (UpdateFileSystem), or CLI\n (update-file-system).
\n THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's throughput capacity has been completed\n successfully, a THROUGHPUT_OPTIMIZATION task starts.
You can track the storage-optimization progress using the\n ProgressPercent property. When\n THROUGHPUT_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED. For more information, see Managing\n throughput capacity in the Amazon FSx for Windows\n File Server User Guide.
\n STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's storage capacity has been completed\n successfully, a STORAGE_OPTIMIZATION task starts.
For Windows and ONTAP, storage optimization is the process of migrating the file system data\n to newer larger disks.
\nFor Lustre, storage optimization consists of rebalancing the data across the existing and\n newly added file servers.
\nYou can track the storage-optimization progress using the\n ProgressPercent property. When\n STORAGE_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED. For more information, see Managing\n storage capacity in the Amazon FSx for Windows\n File Server User Guide, Managing storage\n and throughput capacity in the Amazon FSx for\n Lustre User Guide, and\n Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User\n Guide.
\n FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain\n Name System (DNS) alias with the file system. For more information, see \n AssociateFileSystemAliases.
\n FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system.\n For more information, see DisassociateFileSystemAliases.
\n IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's throughput capacity has been completed\n successfully, a IOPS_OPTIMIZATION task starts.
You can track the storage-optimization progress using the\n ProgressPercent property. When\n IOPS_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED. For more information, see Managing\n provisioned SSD IOPS in the Amazon FSx for Windows\n File Server User Guide.
\n STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's throughput capacity has been completed\n successfully, a STORAGE_TYPE_OPTIMIZATION task starts.
You can track the storage-optimization progress using the\n ProgressPercent property. When\n STORAGE_TYPE_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED.
\n VOLUME_UPDATE - A volume update to an Amazon FSx for NetApp ONTAP or\n Amazon FSx for OpenZFS volume initiated from the Amazon FSx\n console, API (UpdateVolume), or CLI\n (update-volume).
\n VOLUME_RESTORE - An Amazon FSx for OpenZFS volume\n is returned to the state saved by the specified snapshot, initiated from an\n API (RestoreVolumeFromSnapshot) or CLI\n (restore-volume-from-snapshot).
\n SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for\n OpenZFS volume initiated from the Amazon FSx console, API\n (UpdateSnapshot), or CLI (update-snapshot).
\n RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System\n (NFS) V3 locks on an Amazon FSx for OpenZFS file system.
Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the \n PENDING or EXECUTING state. When you cancel a task, Amazon FSx does the following.
Any files that FSx has already exported are not reverted.
\nFSx continues to export any files that are \"in-flight\" when the cancel operation is received.
\nFSx does not export any files that have not yet been exported.
\nCancels an existing Amazon FSx for Lustre data repository task if that task is in either the \n PENDING or EXECUTING state. When you cancel am export task, Amazon FSx\n does the following.
Any files that FSx has already exported are not reverted.
\nFSx continues to export any files that are in-flight when the cancel operation is received.
\nFSx does not export any files that have not yet been exported.
\nFor a release task, Amazon FSx will stop releasing files upon cancellation. Any files that\n have already been released will remain in the released state.
", "smithy.api#idempotent": {} } }, @@ -2200,6 +2182,46 @@ ], "traits": { "smithy.api#documentation": "Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region\n (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five\n backup copy requests in progress to a single destination Region per account.
\nYou can use cross-Region backup copies for cross-Region disaster recovery. You can\n periodically take backups and copy them to another Region so that in the event of a\n disaster in the primary Region, you can restore from backup and recover availability\n quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently\n has three partitions: aws (Standard Regions), aws-cn (China\n Regions), and aws-us-gov (Amazon Web Services GovCloud [US] Regions).
You can also use backup copies to clone your file dataset to another Region or within\n the same Region.
\nYou can use the SourceRegion parameter to specify the Amazon Web Services Region\n from which the backup will be copied. For example, if you make the call from the\n us-west-1 Region and want to copy a backup from the us-east-2\n Region, you specify us-east-2 in the SourceRegion parameter\n to make a cross-Region copy. If you don't specify a Region, the backup copy is\n created in the same Region where the request is sent from (in-Region copy).
For more information about creating backup copies, see Copying backups\n in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User\n Guide, and Copying backups in the Amazon FSx for OpenZFS User\n Guide.
", + "smithy.api#examples": [ + { + "title": "To copy a backup", + "documentation": "This operation copies an Amazon FSx backup.", + "input": { + "SourceBackupId": "backup-03e3c82e0183b7b6b", + "SourceRegion": "us-east-2" + }, + "output": { + "Backup": { + "BackupId": "backup-0a3364eded1014b28", + "OwnerId": "123456789012", + "Lifecycle": "COPYING", + "Type": "USER_INITIATED", + "CreationTime": 1.617954808068E9, + "KmsKeyId": "arn:aws:fsx:us-east-1:012345678912:key/d1234e22-543a-12b7-a98f-e12c2b54001a", + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:backup/backup-0a3364eded1014b28", + "Tags": [ + { + "Key": "Name", + "Value": "MyBackup" + } + ], + "FileSystem": { + "FileSystemId": "fs-0498eed5fe91001ec", + "FileSystemType": "LUSTRE", + "StorageCapacity": 2400, + "StorageType": "SSD", + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0f5179e395f597e66", + "LustreConfiguration": { + "WeeklyMaintenanceStartTime": "1:05:00", + "DeploymentType": "PERSISTENT_1", + "PerUnitStorageThroughput": 50, + "AutomaticBackupRetentionDays": 0 + } + } + } + } + } + ], "smithy.api#idempotent": {} } }, @@ -2477,7 +2499,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Amazon FSx for Lustre data repository task. You use data repository tasks\n to perform bulk operations between your Amazon FSx file system and its linked data\n repositories. An example of a data repository task is exporting any data and metadata\n changes, including POSIX metadata, to files, directories, and symbolic links (symlinks)\n from your FSx file system to a linked data repository. A CreateDataRepositoryTask\n operation will fail if a data repository is not linked to the FSx file system. To learn\n more about data repository tasks, see \n Data Repository Tasks. \n To learn more about linking a data repository to your file system, see \n Linking your file system to an S3 bucket.
Creates an Amazon FSx for Lustre data repository task.\n A CreateDataRepositoryTask operation will fail if a data\n repository is not linked to the FSx file system.
You use import and export data repository tasks to perform bulk operations between your\n FSx for Lustre file system and its linked data repositories. An example of a data repository\n task is exporting any data and metadata changes, including POSIX metadata, to files, directories,\n and symbolic links (symlinks) from your FSx file system to a linked data repository.
\nYou use release data repository tasks to release data from your file system for files that\n are archived to S3. The metadata of released files remains on the file system so users or applications\n can still access released files by reading the files again, which will restore data from\n Amazon S3 to the FSx for Lustre file system.
\nTo learn more about data repository tasks, see \n Data Repository Tasks. \n To learn more about linking a data repository to your file system, see \n Linking your file system to an S3 bucket.
", "smithy.api#idempotent": {} } }, @@ -2487,14 +2509,14 @@ "Type": { "target": "com.amazonaws.fsx#DataRepositoryTaskType", "traits": { - "smithy.api#documentation": "Specifies the type of data repository task to create.
", + "smithy.api#documentation": "Specifies the type of data repository task to create.
\n\n EXPORT_TO_REPOSITORY tasks export from your\n Amazon FSx for Lustre file system to a linked data repository.
\n IMPORT_METADATA_FROM_REPOSITORY tasks import metadata\n changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
\n RELEASE_DATA_FROM_FILESYSTEM tasks release files in\n your Amazon FSx for Lustre file system that are archived and that meet\n your specified release criteria.
\n AUTO_RELEASE_DATA tasks automatically release files from\n an Amazon File Cache resource.
A list of paths for the data repository task to use when the task is processed.\n If a path that you provide isn't valid, the task fails.
\nFor export tasks, the list contains paths on the Amazon FSx file system\n from which the files are exported to the Amazon S3 bucket. The default path is the\n file system root directory. The paths you provide need to be relative to the mount\n point of the file system. If the mount point is /mnt/fsx and\n /mnt/fsx/path1 is a directory or file on the file system you want\n to export, then the path to provide is path1.
For import tasks, the list contains paths in the Amazon S3 bucket\n from which POSIX metadata changes are imported to the Amazon FSx file system.\n The path can be an S3 bucket or prefix in the format\n s3://myBucket/myPrefix (where myPrefix is optional).
A list of paths for the data repository task to use when the task is processed.\n If a path that you provide isn't valid, the task fails. If you don't provide\n paths, the default behavior is to export all files to S3 (for export tasks), import\n all files from S3 (for import tasks), or release all archived files that meet the\n last accessed time criteria (for release tasks).
\nFor export tasks, the list contains paths on the FSx for Lustre file system\n from which the files are exported to the Amazon S3 bucket. The default path is the\n file system root directory. The paths you provide need to be relative to the mount\n point of the file system. If the mount point is /mnt/fsx and\n /mnt/fsx/path1 is a directory or file on the file system you want\n to export, then the path to provide is path1.
For import tasks, the list contains paths in the Amazon S3 bucket\n from which POSIX metadata changes are imported to the FSx for Lustre file system.\n The path can be an S3 bucket or prefix in the format\n s3://myBucket/myPrefix (where myPrefix is optional).\n
For release tasks, the list contains directory or file paths on the\n FSx for Lustre file system from which to release archived files. If a directory is\n specified, files within the directory are released. If a file path is specified,\n only that file is released. To release all archived files in the file system,\n specify a forward slash (/) as the path.
\nA file must also meet the last accessed time criteria\n specified in for the\n file to be released.
\nSpecifies the amount of data to release, in GiB, by an Amazon File Cache\n AUTO_RELEASE_DATA task that automatically releases files from the cache.
The configuration that specifies the last accessed time criteria for files\n that will be released from an Amazon FSx for Lustre file system.
" + } } }, "traits": { @@ -3064,7 +3092,7 @@ "DeploymentType": { "target": "com.amazonaws.fsx#OpenZFSDeploymentType", "traits": { - "smithy.api#documentation": "Specifies the file system deployment type. Single AZ deployment types are configured\n for redundancy within a single Availability Zone in an Amazon Web Services Region .\n Valid values are the following:
\n\n SINGLE_AZ_1- (Default) Creates file systems with throughput capacities of 64 - 4,096 MBps.\n Single_AZ_1 is available in all Amazon Web Services Regions where Amazon FSx \n for OpenZFS is available.
\n SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s\n using an NVMe L2ARC cache. Single_AZ_2 is available only in the US East (N. Virginia), US East (Ohio), \n US West (Oregon), and Europe (Ireland) Amazon Web Services Regions.
For more information, see: Deployment type availability\n and File system performance\n in the Amazon FSx for OpenZFS User Guide.
", + "smithy.api#documentation": "Specifies the file system deployment type. Single AZ deployment types are configured\n for redundancy within a single Availability Zone in an Amazon Web Services Region .\n Valid values are the following:
\n\n MULTI_AZ_1- Creates file systems with high availability that are configured for Multi-AZ redundancy to tolerate temporary unavailability in Availability Zones (AZs).\n Multi_AZ_1 is available in the following Amazon Web Services Regions:
\n SINGLE_AZ_1- (Default) Creates file systems with throughput capacities of 64 - 4,096 MB/s.\n Single_AZ_1 is available in all Amazon Web Services Regions where Amazon FSx \n for OpenZFS is available.
\n SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s\n using an NVMe L2ARC cache. Single_AZ_2 is available only in the US East (N. Virginia), US East (Ohio), \n US West (Oregon), and Europe (Ireland) Amazon Web Services Regions.
For more information, see: Deployment type availability\n and File system performance\n in the Amazon FSx for OpenZFS User Guide.
", "smithy.api#required": {} } }, @@ -3086,6 +3114,24 @@ "traits": { "smithy.api#documentation": "The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS\n file system. All volumes are children of the root volume.
" } + }, + "PreferredSubnetId": { + "target": "com.amazonaws.fsx#SubnetId", + "traits": { + "smithy.api#documentation": "Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your\n file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx\n selects an available /28 IP address range for you from one of the VPC's CIDR ranges.\n You can have overlapping endpoint IP addresses for file systems deployed in the\n same VPC/route tables.
" + } + }, + "RouteTableIds": { + "target": "com.amazonaws.fsx#RouteTableIds", + "traits": { + "smithy.api#documentation": "(Multi-AZ only) Specifies the virtual private cloud (VPC) route tables in which your\n file system's endpoints will be created. You should specify all VPC route tables\n associated with the subnets in which your clients are located. By default, Amazon FSx\n selects your VPC's default route table.
" + } } }, "traits": { @@ -3255,6 +3301,12 @@ "traits": { "smithy.api#documentation": "The configuration that Amazon FSx for Windows File Server uses to audit and log\n user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server\n file system.
" } + }, + "DiskIopsConfiguration": { + "target": "com.amazonaws.fsx#DiskIopsConfiguration", + "traits": { + "smithy.api#documentation": "The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system.\n By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional\n IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.
" + } } }, "traits": { @@ -3436,7 +3488,7 @@ "PrivilegedDelete": { "target": "com.amazonaws.fsx#PrivilegedDelete", "traits": { - "smithy.api#documentation": "Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock \n Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete WORM files even \n if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. \n If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default \n value is DISABLED.
For more information, see \n Privileged delete.
" + "smithy.api#documentation": "Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock \n Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete WORM files even \n if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. \n If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default \n value is DISABLED.
For more information, see \n Privileged delete.
" } }, "RetentionPeriod": { @@ -3448,7 +3500,7 @@ "SnaplockType": { "target": "com.amazonaws.fsx#SnaplockType", "traits": { - "smithy.api#documentation": "Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. \n You can choose one of the following retention modes:
\n\n COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted \n until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect \n against ransomware attacks. For more information, \n see SnapLock Compliance.
\n ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users \n before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity \n and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see \n SnapLock Enterprise.
Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. \n You can choose one of the following retention modes:
\n\n COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted \n until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect \n against ransomware attacks. For more information, \n see SnapLock Compliance.
\n ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users \n before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity \n and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see \n SnapLock Enterprise.
The type of data repository task.
\n\n EXPORT_TO_REPOSITORY tasks export from your\n Amazon FSx for Lustre file system to a linked data repository.
\n IMPORT_METADATA_FROM_REPOSITORY tasks import metadata\n changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
\n AUTO_RELEASE_DATA tasks automatically release files from\n an Amazon File Cache resource.
\n RELEASE_DATA_FROM_FILESYSTEM tasks are not supported.
The type of data repository task.
\n\n EXPORT_TO_REPOSITORY tasks export from your\n Amazon FSx for Lustre file system to a linked data repository.
\n IMPORT_METADATA_FROM_REPOSITORY tasks import metadata\n changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
\n RELEASE_DATA_FROM_FILESYSTEM tasks release files in\n your Amazon FSx for Lustre file system that are archived and that meet\n your specified release criteria.
\n AUTO_RELEASE_DATA tasks automatically release files from\n an Amazon File Cache resource.
The system-generated, unique ID of the cache.
" } + }, + "ReleaseConfiguration": { + "target": "com.amazonaws.fsx#ReleaseConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that specifies the last accessed time criteria for files\n that will be released from an Amazon FSx for Lustre file system.
" + } } }, "traits": { - "smithy.api#documentation": "A description of the data repository task. You use data repository tasks\n to perform bulk transfer operations between an Amazon FSx for Lustre file system\n and a linked data repository. An Amazon File Cache resource uses a task to\n automatically release files from the cache.
" + "smithy.api#documentation": "A description of the data repository task.
\nYou use import and export data repository tasks to perform\n bulk transfer operations between an Amazon FSx for Lustre file system\n and a linked data repository.
\nYou use release data repository tasks to release archived files\n from your Amazon FSx for Lustre file system.
\nAn Amazon File Cache resource uses a task to automatically\n release files from the cache.
\nTo learn more about data repository tasks, see \n Data Repository Tasks. \n
" } }, "com.amazonaws.fsx#DataRepositoryTaskEnded": { @@ -4503,6 +4561,19 @@ ], "traits": { "smithy.api#documentation": "Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and\n its data is gone.
\nThe DeleteBackup call returns instantly. The backup won't show up in\n later DescribeBackups calls.
The data in a deleted backup is also deleted and can't be recovered by any\n means.
\nDeletes a file system. After deletion, the file system no longer exists, and its data\n is gone. Any existing automatic backups and snapshots are also deleted.
\nTo delete an Amazon FSx for NetApp ONTAP file system, first delete all the\n volumes and storage virtual machines (SVMs) on the file system. Then provide a\n FileSystemId value to the DeleFileSystem operation.
By default, when you delete an Amazon FSx for Windows File Server file system,\n a final backup is created upon deletion. This final backup isn't subject to the file\n system's retention policy, and must be manually deleted.
\nThe DeleteFileSystem operation returns while the file system has the\n DELETING status. You can check the file system deletion status by\n calling the DescribeFileSystems operation, which returns a list of file systems in your\n account. If you pass the file system ID for a deleted file system, the\n DescribeFileSystems operation returns a FileSystemNotFound\n error.
If a data repository task is in a PENDING or EXECUTING state,\n deleting an Amazon FSx for Lustre file system will fail with an HTTP status\n code 400 (Bad Request).
The data in a deleted file system is also deleted and can't be recovered by\n any means.
\nSetting this to true allows a SnapLock administrator to delete an FSx for ONTAP SnapLock Enterprise volume \n with unexpired write once, read many (WORM) files. The IAM permission fsx:BypassSnaplockEnterpriseRetention is also \n required to delete SnapLock Enterprise volumes with unexpired WORM files. The default value is false.
For more information, see \n \n Deleting a SnapLock volume\n .
" + "smithy.api#documentation": "Setting this to true allows a SnapLock administrator to delete an FSx for ONTAP SnapLock Enterprise volume \n with unexpired write once, read many (WORM) files. The IAM permission fsx:BypassSnaplockEnterpriseRetention is also \n required to delete SnapLock Enterprise volumes with unexpired WORM files. The default value is false.
For more information, see \n \n Deleting a SnapLock volume.
" } } }, @@ -6037,7 +6121,7 @@ } }, "traits": { - "smithy.api#documentation": "The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or FSx for OpenZFS file system. By default, Amazon FSx \n automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per\n GB of storage. The configuration consists of the total number of provisioned SSD IOPS\n and how it is was provisioned, or the mode (by the customer or by Amazon FSx).
" + "smithy.api#documentation": "The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx \n automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per\n GB of storage. The configuration consists of the total number of provisioned SSD IOPS\n and how it is was provisioned, or the mode (by the customer or by Amazon FSx).
" } }, "com.amazonaws.fsx#DiskIopsConfigurationMode": { @@ -6086,6 +6170,26 @@ } } }, + "com.amazonaws.fsx#DurationSinceLastAccess": { + "type": "structure", + "members": { + "Unit": { + "target": "com.amazonaws.fsx#Unit", + "traits": { + "smithy.api#documentation": "The unit of time used by the Value parameter to\n determine if a file can be released, based on when it was last\n accessed. DAYS is the only supported value. This\n is a required parameter.
An integer that represents the minimum amount of time (in days)\n since a file was last accessed in the file system. Only archived files\n with a MAX(atime, ctime, mtime) timestamp that is more than\n this amount of time in the past (relative to the task create time)\n will be released. The default of Value is 0.\n This is a required parameter.
If an archived file meets the last accessed time criteria,\n its file or directory path must also be specified in the Paths\n parameter of the operation\n in order for the file to be released.
Defines the minimum amount of time since last access for a \n file to be eligible for release. Only archived files that were\n last accessed or modified before this point-in-time are eligible\n to be released from the Amazon FSx for Lustre file system.
" + } + }, "com.amazonaws.fsx#EndTime": { "type": "timestamp" }, @@ -7356,6 +7460,23 @@ ], "traits": { "smithy.api#documentation": "Lists tags for Amazon FSx resources.
\nWhen retrieving all tags, you can optionally specify the MaxResults\n parameter to limit the number of tags in a response. If more tags remain, Amazon FSx\n returns a NextToken value in the response. In this case, send a later\n request with the NextToken request parameter set to the value of\n NextToken from the last response.
This action is used in an iterative process to retrieve a list of your tags.\n ListTagsForResource is called first without a\n NextTokenvalue. Then the action continues to be called with the\n NextToken parameter set to the value of the last NextToken\n value until a response has no NextToken.
When using this action, keep the following in mind:
\nThe implementation might return fewer than MaxResults file\n system descriptions while still including a NextToken\n value.
The order of tags returned in the response of one\n ListTagsForResource call and the order of tags returned across\n the responses of a multi-call iteration is unspecified.
Specifies the file-system deployment type. Amazon FSx for OpenZFS supports\u2028 SINGLE_AZ_1 and SINGLE_AZ_2.
Specifies the file-system deployment type. Amazon FSx for OpenZFS supports\u2028 MULTI_AZ_1, SINGLE_AZ_1, and SINGLE_AZ_2.
The ID of the root volume of the OpenZFS file system.
" } + }, + "PreferredSubnetId": { + "target": "com.amazonaws.fsx#SubnetId", + "traits": { + "smithy.api#documentation": "Required when DeploymentType is set to MULTI_AZ_1. This\n specifies the subnet in which you want the preferred file server to be located.
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your\n file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx\n selects an available /28 IP address range for you from one of the VPC's CIDR ranges.\n You can have overlapping endpoint IP addresses for file systems deployed in the\n same VPC/route tables.
" + } + }, + "RouteTableIds": { + "target": "com.amazonaws.fsx#RouteTableIds", + "traits": { + "smithy.api#documentation": "(Multi-AZ only) The VPC route tables in which your file system's endpoints are\n created.
" + } + }, + "EndpointIpAddress": { + "target": "com.amazonaws.fsx#IpAddress", + "traits": { + "smithy.api#documentation": "The IP address of the endpoint\n that is used to access data or to manage the file system.
" + } } }, "traits": { @@ -8513,6 +8664,20 @@ "smithy.api#pattern": "^[a-z0-9-]{1,20}$" } }, + "com.amazonaws.fsx#ReleaseConfiguration": { + "type": "structure", + "members": { + "DurationSinceLastAccess": { + "target": "com.amazonaws.fsx#DurationSinceLastAccess", + "traits": { + "smithy.api#documentation": "Defines the point-in-time since an archived file was last accessed,\n in order for that file to be eligible for release. Only files that were\n last accessed before this point-in-time are eligible to be released from\n the file system.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration that specifies a minimum amount of time since\n last access for an archived file to be eligible for release from an\n Amazon FSx for Lustre file system. Only files that were last\n accessed before this point-in-time can be released. For example, if\n you specify a last accessed time criteria of 9 days, only files that\n were last accessed 9.00001 or more days ago can be released.
\nOnly file data that has been archived can be released. Files that\n have not yet been archived, such as new or changed files that have\n not been exported, are not eligible for release. When files are\n released, their metadata stays on the file system, so they\n can still be accessed later. Users and applications can access a\n released file by reading the file again, which restores data from\n Amazon S3 to the FSx for Lustre file system.
\nIf a file meets the last accessed time criteria, its\n file or directory path must also be specified with the\n Paths parameter of the\n operation in order\n for the file to be released.
Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock \n Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read \n many (WORM) files even \n if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. \n If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default \n value is DISABLED.
For more information, see Privileged delete.
" + "smithy.api#documentation": "Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock \n Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read \n many (WORM) files even \n if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. \n If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default \n value is DISABLED.
For more information, see Privileged delete.
" } }, "RetentionPeriod": { @@ -9212,7 +9377,7 @@ "SnaplockType": { "target": "com.amazonaws.fsx#SnaplockType", "traits": { - "smithy.api#documentation": "Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. \n You can choose one of the following retention modes:
\n\n COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted \n until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect \n against ransomware attacks. For more information, \n see SnapLock Compliance.
\n ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users \n before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity \n and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see \n SnapLock Enterprise.
Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. \n You can choose one of the following retention modes:
\n\n COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted \n until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect \n against ransomware attacks. For more information, \n see SnapLock Compliance.
\n ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users \n before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity \n and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see \n SnapLock Enterprise.
Tags an Amazon FSx resource.
", + "smithy.api#examples": [ + { + "title": "To tag a resource", + "documentation": "This operation tags an Amazon FSx resource.", + "input": { + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec", + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ] + } + } + ], "smithy.api#idempotent": {} } }, @@ -10188,6 +10368,17 @@ "smithy.api#pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,36}$" } }, + "com.amazonaws.fsx#Unit": { + "type": "enum", + "members": { + "DAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAYS" + } + } + } + }, "com.amazonaws.fsx#UnsupportedOperation": { "type": "structure", "members": { @@ -10227,6 +10418,18 @@ ], "traits": { "smithy.api#documentation": "This action removes a tag from an Amazon FSx resource.
", + "smithy.api#examples": [ + { + "title": "To untag a resource", + "documentation": "This operation untags an Amazon FSx resource.", + "input": { + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec", + "TagKeys": [ + "Name" + ] + } + } + ], "smithy.api#idempotent": {} } }, @@ -10461,7 +10664,7 @@ } ], "traits": { - "smithy.api#documentation": "Use this operation to update the configuration of an existing Amazon FSx file\n system. You can update multiple properties in a single request.
\nFor FSx for Windows File Server file systems, you can update the following\n properties:
\n\n AuditLogConfiguration\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n SelfManagedActiveDirectoryConfiguration\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
For FSx for Lustre file systems, you can update the following\n properties:
\n\n AutoImportPolicy\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n DataCompressionType\n
\n LogConfiguration\n
\n LustreRootSquashConfiguration\n
\n StorageCapacity\n
\n WeeklyMaintenanceStartTime\n
For FSx for ONTAP file systems, you can update the following\n properties:
\n\n AddRouteTableIds\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n DiskIopsConfiguration\n
\n FsxAdminPassword\n
\n RemoveRouteTableIds\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
For FSx for OpenZFS file systems, you can update the following\n properties:
\n\n AutomaticBackupRetentionDays\n
\n CopyTagsToBackups\n
\n CopyTagsToVolumes\n
\n DailyAutomaticBackupStartTime\n
\n DiskIopsConfiguration\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
Use this operation to update the configuration of an existing Amazon FSx file\n system. You can update multiple properties in a single request.
\nFor FSx for Windows File Server file systems, you can update the following\n properties:
\n\n AuditLogConfiguration\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n SelfManagedActiveDirectoryConfiguration\n
\n StorageCapacity\n
\n StorageType\n
\n ThroughputCapacity\n
\n DiskIopsConfiguration\n
\n WeeklyMaintenanceStartTime\n
For FSx for Lustre file systems, you can update the following\n properties:
\n\n AutoImportPolicy\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n DataCompressionType\n
\n LogConfiguration\n
\n LustreRootSquashConfiguration\n
\n StorageCapacity\n
\n WeeklyMaintenanceStartTime\n
For FSx for ONTAP file systems, you can update the following\n properties:
\n\n AddRouteTableIds\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n DiskIopsConfiguration\n
\n FsxAdminPassword\n
\n RemoveRouteTableIds\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
For FSx for OpenZFS file systems, you can update the following\n properties:
\n\n AutomaticBackupRetentionDays\n
\n CopyTagsToBackups\n
\n CopyTagsToVolumes\n
\n DailyAutomaticBackupStartTime\n
\n DiskIopsConfiguration\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
(Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables\n to associate (add) with your Amazon FSx for OpenZFS file system.
" + } + }, + "RemoveRouteTableIds": { + "target": "com.amazonaws.fsx#RouteTableIds", + "traits": { + "smithy.api#documentation": "(Multi-AZ only) A list of IDs of existing virtual private cloud (VPC)\n route tables to disassociate (remove) from your Amazon FSx for OpenZFS file system. You can use\n the API operation to retrieve the\n list of VPC route table IDs for a file system.
" + } } }, "traits": { @@ -10636,6 +10851,9 @@ "traits": { "smithy.api#documentation": "The configuration updates for an FSx for OpenZFS file system.
" } + }, + "StorageType": { + "target": "com.amazonaws.fsx#StorageType" } }, "traits": { @@ -10696,6 +10914,12 @@ "traits": { "smithy.api#documentation": "The configuration that Amazon FSx for Windows File Server uses to audit and log\n user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server\n file system..
" } + }, + "DiskIopsConfiguration": { + "target": "com.amazonaws.fsx#DiskIopsConfiguration", + "traits": { + "smithy.api#documentation": "The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system.\n By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional\n IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.
" + } } }, "traits": { @@ -10826,7 +11050,7 @@ "PrivilegedDelete": { "target": "com.amazonaws.fsx#PrivilegedDelete", "traits": { - "smithy.api#documentation": "Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock \n Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read \n many (WORM) files even \n if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. \n If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default \n value is DISABLED.
For more information, see \n Privileged delete.
" + "smithy.api#documentation": "Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock \n Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read \n many (WORM) files even \n if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. \n If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default \n value is DISABLED.
For more information, see \n Privileged delete.
" } }, "RetentionPeriod": { @@ -11084,6 +11308,14 @@ "smithy.api#output": {} } }, + "com.amazonaws.fsx#Value": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.fsx#Volume": { "type": "structure", "members": { @@ -11430,7 +11662,7 @@ "AuditLogDestination": { "target": "com.amazonaws.fsx#GeneralARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the destination of the audit logs.\n The destination can be any Amazon CloudWatch Logs log group ARN or\n Amazon Kinesis Data Firehose delivery stream ARN.
\nThe name of the Amazon CloudWatch Logs log group must begin with\n the /aws/fsx prefix. The name of the Amazon Kinesis Data\n Firehouse delivery stream must begin with the aws-fsx prefix.
The destination ARN (either CloudWatch Logs log group or Kinesis\n Data Firehose delivery stream) must be in the same Amazon Web Services partition,\n Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the destination of the audit logs.\n The destination can be any Amazon CloudWatch Logs log group ARN or\n Amazon Kinesis Data Firehose delivery stream ARN.
\nThe name of the Amazon CloudWatch Logs log group must begin with\n the /aws/fsx prefix. The name of the Amazon Kinesis Data\n Firehose delivery stream must begin with the aws-fsx prefix.
The destination ARN (either CloudWatch Logs log group or Kinesis\n Data Firehose delivery stream) must be in the same Amazon Web Services partition,\n Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
" } } }, @@ -11458,7 +11690,7 @@ "AuditLogDestination": { "target": "com.amazonaws.fsx#GeneralARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that specifies the destination of the audit logs.
\nThe destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis\n Data Firehose delivery stream ARN, with the following requirements:
\nThe destination ARN that you provide (either CloudWatch Logs log group\n or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition,\n Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
\nThe name of the Amazon CloudWatch Logs log group must begin with\n the /aws/fsx prefix. The name of the Amazon Kinesis Data\n Firehouse delivery stream must begin with the aws-fsx prefix.
If you do not provide a destination in AuditLogDestination,\n Amazon FSx will create and use a log stream in the CloudWatch Logs\n /aws/fsx/windows log group.
If AuditLogDestination is provided and the resource does not\n exist, the request will fail with a BadRequest error.
If FileAccessAuditLogLevel and FileShareAccessAuditLogLevel\n are both set to DISABLED, you cannot specify a destination in\n AuditLogDestination.
The Amazon Resource Name (ARN) that specifies the destination of the audit logs.
\nThe destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis\n Data Firehose delivery stream ARN, with the following requirements:
\nThe destination ARN that you provide (either CloudWatch Logs log group\n or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition,\n Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
\nThe name of the Amazon CloudWatch Logs log group must begin with\n the /aws/fsx prefix. The name of the Amazon Kinesis Data\n Firehose delivery stream must begin with the aws-fsx prefix.
If you do not provide a destination in AuditLogDestination,\n Amazon FSx will create and use a log stream in the CloudWatch Logs\n /aws/fsx/windows log group.
If AuditLogDestination is provided and the resource does not\n exist, the request will fail with a BadRequest error.
If FileAccessAuditLogLevel and FileShareAccessAuditLogLevel\n are both set to DISABLED, you cannot specify a destination in\n AuditLogDestination.
The configuration that Amazon FSx for Windows File Server uses to audit and log\n user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server\n file system.
" } + }, + "DiskIopsConfiguration": { + "target": "com.amazonaws.fsx#DiskIopsConfiguration", + "traits": { + "smithy.api#documentation": "The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system.\n By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional\n IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/global-accelerator.2018-08-08.json b/codegen/sdk-codegen/aws-models/global-accelerator.2018-08-08.json index 5b682ea9b23..ea3cded2c0c 100644 --- a/codegen/sdk-codegen/aws-models/global-accelerator.2018-08-08.json +++ b/codegen/sdk-codegen/aws-models/global-accelerator.2018-08-08.json @@ -53,7 +53,7 @@ "Enabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
\n\t\tIf the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
" + "smithy.api#documentation": "Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
\nIf the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
" } }, "IpSets": { @@ -65,7 +65,7 @@ "DnsName": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.
\n\t\tThe naming convention for the DNS name for an accelerator is the following: A lowercase letter a,\n\t\t\tfollowed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:\n\t\t\ta1234567890abcdef.awsglobalaccelerator.com.
\nIf you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both \n \t\t\tthe A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.
For more information about the default DNS name, see \n\t\t\tSupport for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.
\nThe naming convention for the DNS name for an accelerator is the following: A lowercase letter a,\n\t\t\tfollowed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:\n\t\t\ta1234567890abcdef.awsglobalaccelerator.com.
\nIf you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both \n \t\t\tthe A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.
For more information about the default DNS name, see \n\t\t\tSupport for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
" } }, "Status": { @@ -89,7 +89,7 @@ "DualStackDnsName": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses:\n\t\t\ttwo IPv4 addresses and two IPv6 addresses.
\n\t\tThe naming convention for the dual-stack DNS name is the following: A lowercase letter a,\n\t\t\tfollowed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example:\n\t\t\ta1234567890abcdef.dualstack.awsglobalaccelerator.com.
\n\t\tNote: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses.
For more information, see \n\t\t\tSupport for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses:\n\t\t\ttwo IPv4 addresses and two IPv6 addresses.
\nThe naming convention for the dual-stack DNS name is the following: A lowercase letter a,\n\t\t\tfollowed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example:\n\t\t\ta1234567890abcdef.dualstack.awsglobalaccelerator.com.
\nNote: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses.
For more information, see \n\t\t\tSupport for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
" } }, "Events": { @@ -109,7 +109,7 @@ "FlowLogsEnabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "Indicates whether flow logs are enabled. The default value is false. If the value is true,\n\t\t\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow logs in\n\t\t the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Indicates whether flow logs are enabled. The default value is false. If the value is true,\n\t\t\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow logs in\n\t\t the Global Accelerator Developer Guide.
" } }, "FlowLogsS3Bucket": { @@ -121,7 +121,7 @@ "FlowLogsS3Prefix": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if\n\t\t\t\tFlowLogsEnabled is true.
If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
\n\t\ts3-bucket_name//AWSLogs/aws_account_id
" + "smithy.api#documentation": "The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if\n\t\t\t\tFlowLogsEnabled is true.
If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
\ns3-bucket_name//AWSLogs/aws_account_id
" } } }, @@ -249,7 +249,7 @@ } ], "traits": { - "smithy.api#documentation": "Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.
\n\tThe listener port range must be large enough to support the number of IP addresses that can be \n\t\tspecified in your subnet. The number of ports required is: subnet size times the number\n\t\tof ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener \n\t\tport range of at least 255 ports.
\n\tNote: You must have enough remaining listener ports available to \n\t\tmap to the subnet ports, or the call will fail with a LimitExceededException.
\n\tBy default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all\n\t\t\tdestinations to receive traffic, or to specify individual port mappings that can receive\n\t\t\ttraffic, see the \n\t\t\t\tAllowCustomRoutingTraffic operation.
" + "smithy.api#documentation": "Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.
\nThe listener port range must be large enough to support the number of IP addresses that can be \n\t\tspecified in your subnet. The number of ports required is: subnet size times the number\n\t\tof ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener \n\t\tport range of at least 255 ports.
\nNote: You must have enough remaining listener ports available to \n\t\tmap to the subnet ports, or the call will fail with a LimitExceededException.
\nBy default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all\n\t\t\tdestinations to receive traffic, or to specify individual port mappings that can receive\n\t\t\ttraffic, see the \n\t\t\t\tAllowCustomRoutingTraffic operation.
" } }, "com.amazonaws.globalaccelerator#AddCustomRoutingEndpointsRequest": { @@ -269,6 +269,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#AddCustomRoutingEndpointsResponse": { @@ -286,6 +289,9 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#AddEndpoints": { @@ -317,7 +323,7 @@ } ], "traits": { - "smithy.api#documentation": "Add endpoints to an endpoint group. The AddEndpoints API operation is the recommended option for adding endpoints. The\n\t\t\talternative options are to add endpoints when you create an endpoint group (with the\n\t\t\tCreateEndpointGroup API) \n\t\t\tor when you update an endpoint group (with the \n\t\t\tUpdateEndpointGroup API).
There are two advantages to using AddEndpoints to add endpoints:
It's faster, because Global Accelerator only has to resolve the new endpoints that\n\t\t\t\t\tyou're adding.
\nIt's more convenient, because you don't need to specify all of the current \n\t\t\t\t\tendpoints that are already in the endpoint group in addition to the new endpoints that you want to add.
\nAdd endpoints to an endpoint group. The AddEndpoints API operation is the recommended option for adding endpoints. The\n\t\t\talternative options are to add endpoints when you create an endpoint group (with the\n\t\t\tCreateEndpointGroup API) \n\t\t\tor when you update an endpoint group (with the \n\t\t\tUpdateEndpointGroup API).
There are two advantages to using AddEndpoints to add endpoints in Global Accelerator:
It's faster, because Global Accelerator only has to resolve the new endpoints that\n\t\t\t\t\tyou're adding, rather than resolving new and existing endpoints.
\nIt's more convenient, because you don't need to specify the current \n\t\t\t\t\tendpoints that are already in the endpoint group, in addition to the new endpoints that \n\t\t\t\t\tyou want to add.
\nFor information about endpoint types and requirements for endpoints that you can add\n\t\t\tto Global Accelerator, see \n\t\t\t\tEndpoints for standard accelerators in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#AddEndpointsRequest": { @@ -337,6 +343,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#AddEndpointsResponse": { @@ -354,6 +363,9 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the endpoint group.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#AdvertiseByoipCidr": { @@ -382,7 +394,7 @@ } ], "traits": { - "smithy.api#documentation": "Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources \n\t\t\tthrough bring your own IP addresses (BYOIP). It can take a few minutes before traffic to \n\t\t\tthe specified addresses starts routing to Amazon Web Services because of propagation delays.
\n\t\tTo stop advertising the BYOIP address range, use \n\t\t\tWithdrawByoipCidr.
\n\t\tFor more information, see Bring your own \n\t\t IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources \n\t\t\tthrough bring your own IP addresses (BYOIP). It can take a few minutes before traffic to \n\t\t\tthe specified addresses starts routing to Amazon Web Services because of propagation delays.
\nTo stop advertising the BYOIP address range, use \n\t\t\tWithdrawByoipCidr.
\nFor more information, see Bring your own \n\t\t IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#AdvertiseByoipCidrRequest": { @@ -395,6 +407,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#AdvertiseByoipCidrResponse": { @@ -406,6 +421,9 @@ "smithy.api#documentation": "Information about the address range.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#AllowCustomRoutingTraffic": { @@ -428,7 +446,7 @@ } ], "traits": { - "smithy.api#documentation": "Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic \n\t\t\tfor a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a\n\t\t\tspecified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports \n\t\t\toutside of the range that you configured for the endpoint group.
\n\t\tAfter you make changes, you can verify that the updates are complete by checking the status of your\n\t\t\taccelerator: the status changes from IN_PROGRESS to DEPLOYED.
" + "smithy.api#documentation": "Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic \n\t\t\tfor a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a\n\t\t\tspecified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports \n\t\t\toutside of the range that you configured for the endpoint group.
\nAfter you make changes, you can verify that the updates are complete by checking the status of your\n\t\t\taccelerator: the status changes from IN_PROGRESS to DEPLOYED.
" } }, "com.amazonaws.globalaccelerator#AllowCustomRoutingTrafficRequest": { @@ -451,7 +469,7 @@ "DestinationAddresses": { "target": "com.amazonaws.globalaccelerator#DestinationAddresses", "traits": { - "smithy.api#documentation": "A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive \n\t\t\ttraffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.
\n\t\t\n DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is\n\t\tnot specified.
A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive \n\t\t\ttraffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.
\n\n DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is\n\t\tnot specified.
Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic \n\t\t\tfrom a custom routing accelerator. The value is TRUE or FALSE.
\n\t\tWhen set to TRUE, all destinations in the custom routing VPC subnet can receive traffic. Note \n\t\t\tthat you cannot specify destination IP addresses and ports when the value is set to TRUE.
\n\t\tWhen set to FALSE (or not specified), you must specify a list of destination IP addresses that are allowed\n\t\t\tto receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is\n\t\t\tthe same as the ports configured for the endpoint group.
\n\t\tThe default value is FALSE.
" + "smithy.api#documentation": "Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic \n\t\t\tfrom a custom routing accelerator. The value is TRUE or FALSE.
\nWhen set to TRUE, all destinations in the custom routing VPC subnet can receive traffic. Note \n\t\t\tthat you cannot specify destination IP addresses and ports when the value is set to TRUE.
\nWhen set to FALSE (or not specified), you must specify a list of destination IP addresses that are allowed\n\t\t\tto receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is\n\t\t\tthe same as the ports configured for the endpoint group.
\nThe default value is FALSE.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#AssociatedEndpointGroupFoundException": { @@ -517,7 +538,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about an IP address range that is provisioned for use with your Amazon Web Services resources through \n\t\t\tbring your own IP address (BYOIP).
\n\t\tThe following describes each BYOIP State that your IP address range can be in.
\n PENDING_PROVISIONING — \n\t\t\t\tYou’ve submitted a request to provision an IP address range but it is not yet provisioned with \n\t\t\t Global Accelerator.
\n\n READY — The address range is provisioned \n\t\t\t with Global Accelerator and can be advertised.
\n\n PENDING_ADVERTISING — You’ve submitted a \n\t\t\t request for Global Accelerator to advertise an address range but it is not yet being advertised.
\n\n ADVERTISING — The address range is \n\t\t\t being advertised by Global Accelerator.
\n\n PENDING_WITHDRAWING — You’ve submitted \n\t\t\t\ta request to withdraw an address range from being advertised but it is still being advertised \n\t\t\t\tby Global Accelerator.
\n\n PENDING_DEPROVISIONING — You’ve submitted a \n\t\t\t request to deprovision an address range from Global Accelerator but it is still provisioned.
\n\n DEPROVISIONED — The address range is deprovisioned \n\t\t\t from Global Accelerator.
\n\n FAILED_PROVISION — The request to \n\t\t\t provision the address range from Global Accelerator was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact Amazon Web Services support.
\n\n FAILED_ADVERTISING — The request for Global Accelerator\n\t\t\t\tto advertise the address range was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact Amazon Web Services support.
\n\n FAILED_WITHDRAW — The request to withdraw \n\t\t\t the address range from advertising by Global Accelerator was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact Amazon Web Services support.
\n\n FAILED_DEPROVISION — The request to \n\t\t\t deprovision the address range from Global Accelerator was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact Amazon Web Services support.
\nInformation about an IP address range that is provisioned for use with your Amazon Web Services resources through \n\t\t\tbring your own IP address (BYOIP).
\nThe following describes each BYOIP State that your IP address range can be in.
\n PENDING_PROVISIONING — \n\t\t\t\tYou’ve submitted a request to provision an IP address range but it is not yet provisioned with \n\t\t\t Global Accelerator.
\n\n READY — The address range is provisioned \n\t\t\t with Global Accelerator and can be advertised.
\n\n PENDING_ADVERTISING — You’ve submitted a \n\t\t\t request for Global Accelerator to advertise an address range but it is not yet being advertised.
\n\n ADVERTISING — The address range is \n\t\t\t being advertised by Global Accelerator.
\n\n PENDING_WITHDRAWING — You’ve submitted \n\t\t\t\ta request to withdraw an address range from being advertised but it is still being advertised \n\t\t\t\tby Global Accelerator.
\n\n PENDING_DEPROVISIONING — You’ve submitted a \n\t\t\t request to deprovision an address range from Global Accelerator but it is still provisioned.
\n\n DEPROVISIONED — The address range is deprovisioned \n\t\t\t from Global Accelerator.
\n\n FAILED_PROVISION — The request to \n\t\t\t provision the address range from Global Accelerator was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact Amazon Web Services support.
\n\n FAILED_ADVERTISING — The request for Global Accelerator\n\t\t\t\tto advertise the address range was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact Amazon Web Services support.
\n\n FAILED_WITHDRAW — The request to withdraw \n\t\t\t the address range from advertising by Global Accelerator was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact Amazon Web Services support.
\n\n FAILED_DEPROVISION — The request to \n\t\t\t deprovision the address range from Global Accelerator was not successful. Please make sure that\n\t\t\t\tyou provide all of the correct information, and try again. If the request fails\n\t\t\t\ta second time, contact Amazon Web Services support.
\nProvides authorization for Amazon to bring a specific IP address range to a specific Amazon Web Services \n\t\t\taccount using bring your own IP addresses (BYOIP).
\n\t\tFor more information, see Bring your own \n\t\t IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Provides authorization for Amazon to bring a specific IP address range to a specific Amazon Web Services \n\t\t\taccount using bring your own IP addresses (BYOIP).
\nFor more information, see Bring your own \n\t\t IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#ClientAffinity": { @@ -708,7 +729,7 @@ } ], "traits": { - "smithy.api#documentation": "Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic\n\t\t\tto one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers.
\t\n\t\tGlobal Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the \n\t\t\t\tUS West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2\n\t\t\t\ton AWS CLI commands.
Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic\n\t\t\tto one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers.
\nGlobal Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the \n\t\t\t\tUS West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2\n\t\t\t\ton Amazon Web Services CLI commands.
Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address \n\t\t\tfrom your own pool to use for the accelerator's static IPv4 address when you create an accelerator.
\n\tAfter you bring an address range to Amazon Web Services, it appears in your account as an address pool. \n\t \tWhen you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns \n\t \tyou a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges \n\t \tto Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is \n\t\t\tbecause Global Accelerator assigns each address range to a different network zone, for high availability.
\n\t\tYou can specify one or two addresses, separated by a space. Do not include the /32 suffix.
\n\t\tNote that you can't update IP addresses for an existing accelerator. To change them, you must create a new \n\t\t\taccelerator with the new addresses.
\n\t\tFor more information, see Bring \n\t\t your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address \n\t\t\tfrom your own pool to use for the accelerator's static IPv4 address when you create an accelerator.
\nAfter you bring an address range to Amazon Web Services, it appears in your account as an address pool. \n\t \tWhen you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns \n\t \tyou a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges \n\t \tto Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is \n\t\t\tbecause Global Accelerator assigns each address range to a different network zone, for high availability.
\nYou can specify one or two addresses, separated by a space. Do not include the /32 suffix.
\nNote that you can't update IP addresses for an existing accelerator. To change them, you must create a new \n\t\t\taccelerator with the new addresses.
\nFor more information, see Bring \n\t\t your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "Enabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
\n\t\tIf the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.
" + "smithy.api#documentation": "Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
\nIf the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.
" } }, "IdempotencyToken": { @@ -750,9 +771,12 @@ "Tags": { "target": "com.amazonaws.globalaccelerator#Tags", "traits": { - "smithy.api#documentation": "Create tags for an accelerator.
\n\t\tFor more information, see Tagging\n\t\t in Global Accelerator in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Create tags for an accelerator.
\nFor more information, see Tagging\n\t\t in Global Accelerator in the Global Accelerator Developer Guide.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#CreateAcceleratorResponse": { @@ -764,6 +788,9 @@ "smithy.api#documentation": "The accelerator that is created by specifying a listener and the supported IP address types.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#CreateCustomRoutingAccelerator": { @@ -789,7 +816,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands\n\t of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.
\n\tBe aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive\n\t\t\ttraffic. To enable all destinations to receive traffic, or to specify individual port\n\t\t\tmappings that can receive traffic, see the \n\t\t\t\tAllowCustomRoutingTraffic operation.
\n\tGlobal Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the \n\t\t\tUS West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2\n\t\t\ton AWS CLI commands.
Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands\n\t of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.
\nBe aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive\n\t\t\ttraffic. To enable all destinations to receive traffic, or to specify individual port\n\t\t\tmappings that can receive traffic, see the \n\t\t\t\tAllowCustomRoutingTraffic operation.
\nGlobal Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the \n\t\t\tUS West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2\n\t\t\ton Amazon Web Services CLI commands.
Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address \n\t\t\tfrom your own pool to use for the accelerator's static IPv4 address when you create an accelerator.
\n\t\tAfter you bring an address range to Amazon Web Services, it appears in your account as an address pool. \n\t\t\tWhen you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns \n\t\t\tyou a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges \n\t\t\tto Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is \n\t\t\tbecause Global Accelerator assigns each address range to a different network zone, for high availability.
\n\t\tYou can specify one or two addresses, separated by a space. Do not include the /32 suffix.
\n\t\tNote that you can't update IP addresses for an existing accelerator. To change them, you must create a new \n\t\t\taccelerator with the new addresses.
\n\t\tFor more information, see Bring \n\t\t\tyour own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address \n\t\t\tfrom your own pool to use for the accelerator's static IPv4 address when you create an accelerator.
\nAfter you bring an address range to Amazon Web Services, it appears in your account as an address pool. \n\t\t\tWhen you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns \n\t\t\tyou a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges \n\t\t\tto Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is \n\t\t\tbecause Global Accelerator assigns each address range to a different network zone, for high availability.
\nYou can specify one or two addresses, separated by a space. Do not include the /32 suffix.
\nNote that you can't update IP addresses for an existing accelerator. To change them, you must create a new \n\t\t\taccelerator with the new addresses.
\nFor more information, see Bring \n\t\t\tyour own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "Enabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
\n\tIf the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.
" + "smithy.api#documentation": "Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
\nIf the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.
" } }, "IdempotencyToken": { @@ -831,9 +858,12 @@ "Tags": { "target": "com.amazonaws.globalaccelerator#Tags", "traits": { - "smithy.api#documentation": "Create tags for an accelerator.
\n\tFor more information, see Tagging\n\t in Global Accelerator in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Create tags for an accelerator.
\nFor more information, see Tagging\n\t in Global Accelerator in the Global Accelerator Developer Guide.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#CreateCustomRoutingAcceleratorResponse": { @@ -845,6 +875,9 @@ "smithy.api#documentation": "The accelerator that is created.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#CreateCustomRoutingEndpointGroup": { @@ -917,6 +950,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#CreateCustomRoutingEndpointGroupResponse": { @@ -928,6 +964,9 @@ "smithy.api#documentation": "The information about the endpoint group created for a custom routing accelerator.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#CreateCustomRoutingListener": { @@ -972,7 +1011,7 @@ "PortRanges": { "target": "com.amazonaws.globalaccelerator#PortRanges", "traits": { - "smithy.api#documentation": "The port range to support for connections from clients to your accelerator.
\n\tSeparately, you set port ranges for endpoints. For more information, see About \n\t\tendpoints for custom routing accelerators.
", + "smithy.api#documentation": "The port range to support for connections from clients to your accelerator.
\nSeparately, you set port ranges for endpoints. For more information, see About \n\t\tendpoints for custom routing accelerators.
", "smithy.api#required": {} } }, @@ -984,6 +1023,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#CreateCustomRoutingListenerResponse": { @@ -995,6 +1037,9 @@ "smithy.api#documentation": "The listener that you've created for a custom routing accelerator.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#CreateEndpointGroup": { @@ -1029,7 +1074,7 @@ } ], "traits": { - "smithy.api#documentation": "Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services\n\t\t\tRegion. A resource must be valid and active when you add it as an endpoint.
" + "smithy.api#documentation": "Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services\n\t\t\tRegion. A resource must be valid and active when you add it as an endpoint.
\nFor more information about endpoint types and requirements for endpoints that you can add\n\t\t\t\tto Global Accelerator, see \n\t\t\t\t\tEndpoints for standard accelerators in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#CreateEndpointGroupRequest": { @@ -1058,7 +1103,7 @@ "TrafficDialPercentage": { "target": "com.amazonaws.globalaccelerator#TrafficDialPercentage", "traits": { - "smithy.api#documentation": "The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.
\n\t\tUse this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.
\n\t\tThe default value is 100.
" + "smithy.api#documentation": "The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.
\nUse this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.
\nThe default value is 100.
" } }, "HealthCheckPort": { @@ -1102,9 +1147,12 @@ "PortOverrides": { "target": "com.amazonaws.globalaccelerator#PortOverrides", "traits": { - "smithy.api#documentation": "Override specific listener ports used to route traffic to endpoints that are part of this endpoint group.\n\t\t\tFor example, you can create a port override in which the listener \n\t\t\treceives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 \n\t\t\tand 1443, respectively, on the endpoints.
\n\t\tFor more information, see \n\t\t\tOverriding listener ports in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Override specific listener ports used to route traffic to endpoints that are part of this endpoint group.\n\t\t\tFor example, you can create a port override in which the listener \n\t\t\treceives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 \n\t\t\tand 1443, respectively, on the endpoints.
\nFor more information, see \n\t\t\tOverriding listener ports in the Global Accelerator Developer Guide.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#CreateEndpointGroupResponse": { @@ -1116,6 +1164,9 @@ "smithy.api#documentation": "The information about the endpoint group that was created.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#CreateListener": { @@ -1174,7 +1225,7 @@ "ClientAffinity": { "target": "com.amazonaws.globalaccelerator#ClientAffinity", "traits": { - "smithy.api#documentation": "Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Client affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.
\n\tGlobal Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol—to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t instead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties—\n\t\t\tsource (client) IP address and destination IP address—to select the hash value.
The default value is NONE.
Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Client affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.
\nGlobal Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol—to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t instead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties—\n\t\t\tsource (client) IP address and destination IP address—to select the hash value.
The default value is NONE.
The listener that you've created.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#CustomRoutingAccelerator": { @@ -1222,7 +1279,7 @@ "Enabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
\n\t\tIf the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
" + "smithy.api#documentation": "Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
\nIf the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
" } }, "IpSets": { @@ -1234,7 +1291,7 @@ "DnsName": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.
\n\t\tThe naming convention for the DNS name is the following: A lowercase letter a,\n\t\t\tfollowed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:\n\t\t\ta1234567890abcdef.awsglobalaccelerator.com.
\n\n\t\tIf you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record \n\t\t\tand the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.
For more information about the default DNS name, see \n\t\t\tSupport for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.
\nThe naming convention for the DNS name is the following: A lowercase letter a,\n\t\t\tfollowed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:\n\t\t\ta1234567890abcdef.awsglobalaccelerator.com.
\nIf you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record \n\t\t\tand the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.
For more information about the default DNS name, see \n\t\t\tSupport for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
" } }, "Status": { @@ -1266,7 +1323,7 @@ "FlowLogsEnabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "Indicates whether flow logs are enabled. The default value is false. If the value is true,\n\t\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow logs in\n\t\t the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Indicates whether flow logs are enabled. The default value is false. If the value is true,\n\t\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow logs in\n\t\t the Global Accelerator Developer Guide.
" } }, "FlowLogsS3Bucket": { @@ -1278,7 +1335,7 @@ "FlowLogsS3Prefix": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if\n\t\t\tFlowLogsEnabled is true.
If you don’t specify a prefix, the flow logs are stored in the\n\t\t\troot of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
\n\t\tDOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id
" + "smithy.api#documentation": "The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if\n\t\t\tFlowLogsEnabled is true.
If you don’t specify a prefix, the flow logs are stored in the\n\t\t\troot of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
\nDOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id
" } } }, @@ -1495,7 +1552,7 @@ "PortRanges": { "target": "com.amazonaws.globalaccelerator#PortRanges", "traits": { - "smithy.api#documentation": "The port range to support for connections from clients to your accelerator.
\n\t\tSeparately, you set port ranges for endpoints. For more information, see About \n\t\t\t\tendpoints for custom routing accelerators.
" + "smithy.api#documentation": "The port range to support for connections from clients to your accelerator.
\nSeparately, you set port ranges for endpoints. For more information, see About \n\t\t\t\tendpoints for custom routing accelerators.
" } } }, @@ -1564,7 +1621,7 @@ } ], "traits": { - "smithy.api#documentation": "Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources\n\t\t\t(listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.
When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. \n\t Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges. \n\t\t
\n\t\tThe IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and\n\t\t\tit no longer accepts or routes traffic. However, when you delete an accelerator, you lose the \n\t\t\tstatic IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them.\n\t\t\tAs a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You \n\t\t\tcan use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, \n\t\t\tsee Identity and access management in\n\t\t the Global Accelerator Developer Guide.
\nDelete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources\n\t\t\t(listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.
When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. \n\t Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges. \n\t\t
\nThe IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and\n\t\t\tit no longer accepts or routes traffic. However, when you delete an accelerator, you lose the \n\t\t\tstatic IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them.\n\t\t\tAs a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You \n\t\t\tcan use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, \n\t\t\tsee Identity and access management in\n\t\t the Global Accelerator Developer Guide.
\nDelete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources\n\t\t(listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.
When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. \n\t
\n\t\tThe IP \n\t\t\taddresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and\n\t\t\tit no longer accepts or routes traffic. However, when you delete an accelerator, you lose the \n\t\t\tstatic IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them.\n\t\t\tAs a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You \n\t\t\tcan use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, \n\t\t\tsee Identity and access management in\n\t\t the Global Accelerator Developer Guide.
\nDelete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources\n\t\t(listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.
When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. \n\t
\nThe IP \n\t\t\taddresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and\n\t\t\tit no longer accepts or routes traffic. However, when you delete an accelerator, you lose the \n\t\t\tstatic IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them.\n\t\t\tAs a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You \n\t\t\tcan use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, \n\t\t\tsee Identity and access management in\n\t\t the Global Accelerator Developer Guide.
\nSpecify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic \n\t\t\tfor a custom routing accelerator. You can deny traffic to all destinations in the VPC endpoint, or deny traffic to a\n\t\t\tspecified list of destination IP addresses and ports. Note that you cannot specify IP addresses \n\t\t\tor ports outside of the range that you configured for the endpoint group.
\n\t\tAfter you make changes, you can verify that the updates are complete by checking the status of your\n\t\t\taccelerator: the status changes from IN_PROGRESS to DEPLOYED.
" + "smithy.api#documentation": "Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic \n\t\t\tfor a custom routing accelerator. You can deny traffic to all destinations in the VPC endpoint, or deny traffic to a\n\t\t\tspecified list of destination IP addresses and ports. Note that you cannot specify IP addresses \n\t\t\tor ports outside of the range that you configured for the endpoint group.
\nAfter you make changes, you can verify that the updates are complete by checking the status of your\n\t\t\taccelerator: the status changes from IN_PROGRESS to DEPLOYED.
" } }, "com.amazonaws.globalaccelerator#DenyCustomRoutingTrafficRequest": { @@ -1821,9 +1896,12 @@ "DenyAllTrafficToEndpoint": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint cannot \n\t\t\treceive traffic from a custom routing accelerator. The value is TRUE or FALSE.
\n\t\tWhen set to TRUE, no destinations in the custom routing VPC subnet can receive traffic. Note \n\t\t\tthat you cannot specify destination IP addresses and ports when the value is set to TRUE.
\n\t\tWhen set to FALSE (or not specified), you must specify a list of destination IP addresses that cannot receive\n\t\t\ttraffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is\n\t\t\tthe same as the ports configured for the endpoint group.
\n\t\tThe default value is FALSE.
" + "smithy.api#documentation": "Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint cannot \n\t\t\treceive traffic from a custom routing accelerator. The value is TRUE or FALSE.
\nWhen set to TRUE, no destinations in the custom routing VPC subnet can receive traffic. Note \n\t\t\tthat you cannot specify destination IP addresses and ports when the value is set to TRUE.
\nWhen set to FALSE (or not specified), you must specify a list of destination IP addresses that cannot receive\n\t\t\ttraffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is\n\t\t\tthe same as the ports configured for the endpoint group.
\nThe default value is FALSE.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DeprovisionByoipCidr": { @@ -1852,7 +1930,7 @@ } ], "traits": { - "smithy.api#documentation": "Releases the specified address range that you provisioned to use with your Amazon Web Services resources \n\t\t\tthrough bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
\n\t\tBefore you can release an address range, you must stop advertising it by using WithdrawByoipCidr and you must not have \n\t\t\tany accelerators that are using static IP addresses allocated from its address range.\n\t\t
\n\t\tFor more information, see Bring \n\t\t\tyour own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Releases the specified address range that you provisioned to use with your Amazon Web Services resources \n\t\t\tthrough bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
\nBefore you can release an address range, you must stop advertising it by using WithdrawByoipCidr and you must not have \n\t\t\tany accelerators that are using static IP addresses allocated from its address range.\n\t\t
\nFor more information, see Bring \n\t\t\tyour own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#DeprovisionByoipCidrRequest": { @@ -1865,6 +1943,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DeprovisionByoipCidrResponse": { @@ -1876,6 +1957,9 @@ "smithy.api#documentation": "Information about the address range.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DescribeAccelerator": { @@ -1934,6 +2018,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DescribeAcceleratorAttributesResponse": { @@ -1945,6 +2032,9 @@ "smithy.api#documentation": "The attributes of the accelerator.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DescribeAcceleratorRequest": { @@ -1957,6 +2047,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DescribeAcceleratorResponse": { @@ -1968,6 +2061,9 @@ "smithy.api#documentation": "The description of the accelerator.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingAccelerator": { @@ -2026,6 +2122,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingAcceleratorAttributesResponse": { @@ -2037,6 +2136,9 @@ "smithy.api#documentation": "The attributes of the custom routing accelerator.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingAcceleratorRequest": { @@ -2049,6 +2151,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingAcceleratorResponse": { @@ -2060,6 +2165,9 @@ "smithy.api#documentation": "The description of the custom routing accelerator.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingEndpointGroup": { @@ -2095,6 +2203,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingEndpointGroupResponse": { @@ -2106,6 +2217,9 @@ "smithy.api#documentation": "The description of an endpoint group for a custom routing accelerator.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingListener": { @@ -2141,6 +2255,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DescribeCustomRoutingListenerResponse": { @@ -2152,6 +2269,9 @@ "smithy.api#documentation": "The description of a listener for a custom routing accelerator.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DescribeEndpointGroup": { @@ -2187,6 +2307,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DescribeEndpointGroupResponse": { @@ -2198,6 +2321,9 @@ "smithy.api#documentation": "The description of an endpoint group.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DescribeListener": { @@ -2233,6 +2359,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DescribeListenerResponse": { @@ -2244,6 +2373,9 @@ "smithy.api#documentation": "The description of a listener.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#DestinationAddresses": { @@ -2351,7 +2483,7 @@ "EndpointId": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon\n\t\t\tResource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address\n\t\t\tallocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active \n\t\t\twhen you add it as an endpoint.
\n\t\tAn Application Load Balancer can be either internal or internet-facing.
" + "smithy.api#documentation": "An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon\n\t\t\tResource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address\n\t\t\tallocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active \n\t\t\twhen you add it as an endpoint.
\nAn Application Load Balancer can be either internal or internet-facing.
" } }, "Weight": { @@ -2363,7 +2495,7 @@ "ClientIPPreservationEnabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "Indicates whether client IP address preservation is enabled for an endpoint. \n\t\t\tThe value is true or false. The default value is true for new accelerators.
\n\t\tIf the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as \n\t\t\ttraffic travels to applications on the endpoint fronted by the accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load \n\t\t\tBalancers and Amazon EC2 instances.
\n\n\t\tFor more information, see \n\t\t\tPreserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Indicates whether client IP address preservation is enabled for an endpoint. \n\t\t\tThe value is true or false. The default value is true for new accelerators.
\nIf the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as \n\t\t\ttraffic travels to applications on the endpoint fronted by the accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load \n\t\t\tBalancers and Amazon EC2 instances.
\nFor more information, see \n\t\t\tPreserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
" } } }, @@ -2389,7 +2521,7 @@ "EndpointId": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon\n\t\t\tResource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address\n\t\t\tallocation ID. For Amazon EC2 instances, this is the EC2 instance ID.
\n\t\tAn Application Load Balancer can be either internal or internet-facing.
" + "smithy.api#documentation": "An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon\n\t\t\tResource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address\n\t\t\tallocation ID. For Amazon EC2 instances, this is the EC2 instance ID.
\nAn Application Load Balancer can be either internal or internet-facing.
" } }, "Weight": { @@ -2413,7 +2545,7 @@ "ClientIPPreservationEnabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "Indicates whether client IP address preservation is enabled for an endpoint. \n\t\t\tThe value is true or false. The default value is true for new accelerators.
\n\t\tIf the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as \n\t\t\ttraffic travels to applications on the endpoint fronted by the accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load \n\t\t\tBalancers and Amazon EC2 instances.
\n\n\t\tFor more information, see \n\t\t\tPreserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Indicates whether client IP address preservation is enabled for an endpoint. \n\t\t\tThe value is true or false. The default value is true for new accelerators.
\nIf the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as \n\t\t\ttraffic travels to applications on the endpoint fronted by the accelerator.
Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load \n\t\t\tBalancers and Amazon EC2 instances.
\nFor more information, see \n\t\t\tPreserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
" } } }, @@ -2451,13 +2583,13 @@ "TrafficDialPercentage": { "target": "com.amazonaws.globalaccelerator#TrafficDialPercentage", "traits": { - "smithy.api#documentation": "The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.
\n\t\tUse this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.
\n\t\tThe default value is 100.
" + "smithy.api#documentation": "The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.
\nUse this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.
\nThe default value is 100.
" } }, "HealthCheckPort": { "target": "com.amazonaws.globalaccelerator#HealthCheckPort", "traits": { - "smithy.api#documentation": "The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
\n\t\t\n\t\tThe default port is the port for the listener that this endpoint group is associated with. If the listener port is a\n\t\t list, Global Accelerator uses the first specified port in the list of ports.
" + "smithy.api#documentation": "The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
\nThe default port is the port for the listener that this endpoint group is associated with. If the listener port is a\n\t\t list, Global Accelerator uses the first specified port in the list of ports.
" } }, "HealthCheckProtocol": { @@ -2533,14 +2665,14 @@ "EndpointId": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon\n\t\t\tResource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address\n\t\t\tallocation ID. For Amazon EC2 instances, this is the EC2 instance ID.
\n\t\tAn Application Load Balancer can be either internal or internet-facing.
", + "smithy.api#documentation": "An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon\n\t\t\tResource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address\n\t\t\tallocation ID. For Amazon EC2 instances, this is the EC2 instance ID.
\nAn Application Load Balancer can be either internal or internet-facing.
", "smithy.api#required": {} } }, "ClientIPPreservationEnabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false.
\n\t\tIf the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as \n\t\t\ttraffic travels to applications on the endpoint fronted by the accelerator.
Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false.
\nIf the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as \n\t\t\ttraffic travels to applications on the endpoint fronted by the accelerator.
This is the Global Accelerator API Reference. This guide is for developers who need detailed information about\n\t\t Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the \n\t \tGlobal Accelerator Developer Guide.
\n\tGlobal Accelerator is a service in which you create accelerators to improve the performance \n\t\t\tof your applications for local and global users. Depending on the type of accelerator you choose, you can\n\t\t\tgain additional benefits.
\n\t\tBy using a standard accelerator, you can improve availability of your internet applications \n\t\t\t that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services \n\t\t\t\tglobal network.
\nFor other scenarios, you might choose a custom routing accelerator. With a custom routing accelerator, you \n\t\t\t\tcan use application logic to directly map one or more users to a specific endpoint among many endpoints.
\nGlobal Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the \n\t\t \tUS West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2\n\t\t \ton AWS CLI commands.
By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses \n\t\t\tare anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack,\n\t\t\tGlobal Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses. \n\t\t\tWith a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure \n\t\t\tthese entry points to be IPv4 addresses from your own IP address ranges that you bring toGlobal Accelerator (BYOIP).
\n\t\t\n\t\t\n\tFor a standard accelerator, \n\t they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases \n\t\t\tthe availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, \n\t \tAmazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing\n\t accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that\n\t\t\tare virtual private cloud (VPC) subnets.
\n\t\t\n\t\tThe static IP addresses remain assigned to your accelerator for as long as it exists, even if you\n\t\t\t\tdisable the accelerator and it no longer accepts or routes traffic. However, when you\n\t\t\t\t\tdelete an accelerator, you lose the static IP addresses that\n\t\t\t\tare assigned to it, so you can no longer route traffic by using them. You can use\n\t\t\t\tIAM policies like tag-based permissions with Global Accelerator to limit the users who have\n\t\t\t\tpermissions to delete an accelerator. For more information, see Tag-based policies.
\nFor standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based\n\t\t\ton health, client location, and policies that you configure. The service reacts instantly to\n\t\t\tchanges in health or configuration to ensure that internet traffic from clients is always\n\t\t\tdirected to healthy endpoints.
\n\t\tFor more information about understanding and using Global Accelerator, see the\n\t\t\tGlobal Accelerator Developer Guide.
", + "smithy.api#documentation": "This is the Global Accelerator API Reference. This guide is for developers who need detailed information about\n\t\t Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the \n\t \tGlobal Accelerator Developer Guide.
\nGlobal Accelerator is a service in which you create accelerators to improve the performance \n\t\t\tof your applications for local and global users. Depending on the type of accelerator you choose, you can\n\t\t\tgain additional benefits.
\nBy using a standard accelerator, you can improve availability of your internet applications \n\t\t\t that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services \n\t\t\t\tglobal network.
\nFor other scenarios, you might choose a custom routing accelerator. With a custom routing accelerator, you \n\t\t\t\tcan use application logic to directly map one or more users to a specific endpoint among many endpoints.
\nGlobal Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the \n\t\t \tUS West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2\n\t\t \ton Amazon Web Services CLI commands.
By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses \n\t\t\tare anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack,\n\t\t\tGlobal Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses. \n\t\t\tWith a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure \n\t\t\tthese entry points to be IPv4 addresses from your own IP address ranges that you bring toGlobal Accelerator (BYOIP).
\nFor a standard accelerator, \n\t they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases \n\t\t\tthe availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, \n\t \tAmazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing\n\t accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that\n\t\t\tare virtual private cloud (VPC) subnets.
\nThe static IP addresses remain assigned to your accelerator for as long as it exists, even if you\n\t\t\t\tdisable the accelerator and it no longer accepts or routes traffic. However, when you\n\t\t\t\t\tdelete an accelerator, you lose the static IP addresses that\n\t\t\t\tare assigned to it, so you can no longer route traffic by using them. You can use\n\t\t\t\tIAM policies like tag-based permissions with Global Accelerator to limit the users who have\n\t\t\t\tpermissions to delete an accelerator. For more information, see Tag-based policies.
\nFor standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based\n\t\t\ton health, client location, and policies that you configure. The service reacts instantly to\n\t\t\tchanges in health or configuration to ensure that internet traffic from clients is always\n\t\t\tdirected to healthy endpoints.
\nFor more information about understanding and using Global Accelerator, see the\n\t\t\tGlobal Accelerator Developer Guide.
", "smithy.api#title": "AWS Global Accelerator", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -2829,52 +2961,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -2882,13 +3018,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -2898,224 +3043,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://globalaccelerator-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://globalaccelerator-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://globalaccelerator-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://globalaccelerator-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://globalaccelerator.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://globalaccelerator.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://globalaccelerator.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://globalaccelerator.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -3730,6 +3826,9 @@ "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListAcceleratorsResponse": { @@ -3747,6 +3846,9 @@ "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListByoipCidrs": { @@ -3796,6 +3898,9 @@ "smithy.api#documentation": "The token for the next page of results.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListByoipCidrsResponse": { @@ -3813,6 +3918,9 @@ "smithy.api#documentation": "The token for the next page of results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingAccelerators": { @@ -3859,6 +3967,9 @@ "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingAcceleratorsResponse": { @@ -3876,6 +3987,9 @@ "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingEndpointGroups": { @@ -3931,6 +4045,9 @@ "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingEndpointGroupsResponse": { @@ -3948,6 +4065,9 @@ "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingListeners": { @@ -4004,6 +4124,9 @@ "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingListenersResponse": { @@ -4021,6 +4144,9 @@ "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingPortMappings": { @@ -4049,7 +4175,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance\n\t\tIP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator.\n\t\tFor each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port \n\t mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers.
\nIf you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to \n your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances\n in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator.
\n\tThe mappings also include a flag for each destination denoting which destination IP addresses and\n\t\tports are allowed or denied traffic.
", + "smithy.api#documentation": "Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance\n\t\tIP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator.\n\t\tFor each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port \n\t mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers.
\nIf you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to \n your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances\n in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator.
\nThe mappings also include a flag for each destination denoting which destination IP addresses and\n\t\tports are allowed or denied traffic.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4119,6 +4245,9 @@ "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingPortMappingsByDestinationResponse": { @@ -4136,6 +4265,9 @@ "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingPortMappingsRequest": { @@ -4166,6 +4298,9 @@ "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListCustomRoutingPortMappingsResponse": { @@ -4183,6 +4318,9 @@ "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListEndpointGroups": { @@ -4239,6 +4377,9 @@ "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListEndpointGroupsResponse": { @@ -4256,6 +4397,9 @@ "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListListeners": { @@ -4312,6 +4456,9 @@ "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListListenersResponse": { @@ -4329,6 +4476,9 @@ "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#ListTagsForResource": { @@ -4351,7 +4501,7 @@ } ], "traits": { - "smithy.api#documentation": "List all tags for an accelerator.
\n\t\tFor more information, see Tagging\n\t\t in Global Accelerator in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "List all tags for an accelerator.
\nFor more information, see Tagging\n\t\t in Global Accelerator in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#ListTagsForResourceRequest": { @@ -4364,6 +4514,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ListTagsForResourceResponse": { @@ -4375,6 +4528,9 @@ "smithy.api#documentation": "Root level tag for the Tags parameters.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#Listener": { @@ -4401,7 +4557,7 @@ "ClientAffinity": { "target": "com.amazonaws.globalaccelerator#ClientAffinity", "traits": { - "smithy.api#documentation": "Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Client affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.
\n\tGlobal Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol—to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t instead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties—\n\t\t\tsource (client) IP address and destination IP address—to select the hash value.
The default value is NONE.
Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Client affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.
\nGlobal Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol—to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t instead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties—\n\t\t\tsource (client) IP address and destination IP address—to select the hash value.
The default value is NONE.
Override specific listener ports used to route traffic to endpoints that are part of an endpoint group.\n\t\t\tFor example, you can create a port override in which the listener \n\t\t\treceives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 \n\t\t\tand 1443, respectively, on the endpoints.
\n\t\tFor more information, see \n\t\t Overriding listener ports in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Override specific listener ports used to route traffic to endpoints that are part of an endpoint group.\n\t\t\tFor example, you can create a port override in which the listener \n\t\t\treceives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 \n\t\t\tand 1443, respectively, on the endpoints.
\nFor more information, see \n\t\t Overriding listener ports in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#PortOverrides": { @@ -4618,7 +4774,7 @@ } ], "traits": { - "smithy.api#documentation": "Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP\n\t\t\taddresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, \n\t\t\tit is ready to be advertised using \n\t\t\tAdvertiseByoipCidr.
\n\t\tFor more information, see Bring your own \n\t\t\tIP addresses (BYOIP) in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP\n\t\t\taddresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, \n\t\t\tit is ready to be advertised using \n\t\t\tAdvertiseByoipCidr.
\nFor more information, see Bring your own \n\t\t\tIP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#ProvisionByoipCidrRequest": { @@ -4638,6 +4794,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ProvisionByoipCidrResponse": { @@ -4649,6 +4808,9 @@ "smithy.api#documentation": "Information about the address range.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#RemoveCustomRoutingEndpoints": { @@ -4700,6 +4862,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#RemoveEndpoints": { @@ -4728,7 +4893,7 @@ } ], "traits": { - "smithy.api#documentation": "Remove endpoints from an endpoint group.
\n\t\tThe RemoveEndpoints API operation is the recommended option for removing endpoints. The alternative is to remove\n\t\t\tendpoints by updating an endpoint group by using the \n\t\t\tUpdateEndpointGroup\n\t\t\tAPI operation. There are two advantages to using AddEndpoints to remove endpoints instead:
It's more convenient, because you only need to specify the endpoints that you want to remove. With the \n\t\t\t\tUpdateEndpointGroup API operation, you must specify all of the endpoints in the \n\t\t\t\tendpoint group except the ones that you want to remove from the group.
It's faster, because Global Accelerator doesn't need to resolve any endpoints. With the \n\t\t\t\tUpdateEndpointGroup API operation, Global Accelerator must resolve all of the endpoints that\n\t\t\t\tremain in the group.
Remove endpoints from an endpoint group.
\nThe RemoveEndpoints API operation is the recommended option for removing endpoints. The alternative is to remove\n\t\t\tendpoints by updating an endpoint group by using the \n\t\t\tUpdateEndpointGroup\n\t\t\tAPI operation. There are two advantages to using AddEndpoints to remove endpoints instead:
It's more convenient, because you only need to specify the endpoints that you want to remove. With the \n\t\t\t\tUpdateEndpointGroup API operation, you must specify all of the endpoints in the \n\t\t\t\tendpoint group except the ones that you want to remove from the group.
It's faster, because Global Accelerator doesn't need to resolve any endpoints. With the \n\t\t\t\tUpdateEndpointGroup API operation, Global Accelerator must resolve all of the endpoints that\n\t\t\t\tremain in the group.
Add tags to an accelerator resource.
\n\t\tFor more information, see Tagging\n\t\t in Global Accelerator in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Add tags to an accelerator resource.
\nFor more information, see Tagging\n\t\t in Global Accelerator in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#TagResourceRequest": { @@ -4868,11 +5036,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#TagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.globalaccelerator#TagValue": { "type": "string", @@ -4943,7 +5117,7 @@ } ], "traits": { - "smithy.api#documentation": "Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value.\n\t\t\tThe operation succeeds even if you attempt to remove tags from an accelerator that was already removed.
\n\t\tFor more information, see Tagging\n\t\t in Global Accelerator in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value.\n\t\t\tThe operation succeeds even if you attempt to remove tags from an accelerator that was already removed.
\nFor more information, see Tagging\n\t\t in Global Accelerator in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#UntagResourceRequest": { @@ -4963,11 +5137,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#UntagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.globalaccelerator#UpdateAccelerator": { "type": "operation", @@ -4992,7 +5172,7 @@ } ], "traits": { - "smithy.api#documentation": "Update an accelerator.
\n\t\t\n\t\tGlobal Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the \n\t\t\t\tUS West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2\n\t\t\t\ton AWS CLI commands.
Update an accelerator to make changes, such as the following:
\nChange the name of the accelerator.
\nDisable the accelerator so that it no longer accepts or routes traffic, or so that you can delete it.
\nEnable the accelerator, if it is disabled.
\nChange the IP address type to dual-stack if it is IPv4, or change the IP address type to IPv4 if it's dual-stack.
\nBe aware that static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no \n\t\t\tlonger accepts or routes traffic. However, when you delete the accelerator, you lose the static IP addresses that are assigned to it, so you \n\t\t\tcan no longer route traffic by using them.
\nGlobal Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the \n\t\t\t\tUS West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2\n\t\t\t\ton Amazon Web Services CLI commands.
Update whether flow logs are enabled. The default value is false. If the value is true,\n\t\t\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow Logs in\n\t\t the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Update whether flow logs are enabled. The default value is false. If the value is true,\n\t\t\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow Logs in\n\t\t the Global Accelerator Developer Guide.
" } }, "FlowLogsS3Bucket": { @@ -5046,9 +5226,12 @@ "FlowLogsS3Prefix": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if\n\t\t\t\tFlowLogsEnabled is true.
If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), \n\t\t\tlike the following:
\n\t\t\ts3-bucket_name//AWSLogs/aws_account_id
" + "smithy.api#documentation": "Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if\n\t\t\t\tFlowLogsEnabled is true.
If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), \n\t\t\tlike the following:
\ns3-bucket_name//AWSLogs/aws_account_id
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#UpdateAcceleratorAttributesResponse": { @@ -5060,6 +5243,9 @@ "smithy.api#documentation": "Updated attributes for the accelerator.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#UpdateAcceleratorRequest": { @@ -5087,9 +5273,12 @@ "Enabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
\n\t\tIf the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.
" + "smithy.api#documentation": "Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
\nIf the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#UpdateAcceleratorResponse": { @@ -5101,6 +5290,9 @@ "smithy.api#documentation": "Information about the updated accelerator.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#UpdateCustomRoutingAccelerator": { @@ -5165,7 +5357,7 @@ "FlowLogsEnabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "Update whether flow logs are enabled. The default value is false. If the value is true,\n\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow logs in\n\t the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Update whether flow logs are enabled. The default value is false. If the value is true,\n\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow logs in\n\t the Global Accelerator Developer Guide.
" } }, "FlowLogsS3Bucket": { @@ -5177,9 +5369,12 @@ "FlowLogsS3Prefix": { "target": "com.amazonaws.globalaccelerator#GenericString", "traits": { - "smithy.api#documentation": "Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if\n\t\tFlowLogsEnabled is true.
If you don’t specify a prefix, the flow logs are stored in the\n\t\troot of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
\n\tDOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id
" + "smithy.api#documentation": "Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if\n\t\tFlowLogsEnabled is true.
If you don’t specify a prefix, the flow logs are stored in the\n\t\troot of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
\nDOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#UpdateCustomRoutingAcceleratorAttributesResponse": { @@ -5191,6 +5386,9 @@ "smithy.api#documentation": "Updated custom routing accelerator.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#UpdateCustomRoutingAcceleratorRequest": { @@ -5218,9 +5416,12 @@ "Enabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "smithy.api#documentation": "Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
\n\tIf the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.
" + "smithy.api#documentation": "Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
\nIf the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#UpdateCustomRoutingAcceleratorResponse": { @@ -5232,6 +5433,9 @@ "smithy.api#documentation": "Information about the updated custom routing accelerator.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#UpdateCustomRoutingListener": { @@ -5276,10 +5480,13 @@ "PortRanges": { "target": "com.amazonaws.globalaccelerator#PortRanges", "traits": { - "smithy.api#documentation": "The updated port range to support for connections from clients to your accelerator. If you remove ports that are\n\tcurrently being used by a subnet endpoint, the call fails.
\n\tSeparately, you set port ranges for endpoints. For more information, see About \n\t\tendpoints for custom routing accelerators.
", + "smithy.api#documentation": "The updated port range to support for connections from clients to your accelerator. If you remove ports that are\n\tcurrently being used by a subnet endpoint, the call fails.
\nSeparately, you set port ranges for endpoints. For more information, see About \n\t\tendpoints for custom routing accelerators.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#UpdateCustomRoutingListenerResponse": { @@ -5291,6 +5498,9 @@ "smithy.api#documentation": "Information for the updated listener for a custom routing accelerator.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#UpdateEndpointGroup": { @@ -5341,7 +5551,7 @@ "TrafficDialPercentage": { "target": "com.amazonaws.globalaccelerator#TrafficDialPercentage", "traits": { - "smithy.api#documentation": "The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.
\n\t\tUse this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.
\n\t\tThe default value is 100.
" + "smithy.api#documentation": "The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for\n\t\t\tthis listener.
\nUse this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is\n\t\t\tapplied to the traffic that would otherwise have been routed to the Region based on optimal routing.
\nThe default value is 100.
" } }, "HealthCheckPort": { @@ -5377,9 +5587,12 @@ "PortOverrides": { "target": "com.amazonaws.globalaccelerator#PortOverrides", "traits": { - "smithy.api#documentation": "Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. \n\t\t\tFor example, you can create a port override in which the listener \n\t\t\treceives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 \n\t\t\tand 1443, respectively, on the endpoints.
\n\t\tFor more information, see \n\t\t\tOverriding listener ports in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. \n\t\t\tFor example, you can create a port override in which the listener \n\t\t\treceives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 \n\t\t\tand 1443, respectively, on the endpoints.
\nFor more information, see \n\t\t\tOverriding listener ports in the Global Accelerator Developer Guide.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#UpdateEndpointGroupResponse": { @@ -5391,6 +5604,9 @@ "smithy.api#documentation": "The information about the endpoint group that was updated.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#UpdateListener": { @@ -5447,9 +5663,12 @@ "ClientAffinity": { "target": "com.amazonaws.globalaccelerator#ClientAffinity", "traits": { - "smithy.api#documentation": "Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Client affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.
\n\tGlobal Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol—to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t instead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties—\n\t\t\tsource (client) IP address and destination IP address—to select the hash value.
The default value is NONE.
Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,\n\t\t\tregardless of the port and protocol of the client request. Client affinity gives you control over whether to always\n\t\t\troute each client to the same specific endpoint.
\nGlobal Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client\n\t affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port,\n\t\t\tdestination IP address, destination port, and protocol—to select the hash value, and then chooses the best\n\t\t\tendpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not\n\t\t\tbe always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP\n\t\t instead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties—\n\t\t\tsource (client) IP address and destination IP address—to select the hash value.
The default value is NONE.
Information for the updated listener.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.globalaccelerator#WithdrawByoipCidr": { @@ -5489,7 +5711,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops advertising an address range that is provisioned as an address pool.\n\t\t\tYou can perform this operation at most once every 10 seconds, even if you specify different address\n\t\t\tranges each time.
\n\tIt can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of\n\t\t\tpropagation delays.
\n\t\tFor more information, see Bring your own \n\t\t\tIP addresses (BYOIP) in the Global Accelerator Developer Guide.
" + "smithy.api#documentation": "Stops advertising an address range that is provisioned as an address pool.\n\t\t\tYou can perform this operation at most once every 10 seconds, even if you specify different address\n\t\t\tranges each time.
\nIt can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of\n\t\t\tpropagation delays.
\nFor more information, see Bring your own \n\t\t\tIP addresses (BYOIP) in the Global Accelerator Developer Guide.
" } }, "com.amazonaws.globalaccelerator#WithdrawByoipCidrRequest": { @@ -5502,6 +5724,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#WithdrawByoipCidrResponse": { @@ -5513,6 +5738,9 @@ "smithy.api#documentation": "Information about the address pool.
" } } + }, + "traits": { + "smithy.api#output": {} } } } diff --git a/codegen/sdk-codegen/aws-models/glue.2017-03-31.json b/codegen/sdk-codegen/aws-models/glue.2017-03-31.json index 45fe91c7cd1..af673c0b4ac 100644 --- a/codegen/sdk-codegen/aws-models/glue.2017-03-31.json +++ b/codegen/sdk-codegen/aws-models/glue.2017-03-31.json @@ -7459,6 +7459,12 @@ "traits": { "smithy.api#documentation": "Creates a list of supported custom datatypes.
" } + }, + "Serde": { + "target": "com.amazonaws.glue#CsvSerdeOption", + "traits": { + "smithy.api#documentation": "Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are OpenCSVSerDe, LazySimpleSerDe, and None. You can specify the None value when you want the crawler to do the detection.
A list of custom datatypes including \"BINARY\", \"BOOLEAN\", \"DATE\", \"DECIMAL\", \"DOUBLE\", \"FLOAT\", \"INT\", \"LONG\", \"SHORT\", \"STRING\", \"TIMESTAMP\".
" } + }, + "Serde": { + "target": "com.amazonaws.glue#CsvSerdeOption", + "traits": { + "smithy.api#documentation": "Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are OpenCSVSerDe, LazySimpleSerDe, and None. You can specify the None value when you want the crawler to do the detection.
Specifies a list of supported custom datatypes.
" } + }, + "Serde": { + "target": "com.amazonaws.glue#CsvSerdeOption", + "traits": { + "smithy.api#documentation": "Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are OpenCSVSerDe, LazySimpleSerDe, and None. You can specify the None value when you want the crawler to do the detection.
Represents the criteria to be used in the filter for querying findings.
\nYou can only use the following attributes to query findings:
\naccountId
\nregion
\nid
\nresource.accessKeyDetails.accessKeyId
\nresource.accessKeyDetails.principalId
\nresource.accessKeyDetails.userName
\nresource.accessKeyDetails.userType
\nresource.instanceDetails.iamInstanceProfile.id
\nresource.instanceDetails.imageId
\nresource.instanceDetails.instanceId
\nresource.instanceDetails.outpostArn
\nresource.instanceDetails.networkInterfaces.ipv6Addresses
\nresource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
\nresource.instanceDetails.networkInterfaces.publicDnsName
\nresource.instanceDetails.networkInterfaces.publicIp
\nresource.instanceDetails.networkInterfaces.securityGroups.groupId
\nresource.instanceDetails.networkInterfaces.securityGroups.groupName
\nresource.instanceDetails.networkInterfaces.subnetId
\nresource.instanceDetails.networkInterfaces.vpcId
\nresource.instanceDetails.tags.key
\nresource.instanceDetails.tags.value
\nresource.resourceType
\nservice.action.actionType
\nservice.action.awsApiCallAction.api
\nservice.action.awsApiCallAction.callerType
\nservice.action.awsApiCallAction.errorCode
\nservice.action.awsApiCallAction.userAgent
\nservice.action.awsApiCallAction.remoteIpDetails.city.cityName
\nservice.action.awsApiCallAction.remoteIpDetails.country.countryName
\nservice.action.awsApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asn
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
\nservice.action.awsApiCallAction.serviceName
\nservice.action.dnsRequestAction.domain
\nservice.action.networkConnectionAction.blocked
\nservice.action.networkConnectionAction.connectionDirection
\nservice.action.networkConnectionAction.localPortDetails.port
\nservice.action.networkConnectionAction.protocol
\nservice.action.networkConnectionAction.localIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.remoteIpDetails.city.cityName
\nservice.action.networkConnectionAction.remoteIpDetails.country.countryName
\nservice.action.networkConnectionAction.remoteIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asn
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
\nservice.action.networkConnectionAction.remotePortDetails.port
\nservice.additionalInfo.threatListName
\nresource.s3BucketDetails.publicAccess.effectivePermissions
\nresource.s3BucketDetails.name
\nresource.s3BucketDetails.tags.key
\nresource.s3BucketDetails.tags.value
\nresource.s3BucketDetails.type
\nservice.resourceRole
\nseverity
\ntype
\nupdatedAt
\nType: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ\n depending on whether the value contains milliseconds.
\nRepresents the criteria to be used in the filter for querying findings.
\nYou can only use the following attributes to query findings:
\naccountId
\nid
\nregion
\nseverity
\nTo filter on the basis of severity, the API and CLI use the following input list for\n the FindingCriteria\n condition:
\n\n Low: [\"1\", \"2\", \"3\"]\n
\n Medium: [\"4\", \"5\", \"6\"]\n
\n High: [\"7\", \"8\", \"9\"]\n
For more information, see Severity\n levels for GuardDuty findings.
\ntype
\nupdatedAt
\nType: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ\n depending on whether the value contains milliseconds.
\nresource.accessKeyDetails.accessKeyId
\nresource.accessKeyDetails.principalId
\nresource.accessKeyDetails.userName
\nresource.accessKeyDetails.userType
\nresource.instanceDetails.iamInstanceProfile.id
\nresource.instanceDetails.imageId
\nresource.instanceDetails.instanceId
\nresource.instanceDetails.tags.key
\nresource.instanceDetails.tags.value
\nresource.instanceDetails.networkInterfaces.ipv6Addresses
\nresource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
\nresource.instanceDetails.networkInterfaces.publicDnsName
\nresource.instanceDetails.networkInterfaces.publicIp
\nresource.instanceDetails.networkInterfaces.securityGroups.groupId
\nresource.instanceDetails.networkInterfaces.securityGroups.groupName
\nresource.instanceDetails.networkInterfaces.subnetId
\nresource.instanceDetails.networkInterfaces.vpcId
\nresource.instanceDetails.outpostArn
\nresource.resourceType
\nresource.s3BucketDetails.publicAccess.effectivePermissions
\nresource.s3BucketDetails.name
\nresource.s3BucketDetails.tags.key
\nresource.s3BucketDetails.tags.value
\nresource.s3BucketDetails.type
\nservice.action.actionType
\nservice.action.awsApiCallAction.api
\nservice.action.awsApiCallAction.callerType
\nservice.action.awsApiCallAction.errorCode
\nservice.action.awsApiCallAction.remoteIpDetails.city.cityName
\nservice.action.awsApiCallAction.remoteIpDetails.country.countryName
\nservice.action.awsApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asn
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
\nservice.action.awsApiCallAction.serviceName
\nservice.action.dnsRequestAction.domain
\nservice.action.networkConnectionAction.blocked
\nservice.action.networkConnectionAction.connectionDirection
\nservice.action.networkConnectionAction.localPortDetails.port
\nservice.action.networkConnectionAction.protocol
\nservice.action.networkConnectionAction.remoteIpDetails.city.cityName
\nservice.action.networkConnectionAction.remoteIpDetails.country.countryName
\nservice.action.networkConnectionAction.remoteIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asn
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
\nservice.action.networkConnectionAction.remotePortDetails.port
\nservice.action.awsApiCallAction.remoteAccountDetails.affiliated
\nservice.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.kubernetesApiCallAction.requestUri
\nservice.action.networkConnectionAction.localIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.protocol
\nservice.action.awsApiCallAction.serviceName
\nservice.action.awsApiCallAction.remoteAccountDetails.accountId
\nservice.additionalInfo.threatListName
\nservice.resourceRole
\nresource.eksClusterDetails.name
\nresource.kubernetesDetails.kubernetesWorkloadDetails.name
\nresource.kubernetesDetails.kubernetesWorkloadDetails.namespace
\nresource.kubernetesDetails.kubernetesUserDetails.username
\nresource.kubernetesDetails.kubernetesWorkloadDetails.containers.image
\nresource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix
\nservice.ebsVolumeScanDetails.scanId
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash
\nresource.ecsClusterDetails.name
\nresource.ecsClusterDetails.taskDetails.containers.image
\nresource.ecsClusterDetails.taskDetails.definitionArn
\nresource.containerDetails.image
\nresource.rdsDbInstanceDetails.dbInstanceIdentifier
\nresource.rdsDbInstanceDetails.dbClusterIdentifier
\nresource.rdsDbInstanceDetails.engine
\nresource.rdsDbUserDetails.user
\nresource.rdsDbInstanceDetails.tags.key
\nresource.rdsDbInstanceDetails.tags.value
\nservice.runtimeDetails.process.executableSha256
\nservice.runtimeDetails.process.name
\nservice.runtimeDetails.process.name
\nresource.lambdaDetails.functionName
\nresource.lambdaDetails.functionArn
\nresource.lambdaDetails.tags.key
\nresource.lambdaDetails.tags.value
\nCreates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account\n IDs. This step is a prerequisite for managing the associated member accounts either by\n invitation or through an organization.
\nAs a delegated administrator, using CreateMembers will enable GuardDuty in \n the added member accounts, with the exception of the\n organization delegated administrator account. A delegated administrator must enable GuardDuty \n prior to being added as a member.
If you are adding accounts by invitation, before using InviteMembers, use \n CreateMembers after GuardDuty has been enabled in potential member accounts.
If you disassociate a member from a GuardDuty \n delegated administrator, the member account details \n obtained from this API, including the associated email addresses, will be retained. \n This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
", + "smithy.api#documentation": "Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account\n IDs. This step is a prerequisite for managing the associated member accounts either by\n invitation or through an organization.
\nAs a delegated administrator, using CreateMembers will enable GuardDuty in\n the added member accounts, with the exception of the organization delegated administrator\n account. A delegated administrator must enable GuardDuty prior to being added as a\n member.
If you are adding accounts by invitation, before using InviteMembers, use\n CreateMembers after GuardDuty has been enabled in potential member accounts.
If you disassociate a member from a GuardDuty delegated administrator, the member account\n details obtained from this API, including the associated email addresses, will be retained.\n This is done so that the delegated administrator can invoke the InviteMembers API without\n the need to invoke the CreateMembers API again. To remove the details associated with a member\n account, the delegated administrator must invoke the DeleteMembers API.\n
", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/member", @@ -3606,7 +3606,7 @@ } ], "traits": { - "smithy.api#documentation": "Disassociates the current GuardDuty member account from its administrator account.
\nWhen you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the CreateMembers API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
\nWith autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disable GuardDuty in a member\n account.
Disassociates the current GuardDuty member account from its administrator account.
\nWhen you disassociate an invited member from a GuardDuty delegated administrator, the member\n account details obtained from the CreateMembers API,\n including the associated email addresses, are retained. This is done so that the delegated\n administrator can invoke the InviteMembers API without\n the need to invoke the CreateMembers API again. To remove the details associated with a member\n account, the delegated administrator must invoke the DeleteMembers API.
\nWith autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disable GuardDuty in a member\n account.
Disassociates the current GuardDuty member account from its administrator account.
\nWhen you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the CreateMembers API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
", + "smithy.api#documentation": "Disassociates the current GuardDuty member account from its administrator account.
\nWhen you disassociate an invited member from a GuardDuty delegated administrator, the member\n account details obtained from the CreateMembers API,\n including the associated email addresses, are retained. This is done so that the delegated\n administrator can invoke the InviteMembers API without\n the need to invoke the CreateMembers API again. To remove the details associated with a member\n account, the delegated administrator must invoke the DeleteMembers API.
", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/master/disassociate", @@ -3713,7 +3713,7 @@ } ], "traits": { - "smithy.api#documentation": "Disassociates GuardDuty member accounts (from the current administrator account) specified\n by the account IDs.
\nWhen you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the CreateMembers API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
\nWith autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disassociate a member account\n before removing them from your Amazon Web Services organization.
Disassociates GuardDuty member accounts (from the current administrator account)\n specified by the account IDs.
\nWhen you disassociate an invited member from a GuardDuty delegated administrator, the member\n account details obtained from the CreateMembers API,\n including the associated email addresses, are retained. This is done so that the delegated\n administrator can invoke the InviteMembers API without\n the need to invoke the CreateMembers API again. To remove the details associated with a member\n account, the delegated administrator must invoke the DeleteMembers API.
\nWith autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disassociate a member account\n before removing them from your Amazon Web Services organization.
Amazon GuardDuty is a continuous security monitoring service that analyzes and processes\n the following data sources: VPC flow logs, Amazon Web Services CloudTrail management event logs, CloudTrail S3 data event\n logs, EKS audit logs, DNS logs, and Amazon EBS volume data.\n It uses threat intelligence\n feeds, such as lists of malicious IPs and domains, and machine learning to identify\n unexpected, potentially unauthorized, and malicious activity within your Amazon Web Services environment.\n This can include issues like escalations of privileges, uses of exposed credentials, or\n communication with malicious IPs, domains, or presence of malware on your Amazon EC2 instances\n and container workloads. For example, GuardDuty can detect compromised EC2 instances and\n container workloads serving malware, or mining bitcoin.
\nGuardDuty also monitors Amazon Web Services account access behavior for signs of compromise, such as\n unauthorized infrastructure deployments like EC2 instances deployed in a Region that has never\n been used, or unusual API calls like a password policy change to reduce password strength.
\nGuardDuty informs you about the status of your Amazon Web Services environment by producing security\n findings that you can view in the GuardDuty console or through Amazon EventBridge. For more\n information, see the \n Amazon\n GuardDuty User Guide\n .
", + "smithy.api#documentation": "Amazon GuardDuty is a continuous security monitoring service that analyzes and processes\n the following data sources: VPC flow logs, Amazon Web Services CloudTrail management event logs, CloudTrail S3 data event\n logs, EKS audit logs, DNS logs, and Amazon EBS volume data.\n It uses threat intelligence\n feeds, such as lists of malicious IPs and domains, and machine learning to identify\n unexpected, potentially unauthorized, and malicious activity within your Amazon Web Services environment.\n This can include issues like escalations of privileges, uses of exposed credentials, or\n communication with malicious IPs, domains, or presence of malware on your Amazon EC2 instances\n and container workloads. For example, GuardDuty can detect compromised EC2 instances and\n container workloads serving malware, or mining bitcoin.
\nGuardDuty also monitors Amazon Web Services account access behavior for signs of compromise, such as\n unauthorized infrastructure deployments like EC2 instances deployed in a Region that has never\n been used, or unusual API calls like a password policy change to reduce password strength.
\nGuardDuty informs you about the status of your Amazon Web Services environment by producing security\n findings that you can view in the GuardDuty console or through Amazon EventBridge. For more\n information, see the \n Amazon GuardDuty User\n Guide\n .
", "smithy.api#title": "Amazon GuardDuty", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -6273,52 +6273,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -6326,13 +6330,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -6342,92 +6355,83 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://guardduty-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://guardduty-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] } ], @@ -6436,155 +6440,115 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, + "aws-us-gov", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] } ] } ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws-us-gov", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://guardduty.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://guardduty-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] + "endpoint": { + "url": "https://guardduty.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://guardduty-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://guardduty.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://guardduty.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://guardduty.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://guardduty.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -7538,7 +7502,7 @@ } ], "traits": { - "smithy.api#documentation": "Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account \n that invokes this API. If you are using Amazon Web Services Organizations to manager your GuardDuty environment, this step is not \n needed. For more information, see Managing accounts with Amazon Web Services Organizations.
\nTo invite Amazon Web Services accounts, the first step is \n to ensure that GuardDuty has been enabled in the potential member accounts. You can now invoke this API\n to add accounts by invitation. The \n invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each invited Amazon Web Services account can \n choose to accept the invitation from only one Amazon Web Services account. For more information, see \n Managing GuardDuty accounts \n by invitation.
\nAfter the invite has been accepted and you choose to disassociate a member account \n (by using DisassociateMembers) from your account, \n the details of the member account obtained by invoking CreateMembers, including the \n associated email addresses, will be retained. \n This is done so that you can invoke InviteMembers without the need to invoke \n CreateMembers again. To \n remove the details associated with a member account, you must also invoke \n DeleteMembers.
", + "smithy.api#documentation": "Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services\n account that invokes this API. If you are using Amazon Web Services Organizations to manager your GuardDuty\n environment, this step is not needed. For more information, see Managing accounts with Amazon Web Services\n Organizations.
\nTo invite Amazon Web Services accounts, the first step is to ensure that GuardDuty has been enabled in the\n potential member accounts. You can now invoke this API to add accounts by invitation. The\n invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each\n invited Amazon Web Services account can choose to accept the invitation from only one Amazon Web Services account. For\n more information, see Managing GuardDuty accounts by\n invitation.
\nAfter the invite has been accepted and you choose to disassociate a member account (by\n using DisassociateMembers) from your account, the details of the member account obtained by\n invoking CreateMembers, including\n the associated email addresses, will be retained. This is done so that you can invoke\n InviteMembers without the need to invoke CreateMembers again. To\n remove the details associated with a member account, you must also invoke DeleteMembers.
", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/member/invite", @@ -7906,7 +7870,7 @@ "SessionName": { "target": "com.amazonaws.guardduty#SessionNameList", "traits": { - "smithy.api#documentation": "Entity that assumes the IAM role \n when Kubernetes RBAC permissions are assigned to that role.
", + "smithy.api#documentation": "Entity that assumes the IAM role when Kubernetes RBAC permissions are assigned to that\n role.
", "smithy.api#jsonName": "sessionName" } } @@ -8000,7 +7964,7 @@ "LastModifiedAt": { "target": "com.amazonaws.guardduty#Timestamp", "traits": { - "smithy.api#documentation": "The timestamp when the Lambda function was last modified. This field is in the UTC date string \n format (2023-03-22T19:37:20.168Z).
The timestamp when the Lambda function was last modified. This field is in the UTC date\n string format (2023-03-22T19:37:20.168Z).
A list of tags attached to this resource, listed in the format of \n key:value pair.
A list of tags attached to this resource, listed in the format of\n key:value pair.
Lists tags for a resource. Tagging is currently supported for detectors, finding filters,\n IP sets, threat intel sets, publishing destination, with a limit of 50 tags per resource. When invoked, this\n operation returns all assigned tags for a given resource.
", + "smithy.api#documentation": "Lists tags for a resource. Tagging is currently supported for detectors, finding filters,\n IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per each\n resource. When invoked, this operation returns all assigned tags for a given resource.
", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", @@ -9800,6 +9764,12 @@ "traits": { "smithy.api#enumValue": "NONE" } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } } } }, @@ -10880,7 +10850,7 @@ "ModifiedAt": { "target": "com.amazonaws.guardduty#Timestamp", "traits": { - "smithy.api#documentation": "The timestamp at which the process modified the current process. The timestamp is in UTC date string\n format.
", + "smithy.api#documentation": "The timestamp at which the process modified the current process. The timestamp is in UTC\n date string format.
", "smithy.api#jsonName": "modifiedAt" } }, @@ -10985,14 +10955,14 @@ "TargetProcess": { "target": "com.amazonaws.guardduty#ProcessDetails", "traits": { - "smithy.api#documentation": "Information about the process that had its memory overwritten by the current process.
", + "smithy.api#documentation": "Information about the process that had its memory overwritten by the current\n process.
", "smithy.api#jsonName": "targetProcess" } }, "AddressFamily": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "Represents the communication protocol associated with the address. For example, the address\n family AF_INET is used for IP version of 4 protocol.
Represents the communication protocol associated with the address. For example, the\n address family AF_INET is used for IP version of 4 protocol.
Initiates the malware scan. Invoking this API will automatically create the Service-linked role in \n the corresponding account.
", + "smithy.api#documentation": "Initiates the malware scan. Invoking this API will automatically create the Service-linked role in the corresponding account.
", "smithy.api#http": { "method": "POST", "uri": "/malware-scan/start", @@ -11869,7 +11839,7 @@ "ScanId": { "target": "com.amazonaws.guardduty#NonEmptyString", "traits": { - "smithy.api#documentation": "A unique identifier that gets generated when you invoke the API without any error. Each malware scan has \n a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.
", + "smithy.api#documentation": "A unique identifier that gets generated when you invoke the API without any error. Each\n malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of\n your malware scan.
", "smithy.api#jsonName": "scanId" } } diff --git a/codegen/sdk-codegen/aws-models/ivs-realtime.2020-07-14.json b/codegen/sdk-codegen/aws-models/ivs-realtime.2020-07-14.json index cdffbf491c0..66fc64bb869 100644 --- a/codegen/sdk-codegen/aws-models/ivs-realtime.2020-07-14.json +++ b/codegen/sdk-codegen/aws-models/ivs-realtime.2020-07-14.json @@ -98,7 +98,7 @@ "date" ] }, - "smithy.api#documentation": "\n Introduction\n
\nThe Amazon Interactive Video Service (IVS) stage API is REST compatible, using a standard HTTP \n\t API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, \n\t including errors.\n
\nTerminology:
\nThe IVS stage API sometimes is referred to as the IVS RealTime\n API.
\nA participant token is an authorization token used to publish/subscribe\n to a stage.
\nA participant object represents participants\n (people) in the stage and contains information about them. When a token is created, it\n includes a participant ID; when a participant uses that token to join a stage, the\n participant is associated with that participant ID There is a 1:1 mapping between\n participant tokens and participants.
\n\n Resources\n
\nThe following resources contain information about your IVS live stream (see Getting Started with Amazon IVS):
\n\n Stage — A stage is a virtual space where multiple participants can exchange audio and video in real time.
\n\n Tagging\n
\nA tag is a metadata label that you assign to an AWS resource. A tag\n comprises a key and a value, both set by you. For\n example, you might set a tag as topic:nature to label a particular video\n category. See Tagging AWS Resources for more information, including restrictions that apply to\n tags and \"Tag naming limits and requirements\"; Amazon IVS stages has no service-specific\n constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the\n same tag for different resources to indicate that they are related. You can also use tags to\n manage access (see Access Tags).
\nThe Amazon IVS stage API has these tag-related endpoints: TagResource, UntagResource, and\n ListTagsForResource. The following resource supports tagging: Stage.
\nAt most 50 tags can be applied to a resource.
\n\n Stages Endpoints\n
\n\n CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.
\n\n CreateStage — Creates a new stage (and optionally participant tokens).
\n\n DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).
\n\n DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.
\n\n GetParticipant — Gets information about the specified\n participant token.
\n\n GetStage — Gets information for the specified stage.
\n\n GetStageSession — Gets information for the specified stage\n session.
\n\n ListParticipantEvents — Lists events for a specified\n participant that occurred during a specified stage session.
\n\n ListParticipants — Lists all participants in a specified stage\n session.
\n\n ListStages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.
\n\n ListStageSessions — Gets all sessions for a specified stage.
\n\n UpdateStage — Updates a stage’s configuration.
\n\n Tags Endpoints\n
\n\n ListTagsForResource — Gets information about AWS tags for the\n specified ARN.
\n\n TagResource — Adds or updates tags for the AWS resource with\n the specified ARN.
\n\n UntagResource — Removes tags from the resource with the\n specified ARN.
\n\n Introduction\n
\nThe Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP \n\t API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, \n\t including errors.\n
\nTerminology:
\nA stage is a virtual space where participants can exchange video in real time.
\nA participant token is a token that authenticates a participant when they join a stage.
\nA participant object represents participants\n (people) in the stage and contains information about them. When a token is created, it\n includes a participant ID; when a participant uses that token to join a stage, the\n participant is associated with that participant ID There is a 1:1 mapping between\n participant tokens and participants.
\n\n Resources\n
\nThe following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):
\n\n Stage — A stage is a virtual space where participants can exchange video in real time.
\n\n Tagging\n
\nA tag is a metadata label that you assign to an AWS resource. A tag\n comprises a key and a value, both set by you. For\n example, you might set a tag as topic:nature to label a particular video\n category. See Tagging AWS Resources for more information, including restrictions that apply to\n tags and \"Tag naming limits and requirements\"; Amazon IVS stages has no service-specific\n constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the\n same tag for different resources to indicate that they are related. You can also use tags to\n manage access (see Access Tags).
\nThe Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and\n ListTagsForResource. The following resource supports tagging: Stage.
\nAt most 50 tags can be applied to a resource.
\n\n Stages Endpoints\n
\n\n CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.
\n\n CreateStage — Creates a new stage (and optionally participant tokens).
\n\n DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).
\n\n DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.
\n\n GetParticipant — Gets information about the specified\n participant token.
\n\n GetStage — Gets information for the specified stage.
\n\n GetStageSession — Gets information for the specified stage\n session.
\n\n ListParticipantEvents — Lists events for a specified\n participant that occurred during a specified stage session.
\n\n ListParticipants — Lists all participants in a specified stage\n session.
\n\n ListStages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.
\n\n ListStageSessions — Gets all sessions for a specified stage.
\n\n UpdateStage — Updates a stage’s configuration.
\n\n Tags Endpoints\n
\n\n ListTagsForResource — Gets information about AWS tags for the\n specified ARN.
\n\n TagResource — Adds or updates tags for the AWS resource with\n the specified ARN.
\n\n UntagResource — Removes tags from the resource with the\n specified ARN.
\nIf the event is an error event, the error code is provided to give insight into the\n specific error that occurred. If the event is not an error event, this field is null.\n INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the\n participant’s token is not allowed to do. For more information about participant\n capabilities, see the capabilities field in CreateParticipantToken.
If the event is an error event, the error code is provided to give insight into the\n specific error that occurred. If the event is not an error event, this field is null.\n INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the\n participant’s token is not allowed to do. For more information about participant\n capabilities, see the capabilities field in CreateParticipantToken. \n\t\t QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a \n\t\t stage exceeds the quota; for more information, see Service Quotas.\n\t\t PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher\n\t\t that doesn’t exist. \n
Describes the timestamp range and timestamp origin of a range of fragments.
\nFragments that have duplicate producer timestamps are deduplicated. This means that if\n producers are producing a stream of fragments with producer timestamps that are\n approximately equal to the true clock time, the clip will contain all of the fragments\n within the requested timestamp range. If some fragments are ingested within the same\n time range and very different points in time, only the oldest ingested collection of\n fragments are returned.
" + "smithy.api#documentation": "Describes the timestamp range and timestamp origin of a range of fragments.
\nFragments that have duplicate producer timestamps are deduplicated. This means that if\n producers are producing a stream of fragments with producer timestamps that are\n approximately equal to the true clock time, the clip will contain all of the fragments\n within the requested timestamp range. If some fragments are ingested within the same\n time range and very different points in time, only the oldest ingested collection of\n fragments are returned.
" } }, "com.amazonaws.kinesisvideoarchivedmedia#ClipFragmentSelectorType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PRODUCER_TIMESTAMP", - "name": "PRODUCER_TIMESTAMP" - }, - { - "value": "SERVER_TIMESTAMP", - "name": "SERVER_TIMESTAMP" + "type": "enum", + "members": { + "PRODUCER_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRODUCER_TIMESTAMP" } - ] + }, + "SERVER_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVER_TIMESTAMP" + } + } } }, "com.amazonaws.kinesisvideoarchivedmedia#ClipTimestampRange": { @@ -983,14 +985,14 @@ "StartTimestamp": { "target": "com.amazonaws.kinesisvideoarchivedmedia#Timestamp", "traits": { - "smithy.api#documentation": "The starting timestamp in the range of timestamps for which to return fragments.
\nOnly fragments that start exactly at or after StartTimestamp are included\n in the session. Fragments that start before StartTimestamp and continue\n past it aren't included in the session. If FragmentSelectorType is\n SERVER_TIMESTAMP, the StartTimestamp must be later than\n the stream head.
The starting timestamp in the range of timestamps for which to return fragments.
\nOnly fragments that start exactly at or after StartTimestamp are included\n in the session. Fragments that start before StartTimestamp and continue\n past it aren't included in the session. If FragmentSelectorType is\n SERVER_TIMESTAMP, the StartTimestamp must be later than\n the stream head.
The end of the timestamp range for the requested media.
\nThis value must be within 24 hours of the specified StartTimestamp, and\n it must be later than the StartTimestamp value. If\n FragmentSelectorType for the request is SERVER_TIMESTAMP,\n this value must be in the past.
This value is inclusive. The EndTimestamp is compared to the (starting)\n timestamp of the fragment. Fragments that start before the EndTimestamp\n value and continue past it are included in the session.
The end of the timestamp range for the requested media.
\nThis value must be within 24 hours of the specified StartTimestamp, and\n it must be later than the StartTimestamp value. If\n FragmentSelectorType for the request is SERVER_TIMESTAMP,\n this value must be in the past.
This value is inclusive. The EndTimestamp is compared to the (starting)\n timestamp of the fragment. Fragments that start before the EndTimestamp\n value and continue past it are included in the session.
The source of the timestamps for the requested media.
\nWhen FragmentSelectorType is set to PRODUCER_TIMESTAMP and\n GetDASHStreamingSessionURLInput$PlaybackMode is\n ON_DEMAND or LIVE_REPLAY, the first fragment ingested with\n a producer timestamp within the specified FragmentSelector$TimestampRange is included in the media playlist. In\n addition, the fragments with producer timestamps within the TimestampRange\n ingested immediately following the first fragment (up to the GetDASHStreamingSessionURLInput$MaxManifestFragmentResults value) are\n included.
Fragments that have duplicate producer timestamps are deduplicated. This means that if\n producers are producing a stream of fragments with producer timestamps that are\n approximately equal to the true clock time, the MPEG-DASH manifest will contain all of\n the fragments within the requested timestamp range. If some fragments are ingested\n within the same time range and very different points in time, only the oldest ingested\n collection of fragments are returned.
\nWhen FragmentSelectorType is set to PRODUCER_TIMESTAMP and\n GetDASHStreamingSessionURLInput$PlaybackMode is LIVE,\n the producer timestamps are used in the MP4 fragments and for deduplication. But the\n most recently ingested fragments based on server timestamps are included in the\n MPEG-DASH manifest. This means that even if fragments ingested in the past have producer\n timestamps with values now, they are not included in the HLS media playlist.
The default is SERVER_TIMESTAMP.
The source of the timestamps for the requested media.
\nWhen FragmentSelectorType is set to PRODUCER_TIMESTAMP and\n GetDASHStreamingSessionURLInput$PlaybackMode is\n ON_DEMAND or LIVE_REPLAY, the first fragment ingested with\n a producer timestamp within the specified FragmentSelector$TimestampRange is included in the media playlist. In\n addition, the fragments with producer timestamps within the TimestampRange\n ingested immediately following the first fragment (up to the GetDASHStreamingSessionURLInput$MaxManifestFragmentResults value) are\n included.
Fragments that have duplicate producer timestamps are deduplicated. This means that if\n producers are producing a stream of fragments with producer timestamps that are\n approximately equal to the true clock time, the MPEG-DASH manifest will contain all of\n the fragments within the requested timestamp range. If some fragments are ingested\n within the same time range and very different points in time, only the oldest ingested\n collection of fragments are returned.
\nWhen FragmentSelectorType is set to PRODUCER_TIMESTAMP and\n GetDASHStreamingSessionURLInput$PlaybackMode is LIVE,\n the producer timestamps are used in the MP4 fragments and for deduplication. But the\n most recently ingested fragments based on server timestamps are included in the\n MPEG-DASH manifest. This means that even if fragments ingested in the past have producer\n timestamps with values now, they are not included in the HLS media playlist.
The default is SERVER_TIMESTAMP.
The start and end of the timestamp range for the requested media.
\nThis value should not be present if PlaybackType is\n LIVE.
The start and end of the timestamp range for the requested media.
\nThis value should not be present if PlaybackType is\n LIVE.
The start of the timestamp range for the requested media.
\nIf the DASHTimestampRange value is specified, the\n StartTimestamp value is required.
Only fragments that start exactly at or after StartTimestamp are included\n in the session. Fragments that start before StartTimestamp and continue\n past it aren't included in the session. If FragmentSelectorType is\n SERVER_TIMESTAMP, the StartTimestamp must be later than\n the stream head.
The start of the timestamp range for the requested media.
\nIf the DASHTimestampRange value is specified, the\n StartTimestamp value is required.
Only fragments that start exactly at or after StartTimestamp are included\n in the session. Fragments that start before StartTimestamp and continue\n past it aren't included in the session. If FragmentSelectorType is\n SERVER_TIMESTAMP, the StartTimestamp must be later than\n the stream head.
The end of the timestamp range for the requested media. This value must be within 24\n hours of the specified StartTimestamp, and it must be later than the\n StartTimestamp value.
If FragmentSelectorType for the request is SERVER_TIMESTAMP,\n this value must be in the past.
The EndTimestamp value is required for ON_DEMAND mode, but\n optional for LIVE_REPLAY mode. If the EndTimestamp is not set\n for LIVE_REPLAY mode then the session will continue to include newly\n ingested fragments until the session expires.
This value is inclusive. The EndTimestamp is compared to the\n (starting) timestamp of the fragment. Fragments that start before the\n EndTimestamp value and continue past it are included in the\n session.
The end of the timestamp range for the requested media. This value must be within 24\n hours of the specified StartTimestamp, and it must be later than the\n StartTimestamp value.
If FragmentSelectorType for the request is SERVER_TIMESTAMP,\n this value must be in the past.
The EndTimestamp value is required for ON_DEMAND mode, but\n optional for LIVE_REPLAY mode. If the EndTimestamp is not set\n for LIVE_REPLAY mode then the session will continue to include newly\n ingested fragments until the session expires.
This value is inclusive. The EndTimestamp is compared to the\n (starting) timestamp of the fragment. Fragments that start before the\n EndTimestamp value and continue past it are included in the\n session.
The start and end of the timestamp range for the requested media.
\nThis value should not be present if PlaybackType is\n LIVE.
The values in DASHimestampRange are inclusive. Fragments that start\n exactly at or after the start time are included in the session. Fragments that start\n before the start time and continue past it are not included in the session.
The start and end of the timestamp range for the requested media.
\nThis value should not be present if PlaybackType is\n LIVE.
The values in DASHimestampRange are inclusive. Fragments that start\n exactly at or after the start time are included in the session. Fragments that start\n before the start time and continue past it are not included in the session.
The timestamp from the AWS server corresponding to the fragment.
" + "smithy.api#documentation": "The timestamp from the Amazon Web Services server corresponding to the fragment.
" } }, "FragmentLengthInMilliseconds": { @@ -1290,22 +1306,24 @@ } }, "traits": { - "smithy.api#documentation": "Describes the timestamp range and timestamp origin of a range of fragments.
\nOnly fragments with a start timestamp greater than or equal to the given start time\n and less than or equal to the end time are returned. For example, if a stream contains\n fragments with the following start timestamps:
\n00:00:00
\n00:00:02
\n00:00:04
\n00:00:06
\nA fragment selector range with a start time of 00:00:01 and end time of 00:00:04\n would return the fragments with start times of 00:00:02 and 00:00:04.
" + "smithy.api#documentation": "Describes the timestamp range and timestamp origin of a range of fragments.
\nOnly fragments with a start timestamp greater than or equal to the given start time\n and less than or equal to the end time are returned. For example, if a stream contains\n fragments with the following start timestamps:
\n00:00:00
\n00:00:02
\n00:00:04
\n00:00:06
\nA fragment selector range with a start time of 00:00:01 and end time of 00:00:04\n would return the fragments with start times of 00:00:02 and 00:00:04.
" } }, "com.amazonaws.kinesisvideoarchivedmedia#FragmentSelectorType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PRODUCER_TIMESTAMP", - "name": "PRODUCER_TIMESTAMP" - }, - { - "value": "SERVER_TIMESTAMP", - "name": "SERVER_TIMESTAMP" + "type": "enum", + "members": { + "PRODUCER_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRODUCER_TIMESTAMP" } - ] + }, + "SERVER_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVER_TIMESTAMP" + } + } } }, "com.amazonaws.kinesisvideoarchivedmedia#GetClip": { @@ -1346,7 +1364,7 @@ } ], "traits": { - "smithy.api#documentation": "Downloads an MP4 file (clip) containing the archived, on-demand media from the\n specified video stream over the specified time range.
\nBoth the StreamName and the StreamARN parameters are optional, but you must specify\n either the StreamName or the StreamARN when invoking this API operation.
\n\nAs a prerequisite to using GetCLip API, you must obtain an endpoint using\n GetDataEndpoint, specifying GET_CLIP for the\n APIName parameter.
An Amazon Kinesis video stream has the following requirements for providing data\n through MP4:
\nThe media must contain h.264 or h.265 encoded video and, optionally, AAC or\n G.711 encoded audio. Specifically, the codec ID of track 1 should be\n V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265).\n Optionally, the codec ID of track 2 should be A_AAC (for AAC) or\n A_MS/ACM (for G.711).
Data retention must be greater than 0.
\nThe video track of each fragment must contain codec private data in the\n Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 format. For more\n information, see MPEG-4\n specification ISO/IEC 14496-15. For information about adapting\n stream data to a given format, see NAL Adaptation Flags.
\nThe audio track (if present) of each fragment must contain codec private data\n in the AAC format (AAC\n specification ISO/IEC 13818-7) or the MS\n Wave format.
\nYou can monitor the amount of outgoing data by monitoring the\n GetClip.OutgoingBytes Amazon CloudWatch metric. For information about\n using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video\n Streams Pricing and AWS\n Pricing. Charges for outgoing AWS data apply.
Downloads an MP4 file (clip) containing the archived, on-demand media from the\n specified video stream over the specified time range.
\nBoth the StreamName and the StreamARN parameters are optional, but you must specify\n either the StreamName or the StreamARN when invoking this API operation.
\nAs a prerequisite to using GetCLip API, you must obtain an endpoint using\n GetDataEndpoint, specifying GET_CLIP for the\n APIName parameter.
An Amazon Kinesis video stream has the following requirements for providing data\n through MP4:
\nThe media must contain h.264 or h.265 encoded video and, optionally, AAC or\n G.711 encoded audio. Specifically, the codec ID of track 1 should be\n V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265).\n Optionally, the codec ID of track 2 should be A_AAC (for AAC) or\n A_MS/ACM (for G.711).
Data retention must be greater than 0.
\nThe video track of each fragment must contain codec private data in the\n Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 format. For more\n information, see MPEG-4\n specification ISO/IEC 14496-15. For information about adapting\n stream data to a given format, see NAL Adaptation Flags.
\nThe audio track (if present) of each fragment must contain codec private data\n in the AAC format (AAC\n specification ISO/IEC 13818-7) or the MS\n Wave format.
\nYou can monitor the amount of outgoing data by monitoring the\n GetClip.OutgoingBytes Amazon CloudWatch metric. For information about\n using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video\n Streams Pricing and Amazon Web Services\n Pricing. Charges for outgoing Amazon Web Services data apply.
The name of the stream for which to retrieve the media clip.
\nYou must specify either the StreamName or the StreamARN.
" + "smithy.api#documentation": "The name of the stream for which to retrieve the media clip.
\nYou must specify either the StreamName or the StreamARN.
" } }, "StreamARN": { "target": "com.amazonaws.kinesisvideoarchivedmedia#ResourceARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the stream for which to retrieve the media clip.
\nYou must specify either the StreamName or the StreamARN.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the stream for which to retrieve the media clip.
\nYou must specify either the StreamName or the StreamARN.
" } }, "ClipFragmentSelector": { @@ -1376,6 +1394,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideoarchivedmedia#GetClipOutput": { @@ -1396,6 +1417,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideoarchivedmedia#GetDASHStreamingSessionURL": { @@ -1433,7 +1457,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream. You\n can then open the URL in a media player to view the stream contents.
\n \nBoth the StreamName and the StreamARN parameters are\n optional, but you must specify either the StreamName or the\n StreamARN when invoking this API operation.
An Amazon Kinesis video stream has the following requirements for providing data\n through MPEG-DASH:
\nThe media must contain h.264 or h.265 encoded video and, optionally, AAC or\n G.711 encoded audio. Specifically, the codec ID of track 1 should be\n V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265).\n Optionally, the codec ID of track 2 should be A_AAC (for AAC) or\n A_MS/ACM (for G.711).
Data retention must be greater than 0.
\nThe video track of each fragment must contain codec private data in the\n Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 format. For more\n information, see MPEG-4\n specification ISO/IEC 14496-15. For information about adapting\n stream data to a given format, see NAL Adaptation Flags.
\nThe audio track (if present) of each fragment must contain codec private data\n in the AAC format (AAC\n specification ISO/IEC 13818-7) or the MS\n Wave format.
\nThe following procedure shows how to use MPEG-DASH with Kinesis Video Streams:
\nGet an endpoint using GetDataEndpoint, specifying\n GET_DASH_STREAMING_SESSION_URL for the APIName\n parameter.
Retrieve the MPEG-DASH URL using GetDASHStreamingSessionURL.\n Kinesis Video Streams creates an MPEG-DASH streaming session to be used for\n accessing content in a stream using the MPEG-DASH protocol.\n GetDASHStreamingSessionURL returns an authenticated URL (that\n includes an encrypted session token) for the session's MPEG-DASH\n manifest (the root resource needed for streaming with\n MPEG-DASH).
Don't share or store this token where an unauthorized entity can access\n it. The token provides access to the content of the stream. Safeguard the\n token with the same measures that you use with your AWS credentials.
\nThe media that is made available through the manifest consists only of the\n requested stream, time range, and format. No other media data (such as frames\n outside the requested window or alternate bitrates) is made available.
\nProvide the URL (containing the encrypted session token) for the MPEG-DASH\n manifest to a media player that supports the MPEG-DASH protocol. Kinesis Video\n Streams makes the initialization fragment and media fragments available through\n the manifest URL. The initialization fragment contains the codec private data\n for the stream, and other data needed to set up the video or audio decoder and\n renderer. The media fragments contain encoded video frames or encoded audio\n samples.
\nThe media player receives the authenticated URL and requests stream metadata\n and media data normally. When the media player requests data, it calls the\n following actions:
\n\n GetDASHManifest: Retrieves an MPEG DASH\n manifest, which contains the metadata for the media that you want to\n playback.
\n\n GetMP4InitFragment: Retrieves the MP4\n initialization fragment. The media player typically loads the\n initialization fragment before loading any media fragments. This\n fragment contains the \"fytp\" and \"moov\" MP4\n atoms, and the child atoms that are needed to initialize the media\n player decoder.
The initialization fragment does not correspond to a fragment in a\n Kinesis video stream. It contains only the codec private data for the\n stream and respective track, which the media player needs to decode the\n media frames.
\n\n GetMP4MediaFragment: Retrieves MP4\n media fragments. These fragments contain the \"moof\" and\n \"mdat\" MP4 atoms and their child atoms, containing the\n encoded fragment's media frames and their timestamps.
After the first media fragment is made available in a streaming\n session, any fragments that don't contain the same codec private\n data cause an error to be returned when those different media\n fragments are loaded. Therefore, the codec private data should not\n change between fragments in a session. This also means that the\n session fails if the fragments in a stream change from having only\n video to having both audio and video.
\nData retrieved with this action is billable. See Pricing for details.
\nFor restrictions that apply to MPEG-DASH sessions, see Kinesis Video Streams Limits.
\nYou can monitor the amount of data that the media player consumes by monitoring the\n GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For\n information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video\n Streams Pricing and AWS\n Pricing. Charges for both HLS sessions and outgoing AWS data apply.
For more information about HLS, see HTTP Live Streaming on the\n Apple Developer site.
\n\nIf an error is thrown after invoking a Kinesis Video Streams archived media API,\n in addition to the HTTP status code and the response body, it includes the following\n pieces of information:
\n\n x-amz-ErrorType HTTP header – contains a more specific error\n type in addition to what the HTTP status code provides.
\n x-amz-RequestId HTTP header – if you want to report an issue to\n AWS, the support team can better diagnose the problem if given the Request\n Id.
Both the HTTP status code and the ErrorType header can be utilized to make\n programmatic decisions about whether errors are retry-able and under what\n conditions, as well as provide information on what actions the client programmer\n might need to take in order to successfully try again.
\nFor more information, see the Errors section at\n the bottom of this topic, as well as Common Errors.\n
\nRetrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream. You\n can then open the URL in a media player to view the stream contents.
\nBoth the StreamName and the StreamARN parameters are\n optional, but you must specify either the StreamName or the\n StreamARN when invoking this API operation.
An Amazon Kinesis video stream has the following requirements for providing data\n through MPEG-DASH:
\nThe media must contain h.264 or h.265 encoded video and, optionally, AAC or\n G.711 encoded audio. Specifically, the codec ID of track 1 should be\n V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265).\n Optionally, the codec ID of track 2 should be A_AAC (for AAC) or\n A_MS/ACM (for G.711).
Data retention must be greater than 0.
\nThe video track of each fragment must contain codec private data in the\n Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 format. For more\n information, see MPEG-4\n specification ISO/IEC 14496-15. For information about adapting\n stream data to a given format, see NAL Adaptation Flags.
\nThe audio track (if present) of each fragment must contain codec private data\n in the AAC format (AAC\n specification ISO/IEC 13818-7) or the MS\n Wave format.
\nThe following procedure shows how to use MPEG-DASH with Kinesis Video Streams:
\nGet an endpoint using GetDataEndpoint, specifying\n GET_DASH_STREAMING_SESSION_URL for the APIName\n parameter.
Retrieve the MPEG-DASH URL using GetDASHStreamingSessionURL.\n Kinesis Video Streams creates an MPEG-DASH streaming session to be used for\n accessing content in a stream using the MPEG-DASH protocol.\n GetDASHStreamingSessionURL returns an authenticated URL (that\n includes an encrypted session token) for the session's MPEG-DASH\n manifest (the root resource needed for streaming with\n MPEG-DASH).
Don't share or store this token where an unauthorized entity can access\n it. The token provides access to the content of the stream. Safeguard the\n token with the same measures that you use with your Amazon Web Services credentials.
\nThe media that is made available through the manifest consists only of the\n requested stream, time range, and format. No other media data (such as frames\n outside the requested window or alternate bitrates) is made available.
\nProvide the URL (containing the encrypted session token) for the MPEG-DASH\n manifest to a media player that supports the MPEG-DASH protocol. Kinesis Video\n Streams makes the initialization fragment and media fragments available through\n the manifest URL. The initialization fragment contains the codec private data\n for the stream, and other data needed to set up the video or audio decoder and\n renderer. The media fragments contain encoded video frames or encoded audio\n samples.
\nThe media player receives the authenticated URL and requests stream metadata\n and media data normally. When the media player requests data, it calls the\n following actions:
\n\n GetDASHManifest: Retrieves an MPEG DASH\n manifest, which contains the metadata for the media that you want to\n playback.
\n\n GetMP4InitFragment: Retrieves the MP4\n initialization fragment. The media player typically loads the\n initialization fragment before loading any media fragments. This\n fragment contains the \"fytp\" and \"moov\" MP4\n atoms, and the child atoms that are needed to initialize the media\n player decoder.
The initialization fragment does not correspond to a fragment in a\n Kinesis video stream. It contains only the codec private data for the\n stream and respective track, which the media player needs to decode the\n media frames.
\n\n GetMP4MediaFragment: Retrieves MP4\n media fragments. These fragments contain the \"moof\" and\n \"mdat\" MP4 atoms and their child atoms, containing the\n encoded fragment's media frames and their timestamps.
After the first media fragment is made available in a streaming\n session, any fragments that don't contain the same codec private\n data cause an error to be returned when those different media\n fragments are loaded. Therefore, the codec private data should not\n change between fragments in a session. This also means that the\n session fails if the fragments in a stream change from having only\n video to having both audio and video.
\nData retrieved with this action is billable. See Pricing for details.
\nFor restrictions that apply to MPEG-DASH sessions, see Kinesis Video Streams Limits.
\nYou can monitor the amount of data that the media player consumes by monitoring the\n GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For\n information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video\n Streams Pricing and Amazon Web Services\n Pricing. Charges for both HLS sessions and outgoing Amazon Web Services data apply.
For more information about HLS, see HTTP Live Streaming on the\n Apple Developer site.
\nIf an error is thrown after invoking a Kinesis Video Streams archived media API,\n in addition to the HTTP status code and the response body, it includes the following\n pieces of information:
\n\n x-amz-ErrorType HTTP header – contains a more specific error\n type in addition to what the HTTP status code provides.
\n x-amz-RequestId HTTP header – if you want to report an issue to\n Amazon Web Services the support team can better diagnose the problem if given the Request\n Id.
Both the HTTP status code and the ErrorType header can be utilized to make\n programmatic decisions about whether errors are retry-able and under what\n conditions, as well as provide information on what actions the client programmer\n might need to take in order to successfully try again.
\nFor more information, see the Errors section at\n the bottom of this topic, as well as Common Errors.\n
\nThe name of the stream for which to retrieve the MPEG-DASH manifest URL.
\nYou must specify either the StreamName or the\n StreamARN.
The name of the stream for which to retrieve the MPEG-DASH manifest URL.
\nYou must specify either the StreamName or the\n StreamARN.
The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH\n manifest URL.
\nYou must specify either the StreamName or the\n StreamARN.
The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH\n manifest URL.
\nYou must specify either the StreamName or the\n StreamARN.
Whether to retrieve live, live replay, or archived, on-demand data.
\nFeatures of the three types of sessions include the following:
\n\n \n LIVE\n : For sessions of this type, the MPEG-DASH manifest is continually\n updated with the latest fragments as they become available. We recommend that\n the media player retrieve a new manifest on a one-second interval. When this\n type of session is played in a media player, the user interface typically\n displays a \"live\" notification, with no scrubber control for choosing the\n position in the playback window to display.
In LIVE mode, the newest available fragments are included in\n an MPEG-DASH manifest, even if there is a gap between fragments (that is, if\n a fragment is missing). A gap like this might cause a media player to halt\n or cause a jump in playback. In this mode, fragments are not added to the\n MPEG-DASH manifest if they are older than the newest fragment in the\n playlist. If the missing fragment becomes available after a subsequent\n fragment is added to the manifest, the older fragment is not added, and the\n gap is not filled.
\n \n LIVE_REPLAY\n : For sessions of this type, the MPEG-DASH manifest is updated\n similarly to how it is updated for LIVE mode except that it starts\n by including fragments from a given start time. Instead of fragments being added\n as they are ingested, fragments are added as the duration of the next fragment\n elapses. For example, if the fragments in the session are two seconds long, then\n a new fragment is added to the manifest every two seconds. This mode is useful\n to be able to start playback from when an event is detected and continue live\n streaming media that has not yet been ingested as of the time of the session\n creation. This mode is also useful to stream previously archived media without\n being limited by the 1,000 fragment limit in the ON_DEMAND mode.\n
\n \n ON_DEMAND\n : For sessions of this type, the MPEG-DASH manifest contains all the\n fragments for the session, up to the number that is specified in\n MaxManifestFragmentResults. The manifest must be retrieved only\n once for each session. When this type of session is played in a media player,\n the user interface typically displays a scrubber control for choosing the\n position in the playback window to display.
In all playback modes, if FragmentSelectorType is\n PRODUCER_TIMESTAMP, and if there are multiple fragments with the same\n start timestamp, the fragment that has the larger fragment number (that is, the newer\n fragment) is included in the MPEG-DASH manifest. The other fragments are not included.\n Fragments that have different timestamps but have overlapping durations are still\n included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media\n player.
The default is LIVE.
Whether to retrieve live, live replay, or archived, on-demand data.
\nFeatures of the three types of sessions include the following:
\n\n \n LIVE\n : For sessions of this type, the MPEG-DASH manifest is continually\n updated with the latest fragments as they become available. We recommend that\n the media player retrieve a new manifest on a one-second interval. When this\n type of session is played in a media player, the user interface typically\n displays a \"live\" notification, with no scrubber control for choosing the\n position in the playback window to display.
In LIVE mode, the newest available fragments are included in\n an MPEG-DASH manifest, even if there is a gap between fragments (that is, if\n a fragment is missing). A gap like this might cause a media player to halt\n or cause a jump in playback. In this mode, fragments are not added to the\n MPEG-DASH manifest if they are older than the newest fragment in the\n playlist. If the missing fragment becomes available after a subsequent\n fragment is added to the manifest, the older fragment is not added, and the\n gap is not filled.
\n \n LIVE_REPLAY\n : For sessions of this type, the MPEG-DASH manifest is updated\n similarly to how it is updated for LIVE mode except that it starts\n by including fragments from a given start time. Instead of fragments being added\n as they are ingested, fragments are added as the duration of the next fragment\n elapses. For example, if the fragments in the session are two seconds long, then\n a new fragment is added to the manifest every two seconds. This mode is useful\n to be able to start playback from when an event is detected and continue live\n streaming media that has not yet been ingested as of the time of the session\n creation. This mode is also useful to stream previously archived media without\n being limited by the 1,000 fragment limit in the ON_DEMAND mode.\n
\n \n ON_DEMAND\n : For sessions of this type, the MPEG-DASH manifest contains all the\n fragments for the session, up to the number that is specified in\n MaxManifestFragmentResults. The manifest must be retrieved only\n once for each session. When this type of session is played in a media player,\n the user interface typically displays a scrubber control for choosing the\n position in the playback window to display.
In all playback modes, if FragmentSelectorType is\n PRODUCER_TIMESTAMP, and if there are multiple fragments with the same\n start timestamp, the fragment that has the larger fragment number (that is, the newer\n fragment) is included in the MPEG-DASH manifest. The other fragments are not included.\n Fragments that have different timestamps but have overlapping durations are still\n included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media\n player.
The default is LIVE.
Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file\n can be derived using attributes in the manifest itself. However, typically, MPEG-DASH\n compatible media players do not properly handle gaps in the media timeline. Kinesis\n Video Streams adjusts the media timeline in the manifest file to enable playback of\n media with discontinuities. Therefore, the wall-clock time derived from the manifest\n file may be inaccurate. If DisplayFragmentTimestamp is set to ALWAYS, the\n accurate fragment timestamp is added to each S element in the manifest file with the\n attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this\n custom attribute.
The default value is NEVER. When DASHFragmentSelector\n is SERVER_TIMESTAMP, the timestamps will be the server start timestamps.\n Similarly, when DASHFragmentSelector is\n PRODUCER_TIMESTAMP, the timestamps will be the producer start\n timestamps.
Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file\n can be derived using attributes in the manifest itself. However, typically, MPEG-DASH\n compatible media players do not properly handle gaps in the media timeline. Kinesis\n Video Streams adjusts the media timeline in the manifest file to enable playback of\n media with discontinuities. Therefore, the wall-clock time derived from the manifest\n file may be inaccurate. If DisplayFragmentTimestamp is set to ALWAYS, the\n accurate fragment timestamp is added to each S element in the manifest file with the\n attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this\n custom attribute.
The default value is NEVER. When DASHFragmentSelector\n is SERVER_TIMESTAMP, the timestamps will be the server start timestamps.\n Similarly, when DASHFragmentSelector is\n PRODUCER_TIMESTAMP, the timestamps will be the producer start\n timestamps.
Fragments are identified in the manifest file based on their sequence number in the\n session. If DisplayFragmentNumber is set to ALWAYS, the Kinesis Video\n Streams fragment number is added to each S element in the manifest file with the\n attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with\n other APIs (e.g. GetMedia and GetMediaForFragmentList). A\n custom MPEG-DASH media player is necessary to leverage these this custom\n attribute.
The default value is NEVER.
Fragments are identified in the manifest file based on their sequence number in the\n session. If DisplayFragmentNumber is set to ALWAYS, the Kinesis Video\n Streams fragment number is added to each S element in the manifest file with the\n attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with\n other APIs (e.g. GetMedia and GetMediaForFragmentList). A\n custom MPEG-DASH media player is necessary to leverage these this custom\n attribute.
The default value is NEVER.
The time range of the requested fragment and the source of the timestamps.
\nThis parameter is required if PlaybackMode is ON_DEMAND or\n LIVE_REPLAY. This parameter is optional if PlaybackMode is\n LIVE. If PlaybackMode is LIVE, the\n FragmentSelectorType can be set, but the TimestampRange\n should not be set. If PlaybackMode is ON_DEMAND or\n LIVE_REPLAY, both FragmentSelectorType and\n TimestampRange must be set.
The time range of the requested fragment and the source of the timestamps.
\nThis parameter is required if PlaybackMode is ON_DEMAND or\n LIVE_REPLAY. This parameter is optional if PlaybackMode is\n LIVE. If PlaybackMode is LIVE, the\n FragmentSelectorType can be set, but the TimestampRange\n should not be set. If PlaybackMode is ON_DEMAND or\n LIVE_REPLAY, both FragmentSelectorType and\n TimestampRange must be set.
The time in seconds until the requested session expires. This value can be between 300\n (5 minutes) and 43200 (12 hours).
\nWhen a session expires, no new calls to GetDashManifest,\n GetMP4InitFragment, or GetMP4MediaFragment can be made for\n that session.
The default is 300 (5 minutes).
" + "smithy.api#documentation": "The time in seconds until the requested session expires. This value can be between 300\n (5 minutes) and 43200 (12 hours).
\nWhen a session expires, no new calls to GetDashManifest,\n GetMP4InitFragment, or GetMP4MediaFragment can be made for\n that session.
The default is 300 (5 minutes).
" } }, "MaxManifestFragmentResults": { "target": "com.amazonaws.kinesisvideoarchivedmedia#DASHMaxResults", "traits": { - "smithy.api#documentation": "The maximum number of fragments that are returned in the MPEG-DASH manifest.
\nWhen the PlaybackMode is LIVE, the most recent fragments are\n returned up to this value. When the PlaybackMode is ON_DEMAND,\n the oldest fragments are returned, up to this maximum number.
When there are a higher number of fragments available in a live MPEG-DASH manifest,\n video players often buffer content before starting playback. Increasing the buffer size\n increases the playback latency, but it decreases the likelihood that rebuffering will\n occur during playback. We recommend that a live MPEG-DASH manifest have a minimum of 3\n fragments and a maximum of 10 fragments.
\nThe default is 5 fragments if PlaybackMode is LIVE or\n LIVE_REPLAY, and 1,000 if PlaybackMode is\n ON_DEMAND.
The maximum value of 1,000 fragments corresponds to more than 16 minutes of video on\n streams with 1-second fragments, and more than 2 1/2 hours of video on streams with\n 10-second fragments.
" + "smithy.api#documentation": "The maximum number of fragments that are returned in the MPEG-DASH manifest.
\nWhen the PlaybackMode is LIVE, the most recent fragments are\n returned up to this value. When the PlaybackMode is ON_DEMAND,\n the oldest fragments are returned, up to this maximum number.
When there are a higher number of fragments available in a live MPEG-DASH manifest,\n video players often buffer content before starting playback. Increasing the buffer size\n increases the playback latency, but it decreases the likelihood that rebuffering will\n occur during playback. We recommend that a live MPEG-DASH manifest have a minimum of 3\n fragments and a maximum of 10 fragments.
\nThe default is 5 fragments if PlaybackMode is LIVE or\n LIVE_REPLAY, and 1,000 if PlaybackMode is\n ON_DEMAND.
The maximum value of 1,000 fragments corresponds to more than 16 minutes of video on\n streams with 1-second fragments, and more than 2 1/2 hours of video on streams with\n 10-second fragments.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideoarchivedmedia#GetDASHStreamingSessionURLOutput": { @@ -1503,6 +1530,9 @@ "smithy.api#documentation": "The URL (containing the session token) that a media player can use to retrieve the\n MPEG-DASH manifest.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideoarchivedmedia#GetHLSStreamingSessionURL": { @@ -1540,7 +1570,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL\n in a browser or media player to view the stream contents.
\nBoth the StreamName and the StreamARN parameters are\n optional, but you must specify either the StreamName or the\n StreamARN when invoking this API operation.
An Amazon Kinesis video stream has the following requirements for providing data\n through HLS:
\nThe media must contain h.264 or h.265 encoded video and, optionally, AAC\n encoded audio. Specifically, the codec ID of track 1 should be\n V_MPEG/ISO/AVC (for h.264) or V_MPEG/ISO/HEVC (for\n h.265). Optionally, the codec ID of track 2 should be A_AAC.
Data retention must be greater than 0.
\nThe video track of each fragment must contain codec private data in the\n Advanced Video Coding (AVC) for H.264 format or HEVC for H.265 format (MPEG-4 specification ISO/IEC\n 14496-15). For information about adapting stream data to a given\n format, see NAL Adaptation Flags.
\nThe audio track (if present) of each fragment must contain codec private data\n in the AAC format (AAC\n specification ISO/IEC 13818-7).
\nKinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form\n (also called fMP4 or CMAF) or the MPEG-2 form (also called TS chunks, which the HLS\n specification also supports). For more information about HLS fragment types, see the\n HLS\n specification.
\nThe following procedure shows how to use HLS with Kinesis Video Streams:
\nGet an endpoint using GetDataEndpoint, specifying\n GET_HLS_STREAMING_SESSION_URL for the APIName\n parameter.
Retrieve the HLS URL using GetHLSStreamingSessionURL. Kinesis\n Video Streams creates an HLS streaming session to be used for accessing content\n in a stream using the HLS protocol. GetHLSStreamingSessionURL\n returns an authenticated URL (that includes an encrypted session token) for the\n session's HLS master playlist (the root resource needed for\n streaming with HLS).
Don't share or store this token where an unauthorized entity could access\n it. The token provides access to the content of the stream. Safeguard the\n token with the same measures that you would use with your AWS\n credentials.
\nThe media that is made available through the playlist consists only of the\n requested stream, time range, and format. No other media data (such as frames\n outside the requested window or alternate bitrates) is made available.
\nProvide the URL (containing the encrypted session token) for the HLS master\n playlist to a media player that supports the HLS protocol. Kinesis Video Streams\n makes the HLS media playlist, initialization fragment, and media fragments\n available through the master playlist URL. The initialization fragment contains\n the codec private data for the stream, and other data needed to set up the video\n or audio decoder and renderer. The media fragments contain H.264-encoded video\n frames or AAC-encoded audio samples.
\nThe media player receives the authenticated URL and requests stream metadata\n and media data normally. When the media player requests data, it calls the\n following actions:
\n\n GetHLSMasterPlaylist: Retrieves an HLS\n master playlist, which contains a URL for the\n GetHLSMediaPlaylist action for each track, and\n additional metadata for the media player, including estimated bitrate\n and resolution.
\n GetHLSMediaPlaylist: Retrieves an HLS\n media playlist, which contains a URL to access the MP4 initialization\n fragment with the GetMP4InitFragment action, and URLs to\n access the MP4 media fragments with the GetMP4MediaFragment\n actions. The HLS media playlist also contains metadata about the stream\n that the player needs to play it, such as whether the\n PlaybackMode is LIVE or\n ON_DEMAND. The HLS media playlist is typically static\n for sessions with a PlaybackType of ON_DEMAND.\n The HLS media playlist is continually updated with new fragments for\n sessions with a PlaybackType of LIVE. There is\n a distinct HLS media playlist for the video track and the audio track\n (if applicable) that contains MP4 media URLs for the specific track.\n
\n GetMP4InitFragment: Retrieves the MP4\n initialization fragment. The media player typically loads the\n initialization fragment before loading any media fragments. This\n fragment contains the \"fytp\" and \"moov\" MP4\n atoms, and the child atoms that are needed to initialize the media\n player decoder.
The initialization fragment does not correspond to a fragment in a\n Kinesis video stream. It contains only the codec private data for the\n stream and respective track, which the media player needs to decode the\n media frames.
\n\n GetMP4MediaFragment: Retrieves MP4\n media fragments. These fragments contain the \"moof\" and\n \"mdat\" MP4 atoms and their child atoms, containing the\n encoded fragment's media frames and their timestamps.
After the first media fragment is made available in a streaming\n session, any fragments that don't contain the same codec private\n data cause an error to be returned when those different media\n fragments are loaded. Therefore, the codec private data should not\n change between fragments in a session. This also means that the\n session fails if the fragments in a stream change from having only\n video to having both audio and video.
\nData retrieved with this action is billable. See Pricing for details.
\n\n GetTSFragment: Retrieves MPEG TS\n fragments containing both initialization and media data for all tracks\n in the stream.
\nIf the ContainerFormat is MPEG_TS, this\n API is used instead of GetMP4InitFragment and\n GetMP4MediaFragment to retrieve stream\n media.
Data retrieved with this action is billable. For more information, see\n Kinesis Video Streams pricing.
\nA streaming session URL must not be shared between players. The service\n might throttle a session if multiple media players are sharing it. For\n connection limits, see Kinesis Video Streams Limits.
\nYou can monitor the amount of data that the media player consumes by monitoring the\n GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For\n information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video\n Streams Pricing and AWS\n Pricing. Charges for both HLS sessions and outgoing AWS data apply.
For more information about HLS, see HTTP Live Streaming on the\n Apple Developer site.
\n\nIf an error is thrown after invoking a Kinesis Video Streams archived media API,\n in addition to the HTTP status code and the response body, it includes the following\n pieces of information:
\n\n x-amz-ErrorType HTTP header – contains a more specific error\n type in addition to what the HTTP status code provides.
\n x-amz-RequestId HTTP header – if you want to report an issue to\n AWS, the support team can better diagnose the problem if given the Request\n Id.
Both the HTTP status code and the ErrorType header can be utilized to make\n programmatic decisions about whether errors are retry-able and under what\n conditions, as well as provide information on what actions the client programmer\n might need to take in order to successfully try again.
\nFor more information, see the Errors section at\n the bottom of this topic, as well as Common Errors.\n
\nRetrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL\n in a browser or media player to view the stream contents.
\nBoth the StreamName and the StreamARN parameters are\n optional, but you must specify either the StreamName or the\n StreamARN when invoking this API operation.
An Amazon Kinesis video stream has the following requirements for providing data\n through HLS:
\nFor streaming video, the media must contain H.264 or H.265 encoded video and, optionally, AAC\n encoded audio. Specifically, the codec ID of track 1 should be\n V_MPEG/ISO/AVC (for H.264) or V_MPEG/ISO/HEVC (for\n H.265). Optionally, the codec ID of track 2 should be A_AAC. For audio only streaming, the codec ID of track 1 should be \n A_AAC.
Data retention must be greater than 0.
\nThe video track of each fragment must contain codec private data in the\n Advanced Video Coding (AVC) for H.264 format or HEVC for H.265 format (MPEG-4 specification ISO/IEC\n 14496-15). For information about adapting stream data to a given\n format, see NAL Adaptation Flags.
\nThe audio track (if present) of each fragment must contain codec private data\n in the AAC format (AAC\n specification ISO/IEC 13818-7).
\nKinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form\n (also called fMP4 or CMAF) or the MPEG-2 form (also called TS chunks, which the HLS\n specification also supports). For more information about HLS fragment types, see the\n HLS\n specification.
\nThe following procedure shows how to use HLS with Kinesis Video Streams:
\nGet an endpoint using GetDataEndpoint, specifying\n GET_HLS_STREAMING_SESSION_URL for the APIName\n parameter.
Retrieve the HLS URL using GetHLSStreamingSessionURL. Kinesis\n Video Streams creates an HLS streaming session to be used for accessing content\n in a stream using the HLS protocol. GetHLSStreamingSessionURL\n returns an authenticated URL (that includes an encrypted session token) for the\n session's HLS master playlist (the root resource needed for\n streaming with HLS).
Don't share or store this token where an unauthorized entity could access\n it. The token provides access to the content of the stream. Safeguard the\n token with the same measures that you would use with your Amazon Web Services\n credentials.
\nThe media that is made available through the playlist consists only of the\n requested stream, time range, and format. No other media data (such as frames\n outside the requested window or alternate bitrates) is made available.
\nProvide the URL (containing the encrypted session token) for the HLS master\n playlist to a media player that supports the HLS protocol. Kinesis Video Streams\n makes the HLS media playlist, initialization fragment, and media fragments\n available through the master playlist URL. The initialization fragment contains\n the codec private data for the stream, and other data needed to set up the video\n or audio decoder and renderer. The media fragments contain H.264-encoded video\n frames or AAC-encoded audio samples.
\nThe media player receives the authenticated URL and requests stream metadata\n and media data normally. When the media player requests data, it calls the\n following actions:
\n\n GetHLSMasterPlaylist: Retrieves an HLS\n master playlist, which contains a URL for the\n GetHLSMediaPlaylist action for each track, and\n additional metadata for the media player, including estimated bitrate\n and resolution.
\n GetHLSMediaPlaylist: Retrieves an HLS\n media playlist, which contains a URL to access the MP4 initialization\n fragment with the GetMP4InitFragment action, and URLs to\n access the MP4 media fragments with the GetMP4MediaFragment\n actions. The HLS media playlist also contains metadata about the stream\n that the player needs to play it, such as whether the\n PlaybackMode is LIVE or\n ON_DEMAND. The HLS media playlist is typically static\n for sessions with a PlaybackType of ON_DEMAND.\n The HLS media playlist is continually updated with new fragments for\n sessions with a PlaybackType of LIVE. There is\n a distinct HLS media playlist for the video track and the audio track\n (if applicable) that contains MP4 media URLs for the specific track.\n
\n GetMP4InitFragment: Retrieves the MP4\n initialization fragment. The media player typically loads the\n initialization fragment before loading any media fragments. This\n fragment contains the \"fytp\" and \"moov\" MP4\n atoms, and the child atoms that are needed to initialize the media\n player decoder.
The initialization fragment does not correspond to a fragment in a\n Kinesis video stream. It contains only the codec private data for the\n stream and respective track, which the media player needs to decode the\n media frames.
\n\n GetMP4MediaFragment: Retrieves MP4\n media fragments. These fragments contain the \"moof\" and\n \"mdat\" MP4 atoms and their child atoms, containing the\n encoded fragment's media frames and their timestamps.
For the HLS streaming session, in-track codec private data (CPD)\n changes are supported. After the first media fragment is made\n available in a streaming session, fragments can contain CPD changes\n for each track. Therefore, the fragments in a session can have a\n different resolution, bit rate, or other information in the CPD\n without interrupting playback. However, any change made in the track\n number or track codec format can return an error when those\n different media fragments are loaded. For example, streaming will\n fail if the fragments in the stream change from having only video to\n having both audio and video, or if an AAC audio track is changed to\n an ALAW audio track. For each streaming session, only 500 CPD\n changes are allowed.
\nData retrieved with this action is billable. For information, see\n Pricing.
\n\n GetTSFragment: Retrieves MPEG TS\n fragments containing both initialization and media data for all tracks\n in the stream.
\nIf the ContainerFormat is MPEG_TS, this\n API is used instead of GetMP4InitFragment and\n GetMP4MediaFragment to retrieve stream\n media.
Data retrieved with this action is billable. For more information, see\n Kinesis Video Streams pricing.
\nA streaming session URL must not be shared between players. The service\n might throttle a session if multiple media players are sharing it. For\n connection limits, see Kinesis Video Streams Limits.
\nYou can monitor the amount of data that the media player consumes by monitoring the\n GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For\n information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video\n Streams Pricing and Amazon Web Services\n Pricing. Charges for both HLS sessions and outgoing Amazon Web Services data apply.
For more information about HLS, see HTTP Live Streaming on the\n Apple Developer site.
\nIf an error is thrown after invoking a Kinesis Video Streams archived media API,\n in addition to the HTTP status code and the response body, it includes the following\n pieces of information:
\n\n x-amz-ErrorType HTTP header – contains a more specific error\n type in addition to what the HTTP status code provides.
\n x-amz-RequestId HTTP header – if you want to report an issue to\n Amazon Web Services, the support team can better diagnose the problem if given the Request\n Id.
Both the HTTP status code and the ErrorType header can be utilized to make\n programmatic decisions about whether errors are retry-able and under what\n conditions, as well as provide information on what actions the client programmer\n might need to take in order to successfully try again.
\nFor more information, see the Errors section at\n the bottom of this topic, as well as Common Errors.\n
\nThe name of the stream for which to retrieve the HLS master playlist URL.
\nYou must specify either the StreamName or the\n StreamARN.
The name of the stream for which to retrieve the HLS master playlist URL.
\nYou must specify either the StreamName or the\n StreamARN.
The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master\n playlist URL.
\nYou must specify either the StreamName or the\n StreamARN.
The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master\n playlist URL.
\nYou must specify either the StreamName or the\n StreamARN.
Whether to retrieve live, live replay, or archived, on-demand data.
\nFeatures of the three types of sessions include the following:
\n\n \n LIVE\n : For sessions of this type, the HLS media playlist is continually\n updated with the latest fragments as they become available. We recommend that\n the media player retrieve a new playlist on a one-second interval. When this\n type of session is played in a media player, the user interface typically\n displays a \"live\" notification, with no scrubber control for choosing the\n position in the playback window to display.
In LIVE mode, the newest available fragments are included in\n an HLS media playlist, even if there is a gap between fragments (that is, if\n a fragment is missing). A gap like this might cause a media player to halt\n or cause a jump in playback. In this mode, fragments are not added to the\n HLS media playlist if they are older than the newest fragment in the\n playlist. If the missing fragment becomes available after a subsequent\n fragment is added to the playlist, the older fragment is not added, and the\n gap is not filled.
\n \n LIVE_REPLAY\n : For sessions of this type, the HLS media playlist is updated\n similarly to how it is updated for LIVE mode except that it starts\n by including fragments from a given start time. Instead of fragments being added\n as they are ingested, fragments are added as the duration of the next fragment\n elapses. For example, if the fragments in the session are two seconds long, then\n a new fragment is added to the media playlist every two seconds. This mode is\n useful to be able to start playback from when an event is detected and continue\n live streaming media that has not yet been ingested as of the time of the\n session creation. This mode is also useful to stream previously archived media\n without being limited by the 1,000 fragment limit in the ON_DEMAND\n mode.
\n \n ON_DEMAND\n : For sessions of this type, the HLS media playlist contains all the\n fragments for the session, up to the number that is specified in\n MaxMediaPlaylistFragmentResults. The playlist must be retrieved\n only once for each session. When this type of session is played in a media\n player, the user interface typically displays a scrubber control for choosing\n the position in the playback window to display.
In all playback modes, if FragmentSelectorType is\n PRODUCER_TIMESTAMP, and if there are multiple fragments with the same\n start timestamp, the fragment that has the largest fragment number (that is, the newest\n fragment) is included in the HLS media playlist. The other fragments are not included.\n Fragments that have different timestamps but have overlapping durations are still\n included in the HLS media playlist. This can lead to unexpected behavior in the media\n player.
The default is LIVE.
Whether to retrieve live, live replay, or archived, on-demand data.
\nFeatures of the three types of sessions include the following:
\n\n \n LIVE\n : For sessions of this type, the HLS media playlist is continually\n updated with the latest fragments as they become available. We recommend that\n the media player retrieve a new playlist on a one-second interval. When this\n type of session is played in a media player, the user interface typically\n displays a \"live\" notification, with no scrubber control for choosing the\n position in the playback window to display.
In LIVE mode, the newest available fragments are included in\n an HLS media playlist, even if there is a gap between fragments (that is, if\n a fragment is missing). A gap like this might cause a media player to halt\n or cause a jump in playback. In this mode, fragments are not added to the\n HLS media playlist if they are older than the newest fragment in the\n playlist. If the missing fragment becomes available after a subsequent\n fragment is added to the playlist, the older fragment is not added, and the\n gap is not filled.
\n \n LIVE_REPLAY\n : For sessions of this type, the HLS media playlist is updated\n similarly to how it is updated for LIVE mode except that it starts\n by including fragments from a given start time. Instead of fragments being added\n as they are ingested, fragments are added as the duration of the next fragment\n elapses. For example, if the fragments in the session are two seconds long, then\n a new fragment is added to the media playlist every two seconds. This mode is\n useful to be able to start playback from when an event is detected and continue\n live streaming media that has not yet been ingested as of the time of the\n session creation. This mode is also useful to stream previously archived media\n without being limited by the 1,000 fragment limit in the ON_DEMAND\n mode.
\n \n ON_DEMAND\n : For sessions of this type, the HLS media playlist contains all the\n fragments for the session, up to the number that is specified in\n MaxMediaPlaylistFragmentResults. The playlist must be retrieved\n only once for each session. When this type of session is played in a media\n player, the user interface typically displays a scrubber control for choosing\n the position in the playback window to display.
In all playback modes, if FragmentSelectorType is\n PRODUCER_TIMESTAMP, and if there are multiple fragments with the same\n start timestamp, the fragment that has the largest fragment number (that is, the newest\n fragment) is included in the HLS media playlist. The other fragments are not included.\n Fragments that have different timestamps but have overlapping durations are still\n included in the HLS media playlist. This can lead to unexpected behavior in the media\n player.
The default is LIVE.
The time range of the requested fragment and the source of the timestamps.
\nThis parameter is required if PlaybackMode is ON_DEMAND or\n LIVE_REPLAY. This parameter is optional if PlaybackMode is\n LIVE. If PlaybackMode is LIVE, the\n FragmentSelectorType can be set, but the TimestampRange\n should not be set. If PlaybackMode is ON_DEMAND or\n LIVE_REPLAY, both FragmentSelectorType and\n TimestampRange must be set.
The time range of the requested fragment and the source of the timestamps.
\nThis parameter is required if PlaybackMode is ON_DEMAND or\n LIVE_REPLAY. This parameter is optional if PlaybackMode is\n LIVE. If PlaybackMode is LIVE, the\n FragmentSelectorType can be set, but the TimestampRange\n should not be set. If PlaybackMode is ON_DEMAND or\n LIVE_REPLAY, both FragmentSelectorType and\n TimestampRange must be set.
Specifies which format should be used for packaging the media. Specifying the\n FRAGMENTED_MP4 container format packages the media into MP4 fragments\n (fMP4 or CMAF). This is the recommended packaging because there is minimal packaging\n overhead. The other container format option is MPEG_TS. HLS has supported\n MPEG TS chunks since it was released and is sometimes the only supported packaging on\n older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This means\n MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4.
The default is FRAGMENTED_MP4.
Specifies which format should be used for packaging the media. Specifying the\n FRAGMENTED_MP4 container format packages the media into MP4 fragments\n (fMP4 or CMAF). This is the recommended packaging because there is minimal packaging\n overhead. The other container format option is MPEG_TS. HLS has supported\n MPEG TS chunks since it was released and is sometimes the only supported packaging on\n older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This means\n MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4.
The default is FRAGMENTED_MP4.
Specifies when flags marking discontinuities between fragments are added to the media\n playlists.
\nMedia players typically build a timeline of media content to play, based on the\n timestamps of each fragment. This means that if there is any overlap or gap between\n fragments (as is typical if HLSFragmentSelector is set to\n SERVER_TIMESTAMP), the media player timeline will also have small gaps\n between fragments in some places, and will overwrite frames in other places. Gaps in the\n media player timeline can cause playback to stall and overlaps can cause playback to be\n jittery. When there are discontinuity flags between fragments, the media player is\n expected to reset the timeline, resulting in the next fragment being played immediately\n after the previous fragment.
The following modes are supported:
\n\n ALWAYS: a discontinuity marker is placed between every fragment in\n the HLS media playlist. It is recommended to use a value of ALWAYS\n if the fragment timestamps are not accurate.
\n NEVER: no discontinuity markers are placed anywhere. It is\n recommended to use a value of NEVER to ensure the media player\n timeline most accurately maps to the producer timestamps.
\n ON_DISCONTINUITY: a discontinuity marker is placed between\n fragments that have a gap or overlap of more than 50 milliseconds. For most\n playback scenarios, it is recommended to use a value of\n ON_DISCONTINUITY so that the media player timeline is only\n reset when there is a significant issue with the media timeline (e.g. a missing\n fragment).
The default is ALWAYS when HLSFragmentSelector is set\n to SERVER_TIMESTAMP, and NEVER when it is set to\n PRODUCER_TIMESTAMP.
Specifies when flags marking discontinuities between fragments are added to the media\n playlists.
\nMedia players typically build a timeline of media content to play, based on the\n timestamps of each fragment. This means that if there is any overlap or gap between\n fragments (as is typical if HLSFragmentSelector is set to\n SERVER_TIMESTAMP), the media player timeline will also have small gaps\n between fragments in some places, and will overwrite frames in other places. Gaps in the\n media player timeline can cause playback to stall and overlaps can cause playback to be\n jittery. When there are discontinuity flags between fragments, the media player is\n expected to reset the timeline, resulting in the next fragment being played immediately\n after the previous fragment.
The following modes are supported:
\n\n ALWAYS: a discontinuity marker is placed between every fragment in\n the HLS media playlist. It is recommended to use a value of ALWAYS\n if the fragment timestamps are not accurate.
\n NEVER: no discontinuity markers are placed anywhere. It is\n recommended to use a value of NEVER to ensure the media player\n timeline most accurately maps to the producer timestamps.
\n ON_DISCONTINUITY: a discontinuity marker is placed between\n fragments that have a gap or overlap of more than 50 milliseconds. For most\n playback scenarios, it is recommended to use a value of\n ON_DISCONTINUITY so that the media player timeline is only\n reset when there is a significant issue with the media timeline (e.g. a missing\n fragment).
The default is ALWAYS when HLSFragmentSelector is set\n to SERVER_TIMESTAMP, and NEVER when it is set to\n PRODUCER_TIMESTAMP.
Specifies when the fragment start timestamps should be included in the HLS media\n playlist. Typically, media players report the playhead position as a time relative to\n the start of the first fragment in the playback session. However, when the start\n timestamps are included in the HLS media playlist, some media players might report the\n current playhead as an absolute time based on the fragment timestamps. This can be\n useful for creating a playback experience that shows viewers the wall-clock time of the\n media.
\nThe default is NEVER. When HLSFragmentSelector is\n SERVER_TIMESTAMP, the timestamps will be the server start timestamps.\n Similarly, when HLSFragmentSelector is\n PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.\n
Specifies when the fragment start timestamps should be included in the HLS media\n playlist. Typically, media players report the playhead position as a time relative to\n the start of the first fragment in the playback session. However, when the start\n timestamps are included in the HLS media playlist, some media players might report the\n current playhead as an absolute time based on the fragment timestamps. This can be\n useful for creating a playback experience that shows viewers the wall-clock time of the\n media.
\nThe default is NEVER. When HLSFragmentSelector is\n SERVER_TIMESTAMP, the timestamps will be the server start timestamps.\n Similarly, when HLSFragmentSelector is\n PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.\n
The time in seconds until the requested session expires. This value can be between 300\n (5 minutes) and 43200 (12 hours).
\nWhen a session expires, no new calls to GetHLSMasterPlaylist,\n GetHLSMediaPlaylist, GetMP4InitFragment,\n GetMP4MediaFragment, or GetTSFragment can be made for that\n session.
The default is 300 (5 minutes).
" + "smithy.api#documentation": "The time in seconds until the requested session expires. This value can be between 300\n (5 minutes) and 43200 (12 hours).
\nWhen a session expires, no new calls to GetHLSMasterPlaylist,\n GetHLSMediaPlaylist, GetMP4InitFragment,\n GetMP4MediaFragment, or GetTSFragment can be made for that\n session.
The default is 300 (5 minutes).
" } }, "MaxMediaPlaylistFragmentResults": { "target": "com.amazonaws.kinesisvideoarchivedmedia#HLSMaxResults", "traits": { - "smithy.api#documentation": "The maximum number of fragments that are returned in the HLS media playlists.
\nWhen the PlaybackMode is LIVE, the most recent fragments are\n returned up to this value. When the PlaybackMode is ON_DEMAND,\n the oldest fragments are returned, up to this maximum number.
When there are a higher number of fragments available in a live HLS media playlist,\n video players often buffer content before starting playback. Increasing the buffer size\n increases the playback latency, but it decreases the likelihood that rebuffering will\n occur during playback. We recommend that a live HLS media playlist have a minimum of 3\n fragments and a maximum of 10 fragments.
\nThe default is 5 fragments if PlaybackMode is LIVE or\n LIVE_REPLAY, and 1,000 if PlaybackMode is\n ON_DEMAND.
The maximum value of 5,000 fragments corresponds to more than 80 minutes of video on\n streams with 1-second fragments, and more than 13 hours of video on streams with\n 10-second fragments.
" + "smithy.api#documentation": "The maximum number of fragments that are returned in the HLS media playlists.
\nWhen the PlaybackMode is LIVE, the most recent fragments are\n returned up to this value. When the PlaybackMode is ON_DEMAND,\n the oldest fragments are returned, up to this maximum number.
When there are a higher number of fragments available in a live HLS media playlist,\n video players often buffer content before starting playback. Increasing the buffer size\n increases the playback latency, but it decreases the likelihood that rebuffering will\n occur during playback. We recommend that a live HLS media playlist have a minimum of 3\n fragments and a maximum of 10 fragments.
\nThe default is 5 fragments if PlaybackMode is LIVE or\n LIVE_REPLAY, and 1,000 if PlaybackMode is\n ON_DEMAND.
The maximum value of 5,000 fragments corresponds to more than 80 minutes of video on\n streams with 1-second fragments, and more than 13 hours of video on streams with\n 10-second fragments.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideoarchivedmedia#GetHLSStreamingSessionURLOutput": { @@ -1616,6 +1649,9 @@ "smithy.api#documentation": "The URL (containing the session token) that a media player can use to retrieve the HLS\n master playlist.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideoarchivedmedia#GetImages": { @@ -1681,15 +1717,14 @@ "EndTimestamp": { "target": "com.amazonaws.kinesisvideoarchivedmedia#Timestamp", "traits": { - "smithy.api#documentation": "The end timestamp for the range of images to be generated.
", + "smithy.api#documentation": "The end timestamp for the range of images to be generated. If the time range between StartTimestamp and EndTimestamp is more than 300 seconds above StartTimestamp, you will receive an IllegalArgumentException.
The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 3000 ms. If the timestamp range is less than the sampling interval, the Image from the startTimestamp will be returned if available.\n
The minimum value of 3000 ms is a soft limit. If needed, a lower sampling frequency can be requested.
\nThe time interval in milliseconds (ms) at which the images need to be generated from\n the stream, with a default of 3000 ms. The minimum value that can be provided is 200 ms.\n If the timestamp range is less than the sampling interval, the Image from the\n startTimestamp will be returned if available.
The minimum value of 200 ms is a hard limit.
\nThe maximum number of images to be returned by the API.
\nThe default limit is 100 images per API response. The additional results will be paginated.
\nThe maximum number of images to be returned by the API.
\nThe default limit is 25 images per API response. Providing a MaxResults greater than this value will result in a page size of 25. Any additional results will be paginated.
A token that specifies where to start paginating the next set of Images. This is the GetImages:NextToken from a previously truncated response.
The encrypted token that was used in the request to get more images.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideoarchivedmedia#GetMediaForFragmentList": { @@ -1780,7 +1821,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets media for a list of fragments (specified by fragment number) from the archived\n data in an Amazon Kinesis video stream.
\n\nYou must first call the GetDataEndpoint API to get an endpoint.\n Then send the GetMediaForFragmentList requests to this endpoint using\n the --endpoint-url\n parameter.
For limits, see Kinesis Video Streams Limits.
\n\nIf an error is thrown after invoking a Kinesis Video Streams archived media API,\n in addition to the HTTP status code and the response body, it includes the following\n pieces of information:
\n\n x-amz-ErrorType HTTP header – contains a more specific error\n type in addition to what the HTTP status code provides.
\n x-amz-RequestId HTTP header – if you want to report an issue to\n AWS, the support team can better diagnose the problem if given the Request\n Id.
Both the HTTP status code and the ErrorType header can be utilized to make\n programmatic decisions about whether errors are retry-able and under what\n conditions, as well as provide information on what actions the client programmer\n might need to take in order to successfully try again.
\nFor more information, see the Errors section at\n the bottom of this topic, as well as Common Errors.\n
\nGets media for a list of fragments (specified by fragment number) from the archived\n data in an Amazon Kinesis video stream.
\nYou must first call the GetDataEndpoint API to get an endpoint.\n Then send the GetMediaForFragmentList requests to this endpoint using\n the --endpoint-url\n parameter.
For limits, see Kinesis Video Streams Limits.
\nIf an error is thrown after invoking a Kinesis Video Streams archived media API,\n in addition to the HTTP status code and the response body, it includes the following\n pieces of information:
\n\n x-amz-ErrorType HTTP header – contains a more specific error\n type in addition to what the HTTP status code provides.
\n x-amz-RequestId HTTP header – if you want to report an issue to\n Amazon Web Services, the support team can better diagnose the problem if given the Request\n Id.
Both the HTTP status code and the ErrorType header can be utilized to make\n programmatic decisions about whether errors are retry-able and under what\n conditions, as well as provide information on what actions the client programmer\n might need to take in order to successfully try again.
\nFor more information, see the Errors section at\n the bottom of this topic, as well as Common Errors.\n
\nThe payload that Kinesis Video Streams returns is a sequence of chunks from the\n specified stream. For information about the chunks, see PutMedia. The chunks that Kinesis Video Streams returns in the\n GetMediaForFragmentList call also include the following additional\n Matroska (MKV) tags:
AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the\n chunk.
\nAWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side timestamp of the\n fragment.
\nAWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp of the\n fragment.
\nThe following tags will be included if an exception occurs:
\nAWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the\n exception
\nAWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the\n exception
\nAWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the\n exception
\nThe payload that Kinesis Video Streams returns is a sequence of chunks from the\n specified stream. For information about the chunks, see PutMedia. The chunks that Kinesis Video Streams returns in the\n GetMediaForFragmentList call also include the following additional\n Matroska (MKV) tags:
AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the\n chunk.
\nAWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side timestamp of the\n fragment.
\nAWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp of the\n fragment.
\nThe following tags will be included if an exception occurs:
\nAWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the exception\n
\nAWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the\n
\nAWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception\n
\nThe source of the timestamps for the requested media.
\nWhen FragmentSelectorType is set to PRODUCER_TIMESTAMP and\n GetHLSStreamingSessionURLInput$PlaybackMode is\n ON_DEMAND or LIVE_REPLAY, the first fragment ingested with\n a producer timestamp within the specified FragmentSelector$TimestampRange is included in the media playlist. In\n addition, the fragments with producer timestamps within the TimestampRange\n ingested immediately following the first fragment (up to the GetHLSStreamingSessionURLInput$MaxMediaPlaylistFragmentResults value)\n are included.
Fragments that have duplicate producer timestamps are deduplicated. This means that if\n producers are producing a stream of fragments with producer timestamps that are\n approximately equal to the true clock time, the HLS media playlists will contain all of\n the fragments within the requested timestamp range. If some fragments are ingested\n within the same time range and very different points in time, only the oldest ingested\n collection of fragments are returned.
\nWhen FragmentSelectorType is set to PRODUCER_TIMESTAMP and\n GetHLSStreamingSessionURLInput$PlaybackMode is LIVE,\n the producer timestamps are used in the MP4 fragments and for deduplication. But the\n most recently ingested fragments based on server timestamps are included in the HLS\n media playlist. This means that even if fragments ingested in the past have producer\n timestamps with values now, they are not included in the HLS media playlist.
The default is SERVER_TIMESTAMP.
The source of the timestamps for the requested media.
\nWhen FragmentSelectorType is set to PRODUCER_TIMESTAMP and\n GetHLSStreamingSessionURLInput$PlaybackMode is\n ON_DEMAND or LIVE_REPLAY, the first fragment ingested with\n a producer timestamp within the specified FragmentSelector$TimestampRange is included in the media playlist. In\n addition, the fragments with producer timestamps within the TimestampRange\n ingested immediately following the first fragment (up to the GetHLSStreamingSessionURLInput$MaxMediaPlaylistFragmentResults value)\n are included.
Fragments that have duplicate producer timestamps are deduplicated. This means that if\n producers are producing a stream of fragments with producer timestamps that are\n approximately equal to the true clock time, the HLS media playlists will contain all of\n the fragments within the requested timestamp range. If some fragments are ingested\n within the same time range and very different points in time, only the oldest ingested\n collection of fragments are returned.
\nWhen FragmentSelectorType is set to PRODUCER_TIMESTAMP and\n GetHLSStreamingSessionURLInput$PlaybackMode is LIVE,\n the producer timestamps are used in the MP4 fragments and for deduplication. But the\n most recently ingested fragments based on server timestamps are included in the HLS\n media playlist. This means that even if fragments ingested in the past have producer\n timestamps with values now, they are not included in the HLS media playlist.
The default is SERVER_TIMESTAMP.
The start and end of the timestamp range for the requested media.
\nThis value should not be present if PlaybackType is\n LIVE.
The start and end of the timestamp range for the requested media.
\nThis value should not be present if PlaybackType is\n LIVE.
The start of the timestamp range for the requested media.
\nIf the HLSTimestampRange value is specified, the\n StartTimestamp value is required.
Only fragments that start exactly at or after StartTimestamp are included\n in the session. Fragments that start before StartTimestamp and continue\n past it aren't included in the session. If FragmentSelectorType is\n SERVER_TIMESTAMP, the StartTimestamp must be later than\n the stream head.
The start of the timestamp range for the requested media.
\nIf the HLSTimestampRange value is specified, the\n StartTimestamp value is required.
Only fragments that start exactly at or after StartTimestamp are included\n in the session. Fragments that start before StartTimestamp and continue\n past it aren't included in the session. If FragmentSelectorType is\n SERVER_TIMESTAMP, the StartTimestamp must be later than\n the stream head.
The end of the timestamp range for the requested media. This value must be within 24\n hours of the specified StartTimestamp, and it must be later than the\n StartTimestamp value.
If FragmentSelectorType for the request is SERVER_TIMESTAMP,\n this value must be in the past.
The EndTimestamp value is required for ON_DEMAND mode, but\n optional for LIVE_REPLAY mode. If the EndTimestamp is not set\n for LIVE_REPLAY mode then the session will continue to include newly\n ingested fragments until the session expires.
This value is inclusive. The EndTimestamp is compared to the\n (starting) timestamp of the fragment. Fragments that start before the\n EndTimestamp value and continue past it are included in the\n session.
The end of the timestamp range for the requested media. This value must be within 24\n hours of the specified StartTimestamp, and it must be later than the\n StartTimestamp value.
If FragmentSelectorType for the request is SERVER_TIMESTAMP,\n this value must be in the past.
The EndTimestamp value is required for ON_DEMAND mode, but\n optional for LIVE_REPLAY mode. If the EndTimestamp is not set\n for LIVE_REPLAY mode then the session will continue to include newly\n ingested fragments until the session expires.
This value is inclusive. The EndTimestamp is compared to the\n (starting) timestamp of the fragment. Fragments that start before the\n EndTimestamp value and continue past it are included in the\n session.
The start and end of the timestamp range for the requested media.
\nThis value should not be present if PlaybackType is\n LIVE.
The start and end of the timestamp range for the requested media.
\nThis value should not be present if PlaybackType is\n LIVE.
The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:
\nThere is no media that exists for the specified Timestamp.
The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect\n media has been ingested.
\nThe error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:
\nThere is no media that exists for the specified Timestamp.
The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect\n media has been ingested.
\nReturns a list of Fragment objects from the specified stream and\n timestamp range within the archived data.
\nListing fragments is eventually consistent. This means that even if the producer\n receives an acknowledgment that a fragment is persisted, the result might not be\n returned immediately from a request to ListFragments. However, results are\n typically available in less than one second.
You must first call the GetDataEndpoint API to get an endpoint.\n Then send the ListFragments requests to this endpoint using the --endpoint-url\n parameter.
If an error is thrown after invoking a Kinesis Video Streams archived media API,\n in addition to the HTTP status code and the response body, it includes the following\n pieces of information:
\n\n x-amz-ErrorType HTTP header – contains a more specific error\n type in addition to what the HTTP status code provides.
\n x-amz-RequestId HTTP header – if you want to report an issue to\n AWS, the support team can better diagnose the problem if given the Request\n Id.
Both the HTTP status code and the ErrorType header can be utilized to make\n programmatic decisions about whether errors are retry-able and under what\n conditions, as well as provide information on what actions the client programmer\n might need to take in order to successfully try again.
\nFor more information, see the Errors section at\n the bottom of this topic, as well as Common Errors.\n
\nReturns a list of Fragment objects from the specified stream and\n timestamp range within the archived data.
\nListing fragments is eventually consistent. This means that even if the producer\n receives an acknowledgment that a fragment is persisted, the result might not be\n returned immediately from a request to ListFragments. However, results are\n typically available in less than one second.
You must first call the GetDataEndpoint API to get an endpoint.\n Then send the ListFragments requests to this endpoint using the --endpoint-url\n parameter.
If an error is thrown after invoking a Kinesis Video Streams archived media API,\n in addition to the HTTP status code and the response body, it includes the following\n pieces of information:
\n\n x-amz-ErrorType HTTP header – contains a more specific error\n type in addition to what the HTTP status code provides.
\n x-amz-RequestId HTTP header – if you want to report an issue to\n Amazon Web Services, the support team can better diagnose the problem if given the Request\n Id.
Both the HTTP status code and the ErrorType header can be utilized to make\n programmatic decisions about whether errors are retry-able and under what\n conditions, as well as provide information on what actions the client programmer\n might need to take in order to successfully try again.
\nFor more information, see the Errors section at\n the bottom of this topic, as well as Common Errors.\n
\nDescribes the timestamp range and timestamp origin for the range of fragments to\n return.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideoarchivedmedia#ListFragmentsMaxResults": { @@ -2161,6 +2227,9 @@ "smithy.api#documentation": "If the returned list is truncated, the operation returns this token to use to retrieve\n the next page of results. This value is null when there are no more results\n to return.
\n GetMedia throws this error when Kinesis Video Streams can't find the stream\n that you specified.
\n GetHLSStreamingSessionURL and GetDASHStreamingSessionURL throw\n this error if a session with a PlaybackMode of ON_DEMAND or\n LIVE_REPLAYis requested for a stream that has no fragments within the\n requested time range, or if a session with a PlaybackMode of\n LIVE is requested for a stream that has no fragments within the last 30\n seconds.
\n GetImages will throw this error when Kinesis Video Streams can't find the stream\n that you specified.
\n GetHLSStreamingSessionURL and GetDASHStreamingSessionURL throw\n this error if a session with a PlaybackMode of ON_DEMAND or\n LIVE_REPLAYis requested for a stream that has no fragments within the\n requested time range, or if a session with a PlaybackMode of\n LIVE is requested for a stream that has no fragments within the last 30\n seconds.
Associates a SignalingChannel to a stream to store the media. There are two signaling modes that \n can specified :
If the StorageStatus is disabled, no data will be stored,\n and the StreamARN parameter will not be needed.
If the StorageStatus is enabled, the data will be stored in the \n StreamARN provided.
Associates a SignalingChannel to a stream to store the media. There are two signaling modes that \n can specified :
If the StorageStatus is disabled, no data will be stored,\n and the StreamARN parameter will not be needed.
If the StorageStatus is enabled, the data will be stored in the \n StreamARN provided.
If StorageStatus is enabled, direct peer-to-peer (master-viewer) connections no\n longer occur. Peers connect directly to the storage session. You must call the\n JoinStorageSession API to trigger an SDP offer send and establish a\n connection between a peer and the storage session.
\nAccepts a share for an analytics store. \n
", + "smithy.api#endpoint": { + "hostPrefix": "analytics-" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/share/{shareId}", + "code": 200 + } + } + }, + "com.amazonaws.omics#AcceptShareRequest": { + "type": "structure", + "members": { + "shareId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\nThe ID for a share offer for analytics store data. \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#AcceptShareResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.omics#ShareStatus", + "traits": { + "smithy.api#documentation": "\nThe status of an analytics store share. \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.omics#AccessDeniedException": { "type": "structure", "members": { @@ -348,6 +421,13 @@ "smithy.api#required": {} } }, + "versionName": { + "target": "com.amazonaws.omics#VersionName", + "traits": { + "smithy.api#documentation": "\nThe name of the annotation store version. \n
", + "smithy.api#required": {} + } + }, "roleArn": { "target": "com.amazonaws.omics#Arn", "traits": { @@ -475,7 +555,7 @@ } }, "description": { - "target": "com.amazonaws.omics#StoreDescription", + "target": "com.amazonaws.omics#Description", "traits": { "smithy.api#documentation": "The store's description.
", "smithy.api#required": {} @@ -527,6 +607,125 @@ "target": "com.amazonaws.omics#AnnotationStoreItem" } }, + "com.amazonaws.omics#AnnotationStoreVersion": { + "type": "resource", + "identifiers": { + "name": { + "target": "smithy.api#String" + }, + "versionName": { + "target": "smithy.api#String" + } + }, + "create": { + "target": "com.amazonaws.omics#CreateAnnotationStoreVersion" + }, + "read": { + "target": "com.amazonaws.omics#GetAnnotationStoreVersion" + }, + "update": { + "target": "com.amazonaws.omics#UpdateAnnotationStoreVersion" + }, + "list": { + "target": "com.amazonaws.omics#ListAnnotationStoreVersions" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.omics#DeleteAnnotationStoreVersions" + } + ] + }, + "com.amazonaws.omics#AnnotationStoreVersionItem": { + "type": "structure", + "members": { + "storeId": { + "target": "com.amazonaws.omics#ResourceId", + "traits": { + "smithy.api#documentation": "\nThe store ID for an annotation store version. \n
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.omics#ResourceId", + "traits": { + "smithy.api#documentation": "\nThe annotation store version ID. \n
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.omics#VersionStatus", + "traits": { + "smithy.api#documentation": "\nThe status of an annotation store version. \n
", + "smithy.api#required": {} + } + }, + "versionArn": { + "target": "com.amazonaws.omics#Arn", + "traits": { + "smithy.api#documentation": "\nThe Arn for an annotation store version. \n
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.omics#StoreName", + "traits": { + "smithy.api#documentation": "\nA name given to an annotation store version to distinguish it from others. \n
", + "smithy.api#required": {} + } + }, + "versionName": { + "target": "com.amazonaws.omics#VersionName", + "traits": { + "smithy.api#documentation": "\nThe name of an annotation store version.\n
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.omics#Description", + "traits": { + "smithy.api#documentation": "\nThe description of an annotation store version. \n
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.omics#CreationTime", + "traits": { + "smithy.api#documentation": "\nThe time stamp for when an annotation store version was created. \n
", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "com.amazonaws.omics#UpdateTime", + "traits": { + "smithy.api#documentation": "\nThe time stamp for when an annotation store version was updated. \n
", + "smithy.api#required": {} + } + }, + "statusMessage": { + "target": "com.amazonaws.omics#StatusMessage", + "traits": { + "smithy.api#documentation": "\nThe status of an annotation store version.\n
", + "smithy.api#required": {} + } + }, + "versionSizeBytes": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "\nThe size of an annotation store version in Bytes. \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\nAnnotation store versions.\n
" + } + }, + "com.amazonaws.omics#AnnotationStoreVersionItems": { + "type": "list", + "member": { + "target": "com.amazonaws.omics#AnnotationStoreVersionItem" + } + }, "com.amazonaws.omics#AnnotationType": { "type": "string", "traits": { @@ -579,6 +778,19 @@ "smithy.api#pattern": "^arn:([^:\n]*):([^:\n]*):([^:\n]*):([0-9]{12}):([^:\n]*)$" } }, + "com.amazonaws.omics#ArnList": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#uniqueItems": {} + } + }, "com.amazonaws.omics#BatchDeleteReadSet": { "type": "operation", "input": { @@ -1064,14 +1276,13 @@ } }, "name": { - "target": "smithy.api#String", + "target": "com.amazonaws.omics#StoreName", "traits": { - "smithy.api#documentation": "A name for the store.
", - "smithy.api#pattern": "^([a-z]){1}([a-z0-9_]){2,254}$" + "smithy.api#documentation": "A name for the store.
" } }, "description": { - "target": "com.amazonaws.omics#StoreDescription", + "target": "com.amazonaws.omics#Description", "traits": { "smithy.api#documentation": "A description for the store.
" } @@ -1082,6 +1293,12 @@ "smithy.api#documentation": "Tags for the store.
" } }, + "versionName": { + "target": "com.amazonaws.omics#VersionName", + "traits": { + "smithy.api#documentation": "\nThe name given to an annotation store version to distinguish it from other versions. \n
" + } + }, "sseConfig": { "target": "com.amazonaws.omics#SseConfig", "traits": { @@ -1148,6 +1365,13 @@ "smithy.api#required": {} } }, + "versionName": { + "target": "com.amazonaws.omics#VersionName", + "traits": { + "smithy.api#documentation": "\nThe name given to an annotation store version to distinguish it from other versions. \n
", + "smithy.api#required": {} + } + }, "creationTime": { "target": "com.amazonaws.omics#CreationTime", "traits": { @@ -1160,26 +1384,23 @@ "smithy.api#output": {} } }, - "com.amazonaws.omics#CreateMultipartReadSetUpload": { + "com.amazonaws.omics#CreateAnnotationStoreVersion": { "type": "operation", "input": { - "target": "com.amazonaws.omics#CreateMultipartReadSetUploadRequest" + "target": "com.amazonaws.omics#CreateAnnotationStoreVersionRequest" }, "output": { - "target": "com.amazonaws.omics#CreateMultipartReadSetUploadResponse" + "target": "com.amazonaws.omics#CreateAnnotationStoreVersionResponse" }, "errors": [ { "target": "com.amazonaws.omics#AccessDeniedException" }, { - "target": "com.amazonaws.omics#InternalServerException" - }, - { - "target": "com.amazonaws.omics#NotSupportedOperationException" + "target": "com.amazonaws.omics#ConflictException" }, { - "target": "com.amazonaws.omics#RequestTimeoutException" + "target": "com.amazonaws.omics#InternalServerException" }, { "target": "com.amazonaws.omics#ResourceNotFoundException" @@ -1195,84 +1416,51 @@ } ], "traits": { - "smithy.api#documentation": "\n Begins a multipart read set upload. \n
", + "smithy.api#documentation": "\nCreates a new version of an annotation store. \n
", "smithy.api#endpoint": { - "hostPrefix": "control-storage-" + "hostPrefix": "analytics-" }, "smithy.api#http": { "method": "POST", - "uri": "/sequencestore/{sequenceStoreId}/upload" + "uri": "/annotationStore/{name}/version", + "code": 200 } } }, - "com.amazonaws.omics#CreateMultipartReadSetUploadRequest": { + "com.amazonaws.omics#CreateAnnotationStoreVersionRequest": { "type": "structure", "members": { - "sequenceStoreId": { - "target": "com.amazonaws.omics#SequenceStoreId", + "name": { + "target": "com.amazonaws.omics#StoreName", "traits": { - "smithy.api#documentation": "\n The sequence store ID for the store that is the destination of the multipart uploads.\n
", + "smithy.api#documentation": "\nThe name of an annotation store version from which versions are being created. \n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "clientToken": { - "target": "com.amazonaws.omics#ClientToken", - "traits": { - "smithy.api#documentation": "\n An idempotency token that can be used to avoid triggering multiple multipart uploads.\n
" - } - }, - "sourceFileType": { - "target": "com.amazonaws.omics#FileType", - "traits": { - "smithy.api#documentation": "\n The type of file being uploaded.\n
", - "smithy.api#required": {} - } - }, - "subjectId": { - "target": "com.amazonaws.omics#SubjectId", - "traits": { - "smithy.api#documentation": "\n The source's subject ID.\n
", - "smithy.api#required": {} - } - }, - "sampleId": { - "target": "com.amazonaws.omics#SampleId", - "traits": { - "smithy.api#documentation": "\n The source's sample ID.\n
", - "smithy.api#required": {} - } - }, - "generatedFrom": { - "target": "com.amazonaws.omics#GeneratedFrom", - "traits": { - "smithy.api#documentation": "\n Where the source originated.\n
" - } - }, - "referenceArn": { - "target": "com.amazonaws.omics#ReferenceArn", + "versionName": { + "target": "com.amazonaws.omics#VersionName", "traits": { - "smithy.api#documentation": "\n The ARN of the reference.\n
", + "smithy.api#documentation": "\nThe name given to an annotation store version to distinguish it from other versions. \n
", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.omics#ReadSetName", + "description": { + "target": "com.amazonaws.omics#Description", "traits": { - "smithy.api#documentation": "\n The name of the read set.\n
", - "smithy.api#required": {} + "smithy.api#documentation": "\nThe description of an annotation store version. \n
" } }, - "description": { - "target": "com.amazonaws.omics#ReadSetDescription", + "versionOptions": { + "target": "com.amazonaws.omics#VersionOptions", "traits": { - "smithy.api#documentation": "\n The description of the read set.\n
" + "smithy.api#documentation": "\nThe options for an annotation store version. \n
" } }, "tags": { "target": "com.amazonaws.omics#TagMap", "traits": { - "smithy.api#documentation": "\n Any tags to add to the read set.\n
" + "smithy.api#documentation": "\nAny tags added to annotation store version. \n
" } } }, @@ -1280,34 +1468,210 @@ "smithy.api#input": {} } }, - "com.amazonaws.omics#CreateMultipartReadSetUploadResponse": { + "com.amazonaws.omics#CreateAnnotationStoreVersionResponse": { "type": "structure", "members": { - "sequenceStoreId": { - "target": "com.amazonaws.omics#SequenceStoreId", + "id": { + "target": "com.amazonaws.omics#ResourceId", "traits": { - "smithy.api#documentation": "\n The sequence store ID for the store that the read set will be created in.\n
", + "smithy.api#documentation": "\nA generated ID for the annotation store \n
", "smithy.api#required": {} } }, - "uploadId": { - "target": "com.amazonaws.omics#UploadId", + "versionName": { + "target": "com.amazonaws.omics#VersionName", "traits": { - "smithy.api#documentation": "\n he ID for the initiated multipart upload.\n
", + "smithy.api#documentation": "\nThe name given to an annotation store version to distinguish it from other versions. \n
", "smithy.api#required": {} } }, - "sourceFileType": { - "target": "com.amazonaws.omics#FileType", + "storeId": { + "target": "com.amazonaws.omics#ResourceId", "traits": { - "smithy.api#documentation": "\n The file type of the read set source.\n
", + "smithy.api#documentation": "\nThe ID for the annotation store from which new versions are being created. \n
", "smithy.api#required": {} } }, - "subjectId": { - "target": "com.amazonaws.omics#SubjectId", + "versionOptions": { + "target": "com.amazonaws.omics#VersionOptions", "traits": { - "smithy.api#documentation": "\n The source's subject ID.\n
", + "smithy.api#documentation": "\nThe options for an annotation store version. \n
" + } + }, + "name": { + "target": "com.amazonaws.omics#StoreName", + "traits": { + "smithy.api#documentation": "\nThe name given to an annotation store version to distinguish it from other versions. \n
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.omics#VersionStatus", + "traits": { + "smithy.api#documentation": "\nThe status of a annotation store version. \n
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.omics#CreationTime", + "traits": { + "smithy.api#documentation": "\nThe time stamp for the creation of an annotation store version. \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.omics#CreateMultipartReadSetUpload": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#CreateMultipartReadSetUploadRequest" + }, + "output": { + "target": "com.amazonaws.omics#CreateMultipartReadSetUploadResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#NotSupportedOperationException" + }, + { + "target": "com.amazonaws.omics#RequestTimeoutException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Begins a multipart read set upload. \n
", + "smithy.api#endpoint": { + "hostPrefix": "control-storage-" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/sequencestore/{sequenceStoreId}/upload" + } + } + }, + "com.amazonaws.omics#CreateMultipartReadSetUploadRequest": { + "type": "structure", + "members": { + "sequenceStoreId": { + "target": "com.amazonaws.omics#SequenceStoreId", + "traits": { + "smithy.api#documentation": "\n The sequence store ID for the store that is the destination of the multipart uploads.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.omics#ClientToken", + "traits": { + "smithy.api#documentation": "\n An idempotency token that can be used to avoid triggering multiple multipart uploads.\n
" + } + }, + "sourceFileType": { + "target": "com.amazonaws.omics#FileType", + "traits": { + "smithy.api#documentation": "\n The type of file being uploaded.\n
", + "smithy.api#required": {} + } + }, + "subjectId": { + "target": "com.amazonaws.omics#SubjectId", + "traits": { + "smithy.api#documentation": "\n The source's subject ID.\n
", + "smithy.api#required": {} + } + }, + "sampleId": { + "target": "com.amazonaws.omics#SampleId", + "traits": { + "smithy.api#documentation": "\n The source's sample ID.\n
", + "smithy.api#required": {} + } + }, + "generatedFrom": { + "target": "com.amazonaws.omics#GeneratedFrom", + "traits": { + "smithy.api#documentation": "\n Where the source originated.\n
" + } + }, + "referenceArn": { + "target": "com.amazonaws.omics#ReferenceArn", + "traits": { + "smithy.api#documentation": "\n The ARN of the reference.\n
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.omics#ReadSetName", + "traits": { + "smithy.api#documentation": "\n The name of the read set.\n
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.omics#ReadSetDescription", + "traits": { + "smithy.api#documentation": "\n The description of the read set.\n
" + } + }, + "tags": { + "target": "com.amazonaws.omics#TagMap", + "traits": { + "smithy.api#documentation": "\n Any tags to add to the read set.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#CreateMultipartReadSetUploadResponse": { + "type": "structure", + "members": { + "sequenceStoreId": { + "target": "com.amazonaws.omics#SequenceStoreId", + "traits": { + "smithy.api#documentation": "\n The sequence store ID for the store that the read set will be created in.\n
", + "smithy.api#required": {} + } + }, + "uploadId": { + "target": "com.amazonaws.omics#UploadId", + "traits": { + "smithy.api#documentation": "\n he ID for the initiated multipart upload.\n
", + "smithy.api#required": {} + } + }, + "sourceFileType": { + "target": "com.amazonaws.omics#FileType", + "traits": { + "smithy.api#documentation": "\n The file type of the read set source.\n
", + "smithy.api#required": {} + } + }, + "subjectId": { + "target": "com.amazonaws.omics#SubjectId", + "traits": { + "smithy.api#documentation": "\n The source's subject ID.\n
", "smithy.api#required": {} } }, @@ -1774,6 +2138,103 @@ "smithy.api#output": {} } }, + "com.amazonaws.omics#CreateShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#CreateShareRequest" + }, + "output": { + "target": "com.amazonaws.omics#CreateShareResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#ConflictException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Creates a share offer that can be accepted outside the account by a subscriber. The share is created by the owner and accepted by the principal subscriber. \n
", + "smithy.api#endpoint": { + "hostPrefix": "analytics-" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/share", + "code": 200 + } + } + }, + "com.amazonaws.omics#CreateShareRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The resource ARN for the analytics store to be shared.\n
", + "smithy.api#required": {} + } + }, + "principalSubscriber": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The principal subscriber is the account being given access to the analytics store data through the share offer. \n
", + "smithy.api#required": {} + } + }, + "shareName": { + "target": "com.amazonaws.omics#ShareName", + "traits": { + "smithy.api#documentation": "\n A name given to the share. \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#CreateShareResponse": { + "type": "structure", + "members": { + "shareId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n An ID generated for the share. \n
" + } + }, + "status": { + "target": "com.amazonaws.omics#ShareStatus", + "traits": { + "smithy.api#documentation": "\n The status of a share. \n
" + } + }, + "shareName": { + "target": "com.amazonaws.omics#ShareName", + "traits": { + "smithy.api#documentation": "\n A name given to the share. \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.omics#CreateVariantStore": { "type": "operation", "input": { @@ -1828,14 +2289,13 @@ } }, "name": { - "target": "smithy.api#String", + "target": "com.amazonaws.omics#StoreName", "traits": { - "smithy.api#documentation": "A name for the store.
", - "smithy.api#pattern": "^([a-z]){1}([a-z0-9_]){2,254}$" + "smithy.api#documentation": "A name for the store.
" } }, "description": { - "target": "com.amazonaws.omics#StoreDescription", + "target": "com.amazonaws.omics#Description", "traits": { "smithy.api#documentation": "A description for the store.
" } @@ -2159,13 +2619,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.omics#DeleteReference": { + "com.amazonaws.omics#DeleteAnnotationStoreVersions": { "type": "operation", "input": { - "target": "com.amazonaws.omics#DeleteReferenceRequest" + "target": "com.amazonaws.omics#DeleteAnnotationStoreVersionsRequest" }, "output": { - "target": "com.amazonaws.omics#DeleteReferenceResponse" + "target": "com.amazonaws.omics#DeleteAnnotationStoreVersionsResponse" }, "errors": [ { @@ -2178,7 +2638,93 @@ "target": "com.amazonaws.omics#InternalServerException" }, { - "target": "com.amazonaws.omics#RequestTimeoutException" + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\nDeletes one or multiple versions of an annotation store. \n
", + "smithy.api#endpoint": { + "hostPrefix": "analytics-" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/annotationStore/{name}/versions/delete", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.omics#DeleteAnnotationStoreVersionsRequest": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\nThe name of the annotation store from which versions are being deleted. \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "versions": { + "target": "com.amazonaws.omics#VersionList", + "traits": { + "smithy.api#documentation": "\nThe versions of an annotation store to be deleted. \n
", + "smithy.api#required": {} + } + }, + "force": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "\nForces the deletion of an annotation store version when imports are in-progress.. \n
", + "smithy.api#httpQuery": "force" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#DeleteAnnotationStoreVersionsResponse": { + "type": "structure", + "members": { + "errors": { + "target": "com.amazonaws.omics#VersionDeleteErrorList", + "traits": { + "smithy.api#documentation": "\nAny errors that occur when attempting to delete an annotation store version. \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.omics#DeleteReference": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#DeleteReferenceRequest" + }, + "output": { + "target": "com.amazonaws.omics#DeleteReferenceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#ConflictException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#RequestTimeoutException" }, { "target": "com.amazonaws.omics#ResourceNotFoundException" @@ -2494,6 +3040,80 @@ "smithy.api#output": {} } }, + "com.amazonaws.omics#DeleteShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#DeleteShareRequest" + }, + "output": { + "target": "com.amazonaws.omics#DeleteShareResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#ConflictException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Deletes a share of an analytics store. \n
", + "smithy.api#endpoint": { + "hostPrefix": "analytics-" + }, + "smithy.api#http": { + "method": "DELETE", + "uri": "/share/{shareId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.omics#DeleteShareRequest": { + "type": "structure", + "members": { + "shareId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The ID for the share request to be deleted. \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#DeleteShareResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.omics#ShareStatus", + "traits": { + "smithy.api#documentation": "\n The status of the share being deleted. \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.omics#DeleteVariantStore": { "type": "operation", "input": { @@ -2637,6 +3257,15 @@ "smithy.api#input": {} } }, + "com.amazonaws.omics#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, "com.amazonaws.omics#Encoding": { "type": "string", "traits": { @@ -2880,6 +3509,26 @@ ] } }, + "com.amazonaws.omics#Filter": { + "type": "structure", + "members": { + "resourceArns": { + "target": "com.amazonaws.omics#ArnList", + "traits": { + "smithy.api#documentation": "\nThe Amazon Resource Number (Arn) for an analytics store. \n
" + } + }, + "status": { + "target": "com.amazonaws.omics#StatusList", + "traits": { + "smithy.api#documentation": "\nThe status of an annotation store version. \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\nUse filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.\n
" + } + }, "com.amazonaws.omics#FormatOptions": { "type": "union", "members": { @@ -3086,6 +3735,13 @@ "smithy.api#required": {} } }, + "versionName": { + "target": "com.amazonaws.omics#VersionName", + "traits": { + "smithy.api#documentation": "\nThe name of the annotation store version. \n
", + "smithy.api#required": {} + } + }, "roleArn": { "target": "com.amazonaws.omics#Arn", "traits": { @@ -3138,21 +3794,268 @@ "runLeftNormalization": { "target": "com.amazonaws.omics#RunLeftNormalization", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "The job's left normalization setting.
", + "smithy.api#default": false, + "smithy.api#documentation": "The job's left normalization setting.
", + "smithy.api#required": {} + } + }, + "formatOptions": { + "target": "com.amazonaws.omics#FormatOptions", + "traits": { + "smithy.api#required": {} + } + }, + "annotationFields": { + "target": "com.amazonaws.omics#AnnotationFieldMap", + "traits": { + "smithy.api#documentation": "\n The annotation schema generated by the parsed annotation data.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.omics#GetAnnotationStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#GetAnnotationStoreRequest" + }, + "output": { + "target": "com.amazonaws.omics#GetAnnotationStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about an annotation store.
", + "smithy.api#endpoint": { + "hostPrefix": "analytics-" + }, + "smithy.api#http": { + "method": "GET", + "uri": "/annotationStore/{name}", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.waiters#waitable": { + "AnnotationStoreCreated": { + "documentation": "Wait until an annotation store is created", + "minDelay": 30, + "maxDelay": 600, + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "status", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "status", + "expected": "CREATING", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "status", + "expected": "UPDATING", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + } + ] + }, + "AnnotationStoreDeleted": { + "documentation": "Wait until an annotation store is deleted.", + "minDelay": 30, + "maxDelay": 600, + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "status", + "expected": "DELETED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "status", + "expected": "DELETING", + "comparator": "stringEquals" + } + } + } + ] + } + } + } + }, + "com.amazonaws.omics#GetAnnotationStoreRequest": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The store's name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#GetAnnotationStoreResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.omics#ResourceId", + "traits": { + "smithy.api#documentation": "The store's ID.
", + "smithy.api#required": {} + } + }, + "reference": { + "target": "com.amazonaws.omics#ReferenceItem", + "traits": { + "smithy.api#documentation": "The store's genome reference.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.omics#StoreStatus", + "traits": { + "smithy.api#documentation": "The store's status.
", + "smithy.api#required": {} + } + }, + "storeArn": { + "target": "com.amazonaws.omics#Arn", + "traits": { + "smithy.api#documentation": "The store's ARN.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The store's name.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.omics#Description", + "traits": { + "smithy.api#documentation": "The store's description.
", + "smithy.api#required": {} + } + }, + "sseConfig": { + "target": "com.amazonaws.omics#SseConfig", + "traits": { + "smithy.api#documentation": "The store's server-side encryption (SSE) settings.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.omics#CreationTime", + "traits": { + "smithy.api#documentation": "When the store was created.
", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "com.amazonaws.omics#UpdateTime", + "traits": { + "smithy.api#documentation": "When the store was updated.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.omics#TagMap", + "traits": { + "smithy.api#documentation": "The store's tags.
", + "smithy.api#required": {} + } + }, + "storeOptions": { + "target": "com.amazonaws.omics#StoreOptions", + "traits": { + "smithy.api#documentation": "The store's parsing options.
" + } + }, + "storeFormat": { + "target": "com.amazonaws.omics#StoreFormat", + "traits": { + "smithy.api#documentation": "The store's annotation file format.
" + } + }, + "statusMessage": { + "target": "com.amazonaws.omics#StatusMessage", + "traits": { + "smithy.api#documentation": "A status message.
", "smithy.api#required": {} } }, - "formatOptions": { - "target": "com.amazonaws.omics#FormatOptions", + "storeSizeBytes": { + "target": "smithy.api#Long", "traits": { + "smithy.api#documentation": "The store's size in bytes.
", "smithy.api#required": {} } }, - "annotationFields": { - "target": "com.amazonaws.omics#AnnotationFieldMap", + "numVersions": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "\n The annotation schema generated by the parsed annotation data.\n
" + "smithy.api#documentation": "\nAn integer indicating how many versions of an annotation store exist. \n
", + "smithy.api#required": {} } } }, @@ -3160,13 +4063,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.omics#GetAnnotationStore": { + "com.amazonaws.omics#GetAnnotationStoreVersion": { "type": "operation", "input": { - "target": "com.amazonaws.omics#GetAnnotationStoreRequest" + "target": "com.amazonaws.omics#GetAnnotationStoreVersionRequest" }, "output": { - "target": "com.amazonaws.omics#GetAnnotationStoreResponse" + "target": "com.amazonaws.omics#GetAnnotationStoreVersionResponse" }, "errors": [ { @@ -3186,19 +4089,19 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about an annotation store.
", + "smithy.api#documentation": "\nRetrieves the metadata for an annotation store version. \n
", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, "smithy.api#http": { "method": "GET", - "uri": "/annotationStore/{name}", + "uri": "/annotationStore/{name}/version/{versionName}", "code": 200 }, "smithy.api#readonly": {}, "smithy.waiters#waitable": { - "AnnotationStoreCreated": { - "documentation": "Wait until an annotation store is created", + "AnnotationStoreVersionCreated": { + "documentation": "Wait until an annotation store version is created", "minDelay": 30, "maxDelay": 600, "acceptors": [ @@ -3244,8 +4147,8 @@ } ] }, - "AnnotationStoreDeleted": { - "documentation": "Wait until an annotation store is deleted.", + "AnnotationStoreVersionDeleted": { + "documentation": "Wait until an annotation store version is deleted.", "minDelay": 30, "maxDelay": 600, "acceptors": [ @@ -3280,13 +4183,21 @@ } } }, - "com.amazonaws.omics#GetAnnotationStoreRequest": { + "com.amazonaws.omics#GetAnnotationStoreVersionRequest": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The store's name.
", + "smithy.api#documentation": "\nThe name given to an annotation store version to distinguish it from others. \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "versionName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\nThe name given to an annotation store version to distinguish it from others. \n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3296,102 +4207,96 @@ "smithy.api#input": {} } }, - "com.amazonaws.omics#GetAnnotationStoreResponse": { + "com.amazonaws.omics#GetAnnotationStoreVersionResponse": { "type": "structure", "members": { - "id": { + "storeId": { "target": "com.amazonaws.omics#ResourceId", "traits": { - "smithy.api#documentation": "The store's ID.
", + "smithy.api#documentation": "\nThe store ID for annotation store version.\n
", "smithy.api#required": {} } }, - "reference": { - "target": "com.amazonaws.omics#ReferenceItem", + "id": { + "target": "com.amazonaws.omics#ResourceId", "traits": { - "smithy.api#documentation": "The store's genome reference.
", + "smithy.api#documentation": "\nThe annotation store version ID.\n
", "smithy.api#required": {} } }, "status": { - "target": "com.amazonaws.omics#StoreStatus", + "target": "com.amazonaws.omics#VersionStatus", "traits": { - "smithy.api#documentation": "The store's status.
", + "smithy.api#documentation": "\nThe status of an annotation store version. \n
", "smithy.api#required": {} } }, - "storeArn": { + "versionArn": { "target": "com.amazonaws.omics#Arn", "traits": { - "smithy.api#documentation": "The store's ARN.
", + "smithy.api#documentation": "\nThe Arn for the annotation store. \n
", "smithy.api#required": {} } }, "name": { - "target": "smithy.api#String", + "target": "com.amazonaws.omics#StoreName", "traits": { - "smithy.api#documentation": "The store's name.
", + "smithy.api#documentation": "\nThe name of the annotation store. \n
", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.omics#StoreDescription", + "versionName": { + "target": "com.amazonaws.omics#VersionName", "traits": { - "smithy.api#documentation": "The store's description.
", + "smithy.api#documentation": "\nThe name given to an annotation store version to distinguish it from others. \n
", "smithy.api#required": {} } }, - "sseConfig": { - "target": "com.amazonaws.omics#SseConfig", + "description": { + "target": "com.amazonaws.omics#Description", "traits": { - "smithy.api#documentation": "The store's server-side encryption (SSE) settings.
", + "smithy.api#documentation": "\nThe description for an annotation store version. \n
", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.omics#CreationTime", "traits": { - "smithy.api#documentation": "When the store was created.
", + "smithy.api#documentation": "\nThe time stamp for when an annotation store version was created. \n
", "smithy.api#required": {} } }, "updateTime": { "target": "com.amazonaws.omics#UpdateTime", "traits": { - "smithy.api#documentation": "When the store was updated.
", + "smithy.api#documentation": "\nThe time stamp for when an annotation store version was updated. \n
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.omics#TagMap", "traits": { - "smithy.api#documentation": "The store's tags.
", + "smithy.api#documentation": "\nAny tags associated with an annotation store version. \n
", "smithy.api#required": {} } }, - "storeOptions": { - "target": "com.amazonaws.omics#StoreOptions", - "traits": { - "smithy.api#documentation": "The store's parsing options.
" - } - }, - "storeFormat": { - "target": "com.amazonaws.omics#StoreFormat", + "versionOptions": { + "target": "com.amazonaws.omics#VersionOptions", "traits": { - "smithy.api#documentation": "The store's annotation file format.
" + "smithy.api#documentation": "\nThe options for an annotation store version. \n
" } }, "statusMessage": { "target": "com.amazonaws.omics#StatusMessage", "traits": { - "smithy.api#documentation": "A status message.
", + "smithy.api#documentation": "\nThe status of an annotation store version.\n
", "smithy.api#required": {} } }, - "storeSizeBytes": { + "versionSizeBytes": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "The store's size in bytes.
", + "smithy.api#documentation": "\nThe size of the annotation store version in Bytes. \n
", "smithy.api#required": {} } } @@ -5622,6 +6527,12 @@ "min": 0 } } + }, + "instanceType": { + "target": "com.amazonaws.omics#TaskInstanceType", + "traits": { + "smithy.api#documentation": "\n The instance type for a task. \n
" + } } }, "traits": { @@ -5739,6 +6650,80 @@ "smithy.api#output": {} } }, + "com.amazonaws.omics#GetShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#GetShareRequest" + }, + "output": { + "target": "com.amazonaws.omics#GetShareResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#ConflictException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Retrieves the metadata for a share. \n
", + "smithy.api#endpoint": { + "hostPrefix": "analytics-" + }, + "smithy.api#http": { + "method": "GET", + "uri": "/share/{shareId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.omics#GetShareRequest": { + "type": "structure", + "members": { + "shareId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The generated ID for a share. \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#GetShareResponse": { + "type": "structure", + "members": { + "share": { + "target": "com.amazonaws.omics#ShareDetails", + "traits": { + "smithy.api#documentation": "\n An analytic store share details object. contains status, resourceArn, ownerId, etc. \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.omics#GetVariantImportJob": { "type": "operation", "input": { @@ -6111,7 +7096,7 @@ } }, "description": { - "target": "com.amazonaws.omics#StoreDescription", + "target": "com.amazonaws.omics#Description", "traits": { "smithy.api#documentation": "The store's description.
", "smithy.api#required": {} @@ -6792,32 +7777,162 @@ "com.amazonaws.omics#JobStatusMessage": { "type": "string", "traits": { - "smithy.api#length": { - "min": 1, - "max": 127 - }, - "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" + } + }, + "com.amazonaws.omics#JobStatusMsg": { + "type": "string" + }, + "com.amazonaws.omics#LineSep": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.omics#ListAnnotationImportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#ListAnnotationImportJobsRequest" + }, + "output": { + "target": "com.amazonaws.omics#ListAnnotationImportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of annotation import jobs.
", + "smithy.api#endpoint": { + "hostPrefix": "analytics-" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/import/annotations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "annotationImportJobs" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.omics#ListAnnotationImportJobsFilter": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.omics#JobStatus", + "traits": { + "smithy.api#documentation": "A status to filter on.
" + } + }, + "storeName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A store name to filter on.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A filter for annotation import jobs.
" + } + }, + "com.amazonaws.omics#ListAnnotationImportJobsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of jobs to return in one page of results.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "ids": { + "target": "com.amazonaws.omics#IdList", + "traits": { + "smithy.api#documentation": "IDs of annotation import jobs to retrieve.
", + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Specifies the pagination token from a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "filter": { + "target": "com.amazonaws.omics#ListAnnotationImportJobsFilter", + "traits": { + "smithy.api#documentation": "A filter to apply to the list.
" + } + } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.omics#JobStatusMsg": { - "type": "string" - }, - "com.amazonaws.omics#LineSep": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 + "com.amazonaws.omics#ListAnnotationImportJobsResponse": { + "type": "structure", + "members": { + "annotationImportJobs": { + "target": "com.amazonaws.omics#AnnotationImportJobItems", + "traits": { + "smithy.api#documentation": "A list of jobs.
" + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Specifies the pagination token from a previous request to retrieve the next page of results.
" + } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.omics#ListAnnotationImportJobs": { + "com.amazonaws.omics#ListAnnotationStoreVersions": { "type": "operation", "input": { - "target": "com.amazonaws.omics#ListAnnotationImportJobsRequest" + "target": "com.amazonaws.omics#ListAnnotationStoreVersionsRequest" }, "output": { - "target": "com.amazonaws.omics#ListAnnotationImportJobsResponse" + "target": "com.amazonaws.omics#ListAnnotationStoreVersionsResponse" }, "errors": [ { @@ -6837,51 +7952,53 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves a list of annotation import jobs.
", + "smithy.api#documentation": "\nLists the versions of an annotation store. \n
", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, "smithy.api#http": { "method": "POST", - "uri": "/import/annotations", + "uri": "/annotationStore/{name}/versions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", - "items": "annotationImportJobs" + "items": "annotationStoreVersions" }, "smithy.api#readonly": {} } }, - "com.amazonaws.omics#ListAnnotationImportJobsFilter": { + "com.amazonaws.omics#ListAnnotationStoreVersionsFilter": { "type": "structure", "members": { "status": { - "target": "com.amazonaws.omics#JobStatus", - "traits": { - "smithy.api#documentation": "A status to filter on.
" - } - }, - "storeName": { - "target": "smithy.api#String", + "target": "com.amazonaws.omics#VersionStatus", "traits": { - "smithy.api#documentation": "A store name to filter on.
" + "smithy.api#documentation": "\nThe status of an annotation store version. \n
" } } }, "traits": { - "smithy.api#documentation": "A filter for annotation import jobs.
" + "smithy.api#documentation": "\nUse filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.\n
" } }, - "com.amazonaws.omics#ListAnnotationImportJobsRequest": { + "com.amazonaws.omics#ListAnnotationStoreVersionsRequest": { "type": "structure", "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\nThe name of an annotation store. \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The maximum number of jobs to return in one page of results.
", + "smithy.api#documentation": "\nThe maximum number of annotation store versions to return in one page of results.\n
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -6889,20 +8006,10 @@ } } }, - "ids": { - "target": "com.amazonaws.omics#IdList", - "traits": { - "smithy.api#documentation": "IDs of annotation import jobs to retrieve.
", - "smithy.api#length": { - "min": 1, - "max": 20 - } - } - }, "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "smithy.api#documentation": "\nSpecifies the pagination token from a previous request to retrieve the next page of results.\n
", "smithy.api#httpQuery": "nextToken", "smithy.api#length": { "min": 1, @@ -6911,9 +8018,9 @@ } }, "filter": { - "target": "com.amazonaws.omics#ListAnnotationImportJobsFilter", + "target": "com.amazonaws.omics#ListAnnotationStoreVersionsFilter", "traits": { - "smithy.api#documentation": "A filter to apply to the list.
" + "smithy.api#documentation": "\nA filter to apply to the list of annotation store versions.\n
" } } }, @@ -6921,19 +8028,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.omics#ListAnnotationImportJobsResponse": { + "com.amazonaws.omics#ListAnnotationStoreVersionsResponse": { "type": "structure", "members": { - "annotationImportJobs": { - "target": "com.amazonaws.omics#AnnotationImportJobItems", + "annotationStoreVersions": { + "target": "com.amazonaws.omics#AnnotationStoreVersionItems", "traits": { - "smithy.api#documentation": "A list of jobs.
" + "smithy.api#documentation": "\nLists all versions of an annotation store.\n
" } }, "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "A pagination token that's included if more results are available.
" + "smithy.api#documentation": "\nSpecifies the pagination token from a previous request to retrieve the next page of results.\n
" } } }, @@ -8468,6 +9575,112 @@ "smithy.api#output": {} } }, + "com.amazonaws.omics#ListShares": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#ListSharesRequest" + }, + "output": { + "target": "com.amazonaws.omics#ListSharesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#ConflictException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Lists all shares associated with an account. \n
", + "smithy.api#endpoint": { + "hostPrefix": "analytics-" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/shares", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "shares" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.omics#ListSharesRequest": { + "type": "structure", + "members": { + "resourceOwner": { + "target": "com.amazonaws.omics#ResourceOwner", + "traits": { + "smithy.api#documentation": "\n The account that owns the analytics store shared. \n
", + "smithy.api#required": {} + } + }, + "filter": { + "target": "com.amazonaws.omics#Filter", + "traits": { + "smithy.api#documentation": "\n Attributes used to filter for a specific subset of shares. \n
" + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.\n
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "\n The maximum number of shares to return in one page of results.\n
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#ListSharesResponse": { + "type": "structure", + "members": { + "shares": { + "target": "com.amazonaws.omics#ShareDetailsList", + "traits": { + "smithy.api#documentation": "\n The shares available and their meta details. \n
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\nNext token returned in the response of a previous ListSharesResponse call. Used to get the next page of results.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.omics#ListTagsForResource": { "type": "operation", "input": { @@ -9048,6 +10261,9 @@ { "target": "com.amazonaws.omics#AnnotationStore" }, + { + "target": "com.amazonaws.omics#AnnotationStoreVersion" + }, { "target": "com.amazonaws.omics#ReferenceStoreResource" }, @@ -9060,6 +10276,9 @@ { "target": "com.amazonaws.omics#SequenceStoreResource" }, + { + "target": "com.amazonaws.omics#Share" + }, { "target": "com.amazonaws.omics#TaggingResource" }, @@ -11096,6 +12315,23 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.omics#ResourceOwner": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SELF", + "name": "SELF", + "documentation": "The resource owner is the calling account" + }, + { + "value": "OTHER", + "name": "OTHER", + "documentation": "The resource owner is an account other than the caller" + } + ] + } + }, "com.amazonaws.omics#RoleArn": { "type": "string", "traits": { @@ -11978,9 +13214,147 @@ } }, "traits": { - "smithy.api#documentation": "The request exceeds a service quota.
", - "smithy.api#error": "client", - "smithy.api#httpError": 402 + "smithy.api#documentation": "The request exceeds a service quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.omics#Share": { + "type": "resource", + "identifiers": { + "shareId": { + "target": "smithy.api#String" + } + }, + "create": { + "target": "com.amazonaws.omics#CreateShare" + }, + "read": { + "target": "com.amazonaws.omics#GetShare" + }, + "update": { + "target": "com.amazonaws.omics#AcceptShare" + }, + "delete": { + "target": "com.amazonaws.omics#DeleteShare" + }, + "list": { + "target": "com.amazonaws.omics#ListShares" + } + }, + "com.amazonaws.omics#ShareDetails": { + "type": "structure", + "members": { + "shareId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The ID for a share offer for an analytics store .\n
" + } + }, + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The resource Arn of the analytics store being shared. \n
" + } + }, + "principalSubscriber": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The principal subscriber is the account the analytics store data is being shared with. \n
" + } + }, + "ownerId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The account ID for the data owner. The owner creates the share offer. \n
" + } + }, + "status": { + "target": "com.amazonaws.omics#ShareStatus", + "traits": { + "smithy.api#documentation": "\n The status of a share. \n
" + } + }, + "statusMessage": { + "target": "com.amazonaws.omics#StatusMessage", + "traits": { + "smithy.api#documentation": "\n The status message for a share. It provides more details on the status of the share.\n
" + } + }, + "shareName": { + "target": "com.amazonaws.omics#ShareName", + "traits": { + "smithy.api#documentation": "\n The name of the share. \n
" + } + }, + "creationTime": { + "target": "com.amazonaws.omics#CreationTime", + "traits": { + "smithy.api#documentation": "\n The timestamp for when the share was created. \n
" + } + }, + "updateTime": { + "target": "com.amazonaws.omics#UpdateTime", + "traits": { + "smithy.api#documentation": "\n The timestamp of the share update. \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The details of a share. \n
" + } + }, + "com.amazonaws.omics#ShareDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.omics#ShareDetails" + } + }, + "com.amazonaws.omics#ShareName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.omics#ShareStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING", + "documentation": "The share has been created but is not yet active" + }, + { + "value": "ACTIVATING", + "name": "ACTIVATING", + "documentation": "The share is activated" + }, + { + "value": "ACTIVE", + "name": "ACTIVE", + "documentation": "The share is active and can be used" + }, + { + "value": "DELETING", + "name": "DELETING", + "documentation": "The share is being deleted" + }, + { + "value": "DELETED", + "name": "DELETED", + "documentation": "The share has been deleted" + }, + { + "value": "FAILED", + "name": "FAILED", + "documentation": "The share has failed to activate or delete" + } + ] } }, "com.amazonaws.omics#SourceFiles": { @@ -12094,6 +13468,12 @@ "smithy.api#required": {} } }, + "versionName": { + "target": "com.amazonaws.omics#VersionName", + "traits": { + "smithy.api#documentation": "\nThe name of the annotation store version. \n
" + } + }, "formatOptions": { "target": "com.amazonaws.omics#FormatOptions", "traits": { @@ -13036,21 +14416,21 @@ "smithy.api#output": {} } }, - "com.amazonaws.omics#StatusMessage": { - "type": "string", + "com.amazonaws.omics#StatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.omics#ShareStatus" + }, "traits": { - "smithy.api#length": { - "min": 0, - "max": 1000 - } + "smithy.api#uniqueItems": {} } }, - "com.amazonaws.omics#StoreDescription": { + "com.amazonaws.omics#StatusMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 0, - "max": 500 + "max": 1000 } } }, @@ -13306,6 +14686,12 @@ "smithy.api#pattern": "^[0-9]+$" } }, + "com.amazonaws.omics#TaskInstanceType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" + } + }, "com.amazonaws.omics#TaskList": { "type": "list", "member": { @@ -13377,6 +14763,12 @@ "min": 0 } } + }, + "instanceType": { + "target": "com.amazonaws.omics#TaskInstanceType", + "traits": { + "smithy.api#documentation": "\n The instance type for a task. \n
" + } } }, "traits": { @@ -13542,6 +14934,36 @@ "smithy.api#documentation": "File settings for a TSV store.
" } }, + "com.amazonaws.omics#TsvVersionOptions": { + "type": "structure", + "members": { + "annotationType": { + "target": "com.amazonaws.omics#AnnotationType", + "traits": { + "smithy.api#documentation": "\nThe store version's annotation type.\n
" + } + }, + "formatToHeader": { + "target": "com.amazonaws.omics#FormatToHeader", + "traits": { + "smithy.api#documentation": "\nThe annotation store version's header key to column name mapping.\n
" + } + }, + "schema": { + "target": "com.amazonaws.omics#Schema", + "traits": { + "smithy.api#documentation": "\nThe TSV schema for an annotation store version. \n
", + "smithy.api#length": { + "min": 1, + "max": 5000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "\nThe options for a TSV file.\n
" + } + }, "com.amazonaws.omics#UntagResource": { "type": "operation", "input": { @@ -13669,7 +15091,7 @@ } }, "description": { - "target": "com.amazonaws.omics#StoreDescription", + "target": "com.amazonaws.omics#Description", "traits": { "smithy.api#documentation": "A description for the store.
" } @@ -13711,7 +15133,7 @@ } }, "description": { - "target": "com.amazonaws.omics#StoreDescription", + "target": "com.amazonaws.omics#Description", "traits": { "smithy.api#documentation": "The store's description.
", "smithy.api#required": {} @@ -13748,6 +15170,137 @@ "smithy.api#output": {} } }, + "com.amazonaws.omics#UpdateAnnotationStoreVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#UpdateAnnotationStoreVersionRequest" + }, + "output": { + "target": "com.amazonaws.omics#UpdateAnnotationStoreVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\nUpdates the description of an annotation store version. \n
", + "smithy.api#endpoint": { + "hostPrefix": "analytics-" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/annotationStore/{name}/version/{versionName}", + "code": 200 + } + } + }, + "com.amazonaws.omics#UpdateAnnotationStoreVersionRequest": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\nThe name of an annotation store. \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "versionName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\nThe name of an annotation store version. \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.omics#Description", + "traits": { + "smithy.api#documentation": "\nThe description of an annotation store. \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#UpdateAnnotationStoreVersionResponse": { + "type": "structure", + "members": { + "storeId": { + "target": "com.amazonaws.omics#ResourceId", + "traits": { + "smithy.api#documentation": "\nThe annotation store ID. \n
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.omics#ResourceId", + "traits": { + "smithy.api#documentation": "\nThe annotation store version ID.\n
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.omics#VersionStatus", + "traits": { + "smithy.api#documentation": "\nThe status of an annotation store version. \n
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.omics#StoreName", + "traits": { + "smithy.api#documentation": "\nThe name of an annotation store. \n
", + "smithy.api#required": {} + } + }, + "versionName": { + "target": "com.amazonaws.omics#VersionName", + "traits": { + "smithy.api#documentation": "\nThe name of an annotation store version.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.omics#Description", + "traits": { + "smithy.api#documentation": "\nThe description of an annotation store version.\n
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.omics#CreationTime", + "traits": { + "smithy.api#documentation": "\nThe time stamp for when an annotation store version was created. \n
", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "com.amazonaws.omics#UpdateTime", + "traits": { + "smithy.api#documentation": "\nThe time stamp for when an annotation store version was updated. \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.omics#UpdateRunGroup": { "type": "operation", "input": { @@ -13911,7 +15464,7 @@ } }, "description": { - "target": "com.amazonaws.omics#StoreDescription", + "target": "com.amazonaws.omics#Description", "traits": { "smithy.api#documentation": "A description for the store.
" } @@ -13953,7 +15506,7 @@ } }, "description": { - "target": "com.amazonaws.omics#StoreDescription", + "target": "com.amazonaws.omics#Description", "traits": { "smithy.api#documentation": "The store's description.
", "smithy.api#required": {} @@ -14413,7 +15966,7 @@ } }, "description": { - "target": "com.amazonaws.omics#StoreDescription", + "target": "com.amazonaws.omics#Description", "traits": { "smithy.api#documentation": "The store's description.
", "smithy.api#required": {} @@ -14485,6 +16038,102 @@ "smithy.api#documentation": "Formatting options for a VCF file.
" } }, + "com.amazonaws.omics#VersionDeleteError": { + "type": "structure", + "members": { + "versionName": { + "target": "com.amazonaws.omics#VersionName", + "traits": { + "smithy.api#documentation": "\nThe name given to an annotation store version.\n
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\nThe message explaining the error in annotation store deletion.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\nThe error preventing deletion of the annotation store version. \n
" + } + }, + "com.amazonaws.omics#VersionDeleteErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.omics#VersionDeleteError" + } + }, + "com.amazonaws.omics#VersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.omics#VersionName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.omics#VersionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 255 + }, + "smithy.api#pattern": "^([a-z]){1}([a-z0-9_]){2,254}$" + } + }, + "com.amazonaws.omics#VersionOptions": { + "type": "union", + "members": { + "tsvVersionOptions": { + "target": "com.amazonaws.omics#TsvVersionOptions", + "traits": { + "smithy.api#documentation": "\nFile settings for a version of a TSV store.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\nThe options for an annotation store version. \n
" + } + }, + "com.amazonaws.omics#VersionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING", + "documentation": "The Version is being created" + }, + { + "value": "UPDATING", + "name": "UPDATING", + "documentation": "The Version is updating" + }, + { + "value": "DELETING", + "name": "DELETING", + "documentation": "The Version is deleting" + }, + { + "value": "ACTIVE", + "name": "ACTIVE", + "documentation": "The Version is active" + }, + { + "value": "FAILED", + "name": "FAILED", + "documentation": "The Version creation failed" + } + ] + } + }, "com.amazonaws.omics#WorkflowArn": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/pi.2018-02-27.json b/codegen/sdk-codegen/aws-models/pi.2018-02-27.json index facfaaaf9eb..db344905939 100644 --- a/codegen/sdk-codegen/aws-models/pi.2018-02-27.json +++ b/codegen/sdk-codegen/aws-models/pi.2018-02-27.json @@ -29,6 +29,17 @@ ] }, "shapes": { + "com.amazonaws.pi#AcceptLanguage": { + "type": "enum", + "members": { + "EN_US": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EN_US" + } + } + } + }, "com.amazonaws.pi#AdditionalMetricsList": { "type": "list", "member": { @@ -50,6 +61,275 @@ "target": "com.amazonaws.pi#Double" } }, + "com.amazonaws.pi#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^arn:.*:pi:.*$" + } + }, + "com.amazonaws.pi#AnalysisReport": { + "type": "structure", + "members": { + "AnalysisReportId": { + "target": "com.amazonaws.pi#AnalysisReportId", + "traits": { + "smithy.api#documentation": "The name of the analysis report.
", + "smithy.api#required": {} + } + }, + "Identifier": { + "target": "com.amazonaws.pi#IdentifierString", + "traits": { + "smithy.api#documentation": "The unique identifier of the analysis report.
" + } + }, + "ServiceType": { + "target": "com.amazonaws.pi#ServiceType", + "traits": { + "smithy.api#documentation": "List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:
\n\n RDS\n
\n DOCDB\n
The time you created the analysis report.
" + } + }, + "StartTime": { + "target": "com.amazonaws.pi#ISOTimestamp", + "traits": { + "smithy.api#documentation": "The analysis start time in the report.
" + } + }, + "EndTime": { + "target": "com.amazonaws.pi#ISOTimestamp", + "traits": { + "smithy.api#documentation": "The analysis end time in the report.
" + } + }, + "Status": { + "target": "com.amazonaws.pi#AnalysisStatus", + "traits": { + "smithy.api#documentation": "The status of the created analysis report.
" + } + }, + "Insights": { + "target": "com.amazonaws.pi#InsightList", + "traits": { + "smithy.api#documentation": "The list of identified insights in the analysis report.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Retrieves the summary of the performance analysis report created for a time period.
" + } + }, + "com.amazonaws.pi#AnalysisReportId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^report-[0-9a-f]{17}$" + } + }, + "com.amazonaws.pi#AnalysisReportSummary": { + "type": "structure", + "members": { + "AnalysisReportId": { + "target": "com.amazonaws.pi#String", + "traits": { + "smithy.api#documentation": "The name of the analysis report.
" + } + }, + "CreateTime": { + "target": "com.amazonaws.pi#ISOTimestamp", + "traits": { + "smithy.api#documentation": "The time you created the analysis report.
" + } + }, + "StartTime": { + "target": "com.amazonaws.pi#ISOTimestamp", + "traits": { + "smithy.api#documentation": "The start time of the analysis in the report.
" + } + }, + "EndTime": { + "target": "com.amazonaws.pi#ISOTimestamp", + "traits": { + "smithy.api#documentation": "The end time of the analysis in the report.
" + } + }, + "Status": { + "target": "com.amazonaws.pi#AnalysisStatus", + "traits": { + "smithy.api#documentation": "The status of the analysis report.
" + } + }, + "Tags": { + "target": "com.amazonaws.pi#TagList", + "traits": { + "smithy.api#documentation": "List of all the tags added to the analysis report.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Retrieves the details of the performance analysis report.
" + } + }, + "com.amazonaws.pi#AnalysisReportSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.pi#AnalysisReportSummary" + } + }, + "com.amazonaws.pi#AnalysisStatus": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.pi#Boolean": { + "type": "boolean" + }, + "com.amazonaws.pi#ContextType": { + "type": "enum", + "members": { + "CAUSAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAUSAL" + } + }, + "CONTEXTUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTEXTUAL" + } + } + } + }, + "com.amazonaws.pi#CreatePerformanceAnalysisReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.pi#CreatePerformanceAnalysisReportRequest" + }, + "output": { + "target": "com.amazonaws.pi#CreatePerformanceAnalysisReportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pi#InternalServiceError" + }, + { + "target": "com.amazonaws.pi#InvalidArgumentException" + }, + { + "target": "com.amazonaws.pi#NotAuthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new performance analysis report for a specific time period for the\n DB instance.
" + } + }, + "com.amazonaws.pi#CreatePerformanceAnalysisReportRequest": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.pi#ServiceType", + "traits": { + "smithy.api#documentation": "The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.
An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from\n this data source.
\nTo use an Amazon RDS instance as a data source, you specify its DbiResourceId value. \n For example, specify db-ADECBTYHKTSAUMUZQYPDS2GW4A.
The start time defined for the analysis report.
", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.pi#ISOTimestamp", + "traits": { + "smithy.api#documentation": "The end time defined for the analysis report.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.pi#TagList", + "traits": { + "smithy.api#documentation": "The metadata assigned to the analysis report consisting of a key-value pair.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pi#CreatePerformanceAnalysisReportResponse": { + "type": "structure", + "members": { + "AnalysisReportId": { + "target": "com.amazonaws.pi#AnalysisReportId", + "traits": { + "smithy.api#documentation": "A unique identifier for the created analysis report.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pi#Data": { + "type": "structure", + "members": { + "PerformanceInsightsMetric": { + "target": "com.amazonaws.pi#PerformanceInsightsMetric", + "traits": { + "smithy.api#documentation": "This field determines the Performance Insights metric to render \n for the insight. The name field refers to a Performance Insights metric. \n
List of data objects which provide details about source metrics. \n This field can be used to determine the PI metric to render\n for the insight. This data type also includes static values \n for the metrics for the Insight that were calculated and included \n in text and annotations on the DB load chart.
" + } + }, + "com.amazonaws.pi#DataList": { + "type": "list", + "member": { + "target": "com.amazonaws.pi#Data" + } + }, "com.amazonaws.pi#DataPoint": { "type": "structure", "members": { @@ -78,6 +358,65 @@ "target": "com.amazonaws.pi#DataPoint" } }, + "com.amazonaws.pi#DeletePerformanceAnalysisReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.pi#DeletePerformanceAnalysisReportRequest" + }, + "output": { + "target": "com.amazonaws.pi#DeletePerformanceAnalysisReportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pi#InternalServiceError" + }, + { + "target": "com.amazonaws.pi#InvalidArgumentException" + }, + { + "target": "com.amazonaws.pi#NotAuthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a performance analysis report.
" + } + }, + "com.amazonaws.pi#DeletePerformanceAnalysisReportRequest": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.pi#ServiceType", + "traits": { + "smithy.api#documentation": "The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. \n In the console, the identifier is shown as ResourceID. When you \n call DescribeDBInstances, the identifier is returned as DbiResourceId.
To use a DB instance as a data source, specify its DbiResourceId value. For example, specify\n db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
The unique identifier of the analysis report for deletion.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pi#DeletePerformanceAnalysisReportResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pi#DescribeDimensionKeys": { "type": "operation", "input": { @@ -117,7 +456,7 @@ } }, "Identifier": { - "target": "com.amazonaws.pi#RequestString", + "target": "com.amazonaws.pi#IdentifierString", "traits": { "smithy.api#documentation": "An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from\n this data source.
\nTo use an Amazon RDS instance as a data source, you specify its DbiResourceId value. \n For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A.\n
Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID,\n GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID.\n This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large\n SQL statement text.
The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.
The ID for a data source from which to gather dimension data. This ID must be immutable and \n unique within an Amazon Web Services Region. When a DB instance is the data source, specify its \n DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.\n
The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are\n valid:
\n\n db.query (Amazon DocumentDB only)
\n db.sql (Amazon RDS and Aurora only)
The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql, the group ID is\n db.sql.id. The following group ID values are valid:
\n db.sql.id for dimension group db.sql (Aurora and RDS only)
\n db.query.id for dimension group db.query (DocumentDB only)
A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns\n all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:
\n\n db.sql - Specify either the full dimension name db.sql.statement or the short dimension name\n statement (Aurora and RDS only).
\n db.query - Specify either the full dimension name db.query.statement or the short dimension name\n statement (DocumentDB only).
The details for the requested dimensions.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pi#GetPerformanceAnalysisReport": { "type": "operation", "input": { - "target": "com.amazonaws.pi#GetDimensionKeyDetailsRequest" + "target": "com.amazonaws.pi#GetPerformanceAnalysisReportRequest" }, "output": { - "target": "com.amazonaws.pi#GetDimensionKeyDetailsResponse" + "target": "com.amazonaws.pi#GetPerformanceAnalysisReportResponse" }, "errors": [ { @@ -516,44 +953,43 @@ } ], "traits": { - "smithy.api#documentation": "Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID,\n GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID.\n This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large\n SQL statement text.
Retrieves the report including the report ID, status, time details, and the insights\n with recommendations. The report status can be RUNNING,\n SUCCEEDED, or FAILED. The insights include the\n description and recommendation fields.
The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.
The Amazon Web Services service for which Performance Insights will return metrics. Valid value is\n RDS.
The ID for a data source from which to gather dimension data. This ID must be immutable and \n unique within an Amazon Web Services Region. When a DB instance is the data source, specify its \n DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.\n
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers \n metrics from this data source. In the console, the identifier is shown as \n ResourceID. When you call DescribeDBInstances, the identifier is\n returned as DbiResourceId.
To use a DB instance as a data source, specify its DbiResourceId value. For example, specify\n db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are\n valid:
\n\n db.query (Amazon DocumentDB only)
\n db.sql (Amazon RDS and Aurora only)
A unique identifier of the created analysis report. For example,\n report-12345678901234567\n
The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql, the group ID is\n db.sql.id. The following group ID values are valid:
\n db.sql.id for dimension group db.sql (Aurora and RDS only)
\n db.query.id for dimension group db.query (DocumentDB only)
Indicates the text format in the report. The options are PLAIN_TEXT or MARKDOWN. The default\n value is plain text.
A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns\n all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:
\n\n db.sql - Specify either the full dimension name db.sql.statement or the short dimension name\n statement (Aurora and RDS only).
\n db.query - Specify either the full dimension name db.query.statement or the short dimension name\n statement (DocumentDB only).
The text language in the report. The default language is EN_US (English). \n
The details for the requested dimensions.
" + "smithy.api#documentation": "The summary of the performance analysis report created for a time period.
" } } }, @@ -609,7 +1045,7 @@ } }, "Identifier": { - "target": "com.amazonaws.pi#RequestString", + "target": "com.amazonaws.pi#IdentifierString", "traits": { "smithy.api#documentation": "An immutable identifier for a data source that is unique for an Amazon Web Services Region. \n Performance Insights gathers metrics from this data source. To use a DB instance as a data source, \n specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.\n
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the\n console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is\n returned as DbiResourceId.
To use a DB instance as a data source, specify its DbiResourceId value. For example, specify\n db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
The unique identifier for the insight. For example, insight-12345678901234567.
The type of insight. For example, HighDBLoad, HighCPU, or DominatingSQLs.
Indicates if the insight is causal or correlated insight.
" + } + }, + "StartTime": { + "target": "com.amazonaws.pi#ISOTimestamp", + "traits": { + "smithy.api#documentation": "The start time of the insight. For example, 2018-10-30T00:00:00Z.
The end time of the insight. For example, 2018-10-30T00:00:00Z.
The severity of the insight. The values are: Low, Medium, or High.
List of supporting insights that provide additional factors for the insight.
" + } + }, + "Description": { + "target": "com.amazonaws.pi#MarkdownString", + "traits": { + "smithy.api#documentation": "Description of the insight. For example:\n A high severity Insight found between 02:00 to 02:30,\n where there was an unusually high DB load 600x above baseline. \n Likely performance impact.
List of recommendations for the insight.\n For example, Investigate the following SQLs that contributed \n to 100% of the total DBLoad during that time period: sql-id.
List of data objects containing metrics and references from the time range while generating the insight.
" + } + }, + "BaselineData": { + "target": "com.amazonaws.pi#DataList", + "traits": { + "smithy.api#documentation": "\n Metric names and values from the timeframe \n used as baseline to generate the insight.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Retrieves the list of performance issues which are identified.
" + } + }, + "com.amazonaws.pi#InsightList": { + "type": "list", + "member": { + "target": "com.amazonaws.pi#Insight" } }, "com.amazonaws.pi#Integer": { @@ -801,34 +1318,212 @@ "smithy.api#error": "server" } }, - "com.amazonaws.pi#InvalidArgumentException": { + "com.amazonaws.pi#InvalidArgumentException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.pi#ErrorString" + } + }, + "traits": { + "smithy.api#documentation": "One of the arguments provided is invalid for this request.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.pi#Limit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.pi#ListAvailableResourceDimensions": { + "type": "operation", + "input": { + "target": "com.amazonaws.pi#ListAvailableResourceDimensionsRequest" + }, + "output": { + "target": "com.amazonaws.pi#ListAvailableResourceDimensionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pi#InternalServiceError" + }, + { + "target": "com.amazonaws.pi#InvalidArgumentException" + }, + { + "target": "com.amazonaws.pi#NotAuthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.pi#ListAvailableResourceDimensionsRequest": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.pi#ServiceType", + "traits": { + "smithy.api#documentation": "The Amazon Web Services service for which Performance Insights returns metrics.
", + "smithy.api#required": {} + } + }, + "Identifier": { + "target": "com.amazonaws.pi#IdentifierString", + "traits": { + "smithy.api#documentation": "An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers\n metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its\n DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
The types of metrics for which to retrieve dimensions. Valid values include db.load.
The maximum number of items to return in the response. If more items exist than the specified \n MaxRecords value, a pagination token is included in the response so that the remaining \n results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the token, up to the value specified by MaxRecords.\n
The dimension information returned for requested metric types.
" + } + }, + "NextToken": { + "target": "com.amazonaws.pi#NextToken", + "traits": { + "smithy.api#documentation": "An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the token, up to the value specified by MaxRecords.
Retrieve metrics of the specified types that can be queried for a specified DB instance.\n
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.pi#ListAvailableResourceMetricsRequest": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.pi#ServiceType", + "traits": { + "smithy.api#documentation": "The Amazon Web Services service for which Performance Insights returns metrics.
", + "smithy.api#required": {} + } + }, + "Identifier": { + "target": "com.amazonaws.pi#IdentifierString", + "traits": { + "smithy.api#documentation": "An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers\n metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its\n DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
The types of metrics to return in the response. Valid values in the array include the following:
\n\n os (OS counter metrics) - All engines
\n db (DB load metrics) - All engines except for Amazon DocumentDB
\n db.sql.stats (per-SQL metrics) - All engines except for Amazon DocumentDB
\n db.sql_tokenized.stats (per-SQL digest metrics) - All engines except for Amazon DocumentDB
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the token, up to the value specified by MaxRecords.\n
The maximum number of items to return. If the MaxRecords value is less than the number \n of existing items, the response includes a pagination token.
An array of metrics available to query. Each array element contains the full name, \n description, and unit of the metric.\n
" + } + }, + "NextToken": { + "target": "com.amazonaws.pi#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that indicates the response didn’t return all available records because MaxRecords was specified in the\n previous request. To get the remaining records, specify NextToken in a separate request with this value.
One of the arguments provided is invalid for this request.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.pi#Limit": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 25 - } + "smithy.api#output": {} } }, - "com.amazonaws.pi#ListAvailableResourceDimensions": { + "com.amazonaws.pi#ListPerformanceAnalysisReports": { "type": "operation", "input": { - "target": "com.amazonaws.pi#ListAvailableResourceDimensionsRequest" + "target": "com.amazonaws.pi#ListPerformanceAnalysisReportsRequest" }, "output": { - "target": "com.amazonaws.pi#ListAvailableResourceDimensionsResponse" + "target": "com.amazonaws.pi#ListPerformanceAnalysisReportsResponse" }, "errors": [ { @@ -842,7 +1537,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
", + "smithy.api#documentation": "Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -850,40 +1545,39 @@ } } }, - "com.amazonaws.pi#ListAvailableResourceDimensionsRequest": { + "com.amazonaws.pi#ListPerformanceAnalysisReportsRequest": { "type": "structure", "members": { "ServiceType": { "target": "com.amazonaws.pi#ServiceType", "traits": { - "smithy.api#documentation": "The Amazon Web Services service for which Performance Insights returns metrics.
", + "smithy.api#documentation": "The Amazon Web Services service for which Performance Insights returns metrics. Valid value is\n RDS.
An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers\n metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its\n DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the\n console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is\n returned as DbiResourceId.
To use a DB instance as a data source, specify its DbiResourceId value. For example, specify\n db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
The types of metrics for which to retrieve dimensions. Valid values include db.load.
An optional pagination token provided by a previous request. \n If this parameter is specified, the response includes only records beyond\n the token, up to the value specified by MaxResults.
The maximum number of items to return in the response. If more items exist than the specified \n MaxRecords value, a pagination token is included in the response so that the remaining \n results can be retrieved.
The maximum number of items to return in the response. If more items exist than the specified MaxResults value, a\n pagination token is included in the response so that the remaining results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the token, up to the value specified by MaxRecords.\n
Specifies whether or not to include the list of tags in the response.
" } } }, @@ -891,19 +1585,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.pi#ListAvailableResourceDimensionsResponse": { + "com.amazonaws.pi#ListPerformanceAnalysisReportsResponse": { "type": "structure", "members": { - "MetricDimensions": { - "target": "com.amazonaws.pi#MetricDimensionsList", + "AnalysisReports": { + "target": "com.amazonaws.pi#AnalysisReportSummaryList", "traits": { - "smithy.api#documentation": "The dimension information returned for requested metric types.
" + "smithy.api#documentation": "List of reports including the report identifier, start and end time, creation time,\n and status.
" } }, "NextToken": { "target": "com.amazonaws.pi#NextToken", "traits": { - "smithy.api#documentation": "An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the token, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. \n If this parameter is specified, the response includes only records beyond the token, \n up to the value specified by MaxResults.
Retrieve metrics of the specified types that can be queried for a specified DB instance.\n
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } + "smithy.api#documentation": "Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
" } }, - "com.amazonaws.pi#ListAvailableResourceMetricsRequest": { + "com.amazonaws.pi#ListTagsForResourceRequest": { "type": "structure", "members": { "ServiceType": { "target": "com.amazonaws.pi#ServiceType", "traits": { - "smithy.api#documentation": "The Amazon Web Services service for which Performance Insights returns metrics.
", - "smithy.api#required": {} - } - }, - "Identifier": { - "target": "com.amazonaws.pi#RequestString", - "traits": { - "smithy.api#documentation": "An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers\n metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its\n DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.
The types of metrics to return in the response. Valid values in the array include the following:
\n\n os (OS counter metrics) - All engines
\n db (DB load metrics) - All engines except for Amazon DocumentDB
\n db.sql.stats (per-SQL metrics) - All engines except for Amazon DocumentDB
\n db.sql_tokenized.stats (per-SQL digest metrics) - All engines except for Amazon DocumentDB
Lists all the tags for the Amazon RDS Performance Insights resource. This value is an \n Amazon Resource Name (ARN). For information about creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).
", "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.pi#NextToken", - "traits": { - "smithy.api#documentation": "An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the token, up to the value specified by MaxRecords.\n
The maximum number of items to return. If the MaxRecords value is less than the number \n of existing items, the response includes a pagination token.
An array of metrics available to query. Each array element contains the full name, \n description, and unit of the metric.\n
" - } - }, - "NextToken": { - "target": "com.amazonaws.pi#NextToken", + "Tags": { + "target": "com.amazonaws.pi#TagList", "traits": { - "smithy.api#documentation": "A pagination token that indicates the response didn’t return all available records because MaxRecords was specified in the\n previous request. To get the remaining records, specify NextToken in a separate request with this value.
The metadata assigned to an Amazon RDS resource consisting of a key-value pair.
" } } }, @@ -1000,6 +1664,17 @@ "smithy.api#output": {} } }, + "com.amazonaws.pi#MarkdownString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8000 + }, + "smithy.api#pattern": "^(.|\\n)*$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.pi#MaxResults": { "type": "integer", "traits": { @@ -1128,7 +1803,7 @@ "min": 1, "max": 8192 }, - "smithy.api#pattern": "^[\\s\\S]*$" + "smithy.api#pattern": "^[a-zA-Z0-9_=-]+$" } }, "com.amazonaws.pi#NotAuthorizedException": { @@ -1143,16 +1818,57 @@ "smithy.api#error": "client" } }, + "com.amazonaws.pi#PerformanceInsightsMetric": { + "type": "structure", + "members": { + "Metric": { + "target": "com.amazonaws.pi#DescriptiveString", + "traits": { + "smithy.api#documentation": "The Performance Insights metric.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.pi#DescriptiveString", + "traits": { + "smithy.api#documentation": "The Performance Insights metric name.
" + } + }, + "Dimensions": { + "target": "com.amazonaws.pi#DescriptiveMap", + "traits": { + "smithy.api#documentation": "A dimension map that contains the dimensions for this partition.
" + } + }, + "Value": { + "target": "com.amazonaws.pi#Double", + "traits": { + "smithy.api#documentation": "The value of the metric. For example, 9 for db.load.avg.
This data type helps to determine Performance Insights metric to render for the insight.
" + } + }, "com.amazonaws.pi#PerformanceInsightsv20180227": { "type": "service", "version": "2018-02-27", "operations": [ + { + "target": "com.amazonaws.pi#CreatePerformanceAnalysisReport" + }, + { + "target": "com.amazonaws.pi#DeletePerformanceAnalysisReport" + }, { "target": "com.amazonaws.pi#DescribeDimensionKeys" }, { "target": "com.amazonaws.pi#GetDimensionKeyDetails" }, + { + "target": "com.amazonaws.pi#GetPerformanceAnalysisReport" + }, { "target": "com.amazonaws.pi#GetResourceMetadata" }, @@ -1164,6 +1880,18 @@ }, { "target": "com.amazonaws.pi#ListAvailableResourceMetrics" + }, + { + "target": "com.amazonaws.pi#ListPerformanceAnalysisReports" + }, + { + "target": "com.amazonaws.pi#ListTagsForResource" + }, + { + "target": "com.amazonaws.pi#TagResource" + }, + { + "target": "com.amazonaws.pi#UntagResource" } ], "traits": { @@ -1243,52 +1971,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -1296,13 +2028,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -1312,224 +2053,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://pi-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://pi-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [ + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ + true, { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://pi-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://pi-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://pi.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://pi.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://pi.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://pi.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -2139,6 +2831,32 @@ } } }, + "com.amazonaws.pi#Recommendation": { + "type": "structure", + "members": { + "RecommendationId": { + "target": "com.amazonaws.pi#String", + "traits": { + "smithy.api#documentation": "The unique identifier for the recommendation.
" + } + }, + "RecommendationDescription": { + "target": "com.amazonaws.pi#MarkdownString", + "traits": { + "smithy.api#documentation": "The recommendation details to help resolve the performance issue. For example, \n Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id\n
The list of recommendations for the insight.
" + } + }, + "com.amazonaws.pi#RecommendationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pi#Recommendation" + } + }, "com.amazonaws.pi#RequestString": { "type": "string", "traits": { @@ -2264,6 +2982,29 @@ } } }, + "com.amazonaws.pi#Severity": { + "type": "enum", + "members": { + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + } + } + }, "com.amazonaws.pi#String": { "type": "string", "traits": { @@ -2273,6 +3014,207 @@ }, "smithy.api#pattern": "\\S" } + }, + "com.amazonaws.pi#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.pi#TagKey", + "traits": { + "smithy.api#documentation": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode \n characters in length and can't be prefixed with aws: or rds:. \n The string can only contain only the set of Unicode letters, digits, \n white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").
A value is the optional value of the tag. The string value can be from 1 to 256 \n Unicode characters in length and can't be prefixed with aws: or rds:. \n The string can only contain only the set of Unicode letters, digits, \n white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
" + } + }, + "com.amazonaws.pi#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.pi#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.pi#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.pi#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.pi#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.pi#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.pi#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.pi#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pi#InternalServiceError" + }, + { + "target": "com.amazonaws.pi#InvalidArgumentException" + }, + { + "target": "com.amazonaws.pi#NotAuthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Adds metadata tags to the Amazon RDS Performance Insights resource.
" + } + }, + "com.amazonaws.pi#TagResourceRequest": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.pi#ServiceType", + "traits": { + "smithy.api#documentation": "The Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.
The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, see \n Constructing an RDS Amazon Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.pi#TagList", + "traits": { + "smithy.api#documentation": "The metadata assigned to an Amazon RDS resource consisting of a key-value pair.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pi#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pi#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.pi#TextFormat": { + "type": "enum", + "members": { + "PLAIN_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLAIN_TEXT" + } + }, + "MARKDOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MARKDOWN" + } + } + } + }, + "com.amazonaws.pi#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.pi#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.pi#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pi#InternalServiceError" + }, + { + "target": "com.amazonaws.pi#InvalidArgumentException" + }, + { + "target": "com.amazonaws.pi#NotAuthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the metadata tags from the Amazon RDS Performance Insights resource.
" + } + }, + "com.amazonaws.pi#UntagResourceRequest": { + "type": "structure", + "members": { + "ServiceType": { + "target": "com.amazonaws.pi#ServiceType", + "traits": { + "smithy.api#documentation": "List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.
The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, see \n Constructing an RDS Amazon Resource Name (ARN).
", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.pi#TagKeyList", + "traits": { + "smithy.api#documentation": "The metadata assigned to an Amazon RDS Performance Insights resource consisting of a key-value pair.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pi#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } } } } diff --git a/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json b/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json index d4ba12b753e..6cae8f4b304 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json +++ b/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json @@ -100,12 +100,28 @@ "traits": { "smithy.api#documentation": "The status of your account subscription.
" } + }, + "IAMIdentityCenterInstanceArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM Identity Center instance.
" + } } }, "traits": { "smithy.api#documentation": "A structure that contains the following account information\n elements:
\nYour Amazon QuickSight account name.
\nThe edition of Amazon QuickSight that your account is using.
\nThe notification email address that is associated with the Amazon QuickSight account.\n
\nThe authentication type of the Amazon QuickSight account.
\nThe status of the Amazon QuickSight account's subscription.
\nThe name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change\n AccountName value after the Amazon QuickSight account is\n created.
The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is HIDDEN, all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE.
The layout for the row dimension headers of a pivot table. Choose one of the following options.
\n\n TABULAR: (Default) Each row field is displayed in a separate column.
\n HIERARCHY: All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.
The options for the label that is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.
The default cell width of the pivot table.
" + } } }, "traits": { @@ -33042,6 +33118,52 @@ "smithy.api#documentation": "The paginated report options for a pivot table visual.
" } }, + "com.amazonaws.quicksight#PivotTableRowsLabelOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "The visibility of the rows label.
" + } + }, + "CustomLabel": { + "target": "com.amazonaws.quicksight#PivotTableRowsLabelText", + "traits": { + "smithy.api#documentation": "The custom label string for the rows label.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The options for the label thta is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.
Determines the list of row alternate colors.
" } + }, + "UsePrimaryBackgroundColor": { + "target": "com.amazonaws.quicksight#WidgetStatus", + "traits": { + "smithy.api#documentation": "The primary background color options for alternate rows.
" + } } }, "traits": { @@ -39744,7 +39836,7 @@ "FormatType": { "target": "com.amazonaws.quicksight#SnapshotFileFormatType", "traits": { - "smithy.api#documentation": "The format of the snapshot file to be generated. You can choose between CSV and PDF.
The format of the snapshot file to be generated. You can choose between CSV or PDF.
The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV or PDF format types.
", + "smithy.api#documentation": "The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV and PDF format types.
", "smithy.api#required": {} } }, @@ -39828,7 +39920,7 @@ "VisualIds": { "target": "com.amazonaws.quicksight#SnapshotFileSheetSelectionVisualIdList", "traits": { - "smithy.api#documentation": "\n A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV. This value supports a maximum of 1 visual ID.\n
" + "smithy.api#documentation": "\n A list of visual IDs that are located in the selected sheet. This structure supports tables and pivot tables. This structure is required if you are generating a CSV. You can add a maximum of 1 visual ID to this structure.\n
" } } }, @@ -40543,7 +40635,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts an asynchronous job that generates a dashboard snapshot. You can request up to one paginated PDF and up to five CSVs per API call.
\nPoll job descriptions with a DescribeDashboardSnapshotJob API call. Once the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain the download URIs that the job generates.
Starts an asynchronous job that generates a dashboard snapshot. You can request one of the following format configurations per API call.
\n1 paginated PDF
\n5 CSVs
\nPoll job descriptions with a DescribeDashboardSnapshotJob API call. Once the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain the download URIs that the job generates.
The configuration that defines the default value of a String parameter when a value has not been set.
The cell styling options for the subtotals of header cells.
" } + }, + "StyleTargets": { + "target": "com.amazonaws.quicksight#TableStyleTargetList", + "traits": { + "smithy.api#documentation": "The style targets options for subtotals.
" + } } }, "traits": { @@ -41663,6 +41784,33 @@ "smithy.api#documentation": "The sort configuration for a TableVisual.
The cell type of the table style target.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The table style target.
" + } + }, + "com.amazonaws.quicksight#TableStyleTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TableStyleTarget" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, "com.amazonaws.quicksight#TableTotalsPlacement": { "type": "enum", "members": { @@ -43630,6 +43778,12 @@ "traits": { "smithy.api#documentation": "The other\n names or aliases for the calculated field cell value.
" } + }, + "NonAdditive": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "The non additive for the table style target.
" + } } }, "traits": { @@ -43739,7 +43893,7 @@ "Aggregation": { "target": "com.amazonaws.quicksight#DefaultAggregation", "traits": { - "smithy.api#documentation": "The type of aggregation that is performed on the column data when\n it's queried. Valid values for this structure are SUM, MAX,\n MIN, COUNT,\n DISTINCT_COUNT, and AVERAGE.
The type of aggregation that is performed on the column data when\n it's queried.
" } }, "IsIncludedInTopic": { @@ -43803,6 +43957,12 @@ "traits": { "smithy.api#documentation": "The other names or aliases for the column cell value.
" } + }, + "NonAdditive": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "The non additive value for the column.
" + } } }, "traits": { @@ -49186,6 +49346,12 @@ "traits": { "smithy.api#enumValue": "BOTTOM" } + }, + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json b/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json index d42a1cdaece..4693921e0c7 100644 --- a/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json +++ b/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json @@ -202,7 +202,7 @@ "ClientRequestToken": { "target": "com.amazonaws.rekognition#ClientRequestToken", "traits": { - "smithy.api#documentation": "Idempotent token used to identify the request to AssociateFaces. If you use\n the same token with multiple AssociateFaces requests, the same response is returned.\n Use ClientRequestToken to prevent the same request from being processed more than\n once.
Idempotent token used to identify the request to AssociateFaces. If you use\n the same token with multiple AssociateFaces requests, the same response is\n returned. Use ClientRequestToken to prevent the same request from being processed more than\n once.
The Base64-encoded bytes representing an image selected from the Face Liveness video and returned for audit purposes.
" + "smithy.api#documentation": "The Base64-encoded bytes representing an image selected from the Face Liveness video and\n returned for audit purposes.
" } }, "S3Object": { @@ -413,7 +413,7 @@ } }, "traits": { - "smithy.api#documentation": "An image that is picked from the Face Liveness video and returned for audit trail purposes, returned as Base64-encoded bytes.
" + "smithy.api#documentation": "An image that is picked from the Face Liveness video and returned for audit trail\n purposes, returned as Base64-encoded bytes.
" } }, "com.amazonaws.rekognition#AuditImages": { @@ -1011,7 +1011,7 @@ } }, "traits": { - "smithy.api#documentation": "\n A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. ** \n
", + "smithy.api#documentation": "A User with the same Id already exists within the collection, or the update or deletion\n of the User caused an inconsistent state. **
", "smithy.api#error": "client" } }, @@ -1136,19 +1136,19 @@ "StartTimestampMillis": { "target": "com.amazonaws.rekognition#ULong", "traits": { - "smithy.api#documentation": "The time in milliseconds defining the start of the timeline \n segment containing a continuously detected moderation label.
" + "smithy.api#documentation": "The time in milliseconds defining the start of the timeline segment containing a\n continuously detected moderation label.
" } }, "EndTimestampMillis": { "target": "com.amazonaws.rekognition#ULong", "traits": { - "smithy.api#documentation": "The time in milliseconds defining the end of the \n timeline segment containing a continuously detected moderation label.
" + "smithy.api#documentation": "The time in milliseconds defining the end of the timeline segment containing a\n continuously detected moderation label.
" } }, "DurationMillis": { "target": "com.amazonaws.rekognition#ULong", "traits": { - "smithy.api#documentation": "The time duration of a segment in milliseconds, \n I.e. time elapsed from StartTimestampMillis to EndTimestampMillis.
" + "smithy.api#documentation": "The time duration of a segment in milliseconds, I.e. time elapsed from\n StartTimestampMillis to EndTimestampMillis.
" } } }, @@ -1221,7 +1221,7 @@ "smithy.api#examples": [ { "title": "CopyProjectVersion", - "documentation": "This operation copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project.", + "documentation": "Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project.", "input": { "SourceProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/16565123456", "SourceProjectVersionArn": "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/version/model_1/1656611123456", @@ -1466,7 +1466,28 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using\n an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.
\nTo create a training dataset for a project, specify train for the value of \n DatasetType. To create the test dataset for a project,\n specify test for the value of DatasetType.\n
The response from CreateDataset is the Amazon Resource Name (ARN) for the dataset.\n Creating a dataset takes a while to complete. Use DescribeDataset to check the \n current status. The dataset created successfully if the value of Status is\n CREATE_COMPLETE.
To check if any non-terminal errors occurred, call ListDatasetEntries\nand check for the presence of errors lists in the JSON Lines.
Dataset creation fails if a terminal error occurs (Status = CREATE_FAILED). \n Currently, you can't access the terminal error information.\n \n
For more information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide.
\nThis operation requires permissions to perform the rekognition:CreateDataset action.\n If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries action.
Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using\n an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.
\nTo create a training dataset for a project, specify TRAIN for the value of \n DatasetType. To create the test dataset for a project,\n specify TEST for the value of DatasetType.\n
The response from CreateDataset is the Amazon Resource Name (ARN) for the dataset.\n Creating a dataset takes a while to complete. Use DescribeDataset to check the \n current status. The dataset created successfully if the value of Status is\n CREATE_COMPLETE.
To check if any non-terminal errors occurred, call ListDatasetEntries\nand check for the presence of errors lists in the JSON Lines.
Dataset creation fails if a terminal error occurs (Status = CREATE_FAILED). \n Currently, you can't access the terminal error information.\n \n
For more information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide.
\nThis operation requires permissions to perform the rekognition:CreateDataset action.\n If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries action.
\nThe type of the dataset. Specify train to create a training dataset. Specify test \n to create a test dataset.\n
\nThe type of the dataset. Specify TRAIN to create a training dataset. Specify TEST \n to create a test dataset.\n
This API operation initiates a Face Liveness session. It returns a SessionId,\n which you can use to start streaming Face Liveness video and get the results for a Face\n Liveness session. You can use the OutputConfig option in the Settings parameter\n to provide an Amazon S3 bucket location. The Amazon S3 bucket stores reference images and audit images.\n You can use AuditImagesLimit to limit the number of audit images returned. This\n number is between 0 and 4. By default, it is set to 0. The limit is best effort and based on\n the duration of the selfie-video.
This API operation initiates a Face Liveness session. It returns a SessionId,\n which you can use to start streaming Face Liveness video and get the results for a Face\n Liveness session.
You can use the OutputConfig option in the Settings parameter to provide an\n Amazon S3 bucket location. The Amazon S3 bucket stores reference images and audit images. If no Amazon S3\n bucket is defined, raw bytes are sent instead.
You can use AuditImagesLimit to limit the number of audit images returned\n when GetFaceLivenessSessionResults is called. This number is between 0 and 4. By\n default, it is set to 0. The limit is best effort and based on the duration of the\n selfie-video.
The identifier for your AWS Key Management Service key (AWS KMS key). \n Used to encrypt audit images and reference images.
" + "smithy.api#documentation": "The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt\n audit images and reference images.
" } }, "Settings": { @@ -1584,7 +1605,7 @@ } }, "traits": { - "smithy.api#documentation": "A session settings object. It contains settings for the operation \n to be performed. It accepts arguments for OutputConfig and AuditImagesLimit.
" + "smithy.api#documentation": "A session settings object. It contains settings for the operation to be performed. It\n accepts arguments for OutputConfig and AuditImagesLimit.
" } }, "com.amazonaws.rekognition#CreateFaceLivenessSessionResponse": { @@ -1634,7 +1655,19 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new Amazon Rekognition Custom Labels project. A project is a group of resources (datasets, model versions) \n that you use to create and manage Amazon Rekognition Custom Labels models.
\nThis operation requires permissions to perform the rekognition:CreateProject action.
Creates a new Amazon Rekognition Custom Labels project. A project is a group of resources (datasets, model versions) \n that you use to create and manage Amazon Rekognition Custom Labels models.
\nThis operation requires permissions to perform the rekognition:CreateProject action.
Creates a new version of a model and begins training. \n Models are managed as part of an Amazon Rekognition Custom Labels project. \n The response from CreateProjectVersion\n is an Amazon Resource Name (ARN) for the version of the model.
Training uses the training and test datasets associated with the project. \n For more information, see Creating training and test dataset in the Amazon Rekognition Custom Labels Developer Guide.\n
\nYou can train a model in a project that doesn't have associated datasets by specifying manifest files in the\n TrainingData and TestingData fields.\n
If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates\n the datasets for you using the most recent manifest files. You can no longer train\n a model version for the project by specifying manifest files.
\nInstead of training with a project without associated datasets,\n we recommend that you use the manifest\n files to create training and test datasets for the project.
\nTraining takes a while to complete. You can get the current status by calling\n DescribeProjectVersions. Training completed successfully if\n the value of the Status field is TRAINING_COMPLETED.
If training \n fails, see Debugging a failed model training in the Amazon Rekognition Custom Labels developer guide.
\nOnce training has successfully completed, call DescribeProjectVersions to\n get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model\n in the Amazon Rekognition Custom Labels developers guide.\n
\nAfter evaluating the model, you start the model\n by calling StartProjectVersion.
\nThis operation requires permissions to perform the rekognition:CreateProjectVersion action.
Creates a new version of a model and begins training. \n Models are managed as part of an Amazon Rekognition Custom Labels project. \n The response from CreateProjectVersion\n is an Amazon Resource Name (ARN) for the version of the model.
Training uses the training and test datasets associated with the project. \n For more information, see Creating training and test dataset in the Amazon Rekognition Custom Labels Developer Guide.\n
\nYou can train a model in a project that doesn't have associated datasets by specifying manifest files in the\n TrainingData and TestingData fields.\n
If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates\n the datasets for you using the most recent manifest files. You can no longer train\n a model version for the project by specifying manifest files.
\nInstead of training with a project without associated datasets,\n we recommend that you use the manifest\n files to create training and test datasets for the project.
\nTraining takes a while to complete. You can get the current status by calling\n DescribeProjectVersions. Training completed successfully if\n the value of the Status field is TRAINING_COMPLETED.
If training \n fails, see Debugging a failed model training in the Amazon Rekognition Custom Labels developer guide.
\nOnce training has successfully completed, call DescribeProjectVersions to\n get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model\n in the Amazon Rekognition Custom Labels developers guide.\n
\nAfter evaluating the model, you start the model\n by calling StartProjectVersion.
\nThis operation requires permissions to perform the rekognition:CreateProjectVersion action.
Creates a new User within a collection specified by CollectionId. Takes\n UserId as a parameter, which is a user provided ID which should be unique\n within the collection. The provided UserId will alias the system generated\n UUID to make the UserId more user friendly.
Uses a ClientToken, an idempotency token that ensures a call to\n CreateUser completes only once. If the value is not supplied, the AWS SDK\n generates an idempotency token for the requests. This prevents retries after a network\n error results from making multiple CreateUser calls.
Creates a new User within a collection specified by CollectionId. Takes\n UserId as a parameter, which is a user provided ID which should be unique\n within the collection. The provided UserId will alias the system generated UUID\n to make the UserId more user friendly.
Uses a ClientToken, an idempotency token that ensures a call to\n CreateUser completes only once. If the value is not supplied, the AWS SDK\n generates an idempotency token for the requests. This prevents retries after a network error\n results from making multiple CreateUser calls.
Idempotent token used to identify the request to CreateUser. If you use the\n same token with multiple CreateUser requests, the same response is returned. \n Use ClientRequestToken to prevent the same request from being processed more than\n once.
Idempotent token used to identify the request to CreateUser. If you use the\n same token with multiple CreateUser requests, the same response is returned. Use\n ClientRequestToken to prevent the same request from being processed more than once.
Deletes an existing Amazon Rekognition Custom Labels dataset.\n Deleting a dataset might take while. Use DescribeDataset to check the \n current status. The dataset is still deleting if the value of Status is\n DELETE_IN_PROGRESS. If you try to access the dataset after it is deleted, you get\n a ResourceNotFoundException exception.\n\n
You can't delete a dataset while it is creating (Status = CREATE_IN_PROGRESS)\n or if the dataset is updating (Status = UPDATE_IN_PROGRESS).
This operation requires permissions to perform the rekognition:DeleteDataset action.
Deletes an existing Amazon Rekognition Custom Labels dataset.\n Deleting a dataset might take while. Use DescribeDataset to check the \n current status. The dataset is still deleting if the value of Status is\n DELETE_IN_PROGRESS. If you try to access the dataset after it is deleted, you get\n a ResourceNotFoundException exception.\n\n
You can't delete a dataset while it is creating (Status = CREATE_IN_PROGRESS)\n or if the dataset is updating (Status = UPDATE_IN_PROGRESS).
This operation requires permissions to perform the rekognition:DeleteDataset action.
Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated \n with the project. To delete a model, see DeleteProjectVersion.
\n\n DeleteProject is an asynchronous operation. To check if the project is\n deleted, call DescribeProjects. The project is deleted when the project\n no longer appears in the response. Be aware that deleting a given project will also delete\n any ProjectPolicies associated with that project.
This operation requires permissions to perform the\n rekognition:DeleteProject action.
Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated \n with the project. To delete a model, see DeleteProjectVersion.
\n\n DeleteProject is an asynchronous operation. To check if the project is\n deleted, call DescribeProjects. The project is deleted when the project\n no longer appears in the response. Be aware that deleting a given project will also delete\n any ProjectPolicies associated with that project.
This operation requires permissions to perform the\n rekognition:DeleteProject action.
Deletes an Amazon Rekognition Custom Labels model.
\nYou can't delete a model if it is running or if it is training. \n To check the status of a model, use the Status field returned\n from DescribeProjectVersions.\n To stop a running model call StopProjectVersion. If the model\n is training, wait until it finishes.
This operation requires permissions to perform the\n rekognition:DeleteProjectVersion action.
Deletes an Amazon Rekognition Custom Labels model.
\nYou can't delete a model if it is running or if it is training. \n To check the status of a model, use the Status field returned\n from DescribeProjectVersions.\n To stop a running model call StopProjectVersion. If the model\n is training, wait until it finishes.
This operation requires permissions to perform the\n rekognition:DeleteProjectVersion action.
Idempotent token used to identify the request to DeleteUser. If you use the\n same token with multiple DeleteUser requests, the same response is returned. \n Use ClientRequestToken to prevent the same request from being processed more than\n once.
Idempotent token used to identify the request to DeleteUser. If you use the\n same token with multiple DeleteUser requests, the same response is returned. Use\n ClientRequestToken to prevent the same request from being processed more than once.
Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.
\nYou specify which version of a model version to use by using the ProjectVersionArn input\n parameter.
You pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing\n image bytes is not supported. The image must be either a PNG or JPEG formatted file.
\n For each object that the model version detects on an image, the API returns a \n (CustomLabel) object in an array (CustomLabels).\n Each CustomLabel object provides the label name (Name), the level\n of confidence that the image contains the object (Confidence), and \n object location information, if it exists, for the label on the image (Geometry).
To filter labels that are returned, specify a value for MinConfidence.\n DetectCustomLabelsLabels only returns labels with a confidence that's higher than\n the specified value.\n\n The value of MinConfidence maps to the assumed threshold values\n created during training. For more information, see Assumed threshold\n in the Amazon Rekognition Custom Labels Developer Guide. \n Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of\n MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence\n responses from DetectCustomLabels are also returned as a percentage. \n You can use MinConfidence to change the precision and recall or your model. \n For more information, see \n Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.
If you don't specify a value for MinConfidence, DetectCustomLabels\n returns labels based on the assumed threshold of each label.
This is a stateless API operation. That is, the operation does not persist any\n data.
\nThis operation requires permissions to perform the\n rekognition:DetectCustomLabels action.
For more information, see \n Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.
" + "smithy.api#documentation": "Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.
\nYou specify which version of a model version to use by using the ProjectVersionArn input\n parameter.
You pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing\n image bytes is not supported. The image must be either a PNG or JPEG formatted file.
\n For each object that the model version detects on an image, the API returns a \n (CustomLabel) object in an array (CustomLabels).\n Each CustomLabel object provides the label name (Name), the level\n of confidence that the image contains the object (Confidence), and \n object location information, if it exists, for the label on the image (Geometry).
To filter labels that are returned, specify a value for MinConfidence.\n DetectCustomLabelsLabels only returns labels with a confidence that's higher than\n the specified value.\n\n The value of MinConfidence maps to the assumed threshold values\n created during training. For more information, see Assumed threshold\n in the Amazon Rekognition Custom Labels Developer Guide. \n Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of\n MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence\n responses from DetectCustomLabels are also returned as a percentage. \n You can use MinConfidence to change the precision and recall or your model. \n For more information, see \n Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.
If you don't specify a value for MinConfidence, DetectCustomLabels\n returns labels based on the assumed threshold of each label.
This is a stateless API operation. That is, the operation does not persist any\n data.
\nThis operation requires permissions to perform the\n rekognition:DetectCustomLabels action.
For more information, see \n Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.
", + "smithy.api#examples": [ + { + "title": "To detect custom labels in an image with an Amazon Rekognition Custom Labels model", + "documentation": "Detects custom labels in an image with an Amazon Rekognition Custom Labels model", + "input": { + "ProjectVersionArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/my-project.2023-07-31T11.49.37/1690829378219", + "Image": { + "S3Object": { + "Bucket": "custom-labels-console-us-east-1-1111111111", + "Name": "assets/flowers_1_test_dataset/camellia4.jpg" + } + }, + "MaxResults": 100, + "MinConfidence": 50 + }, + "output": { + "CustomLabels": [ + { + "Name": "with_leaves", + "Confidence": 67.56399536132812 + }, + { + "Name": "without_leaves", + "Confidence": 50.65699768066406 + } + ] + } + } + ] } }, "com.amazonaws.rekognition#DetectCustomLabelsRequest": { @@ -3665,7 +3778,7 @@ "Attributes": { "target": "com.amazonaws.rekognition#Attributes", "traits": { - "smithy.api#documentation": "An array of facial attributes you want to be returned. A DEFAULT subset of\n facial attributes - BoundingBox, Confidence, Pose,\n Quality, and Landmarks - will always be returned. You can request\n for specific facial attributes (in addition to the default list) - by using [\"DEFAULT\",\n \"FACE_OCCLUDED\"] or just [\"FACE_OCCLUDED\"]. You can request for all\n facial attributes by using [\"ALL\"]. Requesting more attributes may increase\n response time.
If you provide both, [\"ALL\", \"DEFAULT\"], the service uses a logical \"AND\"\n operator to determine which attributes to return (in this case, all attributes).
An array of facial attributes you want to be returned. A DEFAULT subset of\n facial attributes - BoundingBox, Confidence, Pose,\n Quality, and Landmarks - will always be returned. You can request\n for specific facial attributes (in addition to the default list) - by using [\"DEFAULT\",\n \"FACE_OCCLUDED\"] or just [\"FACE_OCCLUDED\"]. You can request for all\n facial attributes by using [\"ALL\"]. Requesting more attributes may increase\n response time.
If you provide both, [\"ALL\", \"DEFAULT\"], the service uses a logical \"AND\"\n operator to determine which attributes to return (in this case, all attributes).
Note that while the FaceOccluded and EyeDirection attributes are supported when using\n DetectFaces, they aren't supported when analyzing videos with\n StartFaceDetection and GetFaceDetection.
Detects instances of real-world entities within an image (JPEG or PNG) provided as\n input. This includes objects like flower, tree, and table; events like wedding, graduation,\n and birthday party; and concepts like landscape, evening, and nature.
\nFor an example, see Analyzing images stored in an Amazon S3 bucket in the\n Amazon Rekognition Developer Guide.
\nYou pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.
\n\n Optional Parameters\n
\nYou can specify one or both of the GENERAL_LABELS and\n IMAGE_PROPERTIES feature types when calling the DetectLabels API. Including\n GENERAL_LABELS will ensure the response includes the labels detected in the\n input image, while including IMAGE_PROPERTIES will ensure the response includes\n information about the image quality and color.
When using GENERAL_LABELS and/or IMAGE_PROPERTIES you can\n provide filtering criteria to the Settings parameter. You can filter with sets of individual\n labels or with label categories. You can specify inclusive filters, exclusive filters, or a\n combination of inclusive and exclusive filters. For more information on filtering see Detecting\n Labels in an Image.
You can specify MinConfidence to control the confidence threshold for the\n labels returned. The default is 55%. You can also add the MaxLabels parameter to\n limit the number of labels returned. The default and upper limit is 1000 labels.
\n Response Elements\n
\nFor each object, scene, and concept the API returns one or more labels. The API\n returns the following types of information about labels:
\nName - The name of the detected label.
\nConfidence - The level of confidence in the label assigned to a detected object.\n
\nParents - The ancestor labels for a detected label. DetectLabels returns a\n hierarchical taxonomy of detected labels. For example, a detected car might be assigned\n the label car. The label car has two parent labels: Vehicle (its parent) and\n Transportation (its grandparent). The response includes the all ancestors for a label,\n where every ancestor is a unique label. In the previous example, Car, Vehicle, and\n Transportation are returned as unique labels in the response.
\nAliases - Possible Aliases for the label.
\nCategories - The label categories that the detected label belongs to.
\nBoundingBox — Bounding boxes are described for all instances of detected common\n object labels, returned in an array of Instance objects. An Instance object contains a\n BoundingBox object, describing the location of the label on the input image. It also\n includes the confidence for the accuracy of the detected bounding box.
\nThe API returns the following information regarding the image, as part of the\n ImageProperties structure:
\nQuality - Information about the Sharpness, Brightness, and Contrast of the input\n image, scored between 0 to 100. Image quality is returned for the entire image, as well as\n the background and the foreground.
\nDominant Color - An array of the dominant colors in the image.
\nForeground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground.
\nBackground - Information about the sharpness, brightness, and dominant colors of the input image’s background.
\nThe list of returned labels will include at least one label for every detected object,\n along with information about that label. In the following example, suppose the input image has\n a lighthouse, the sea, and a rock. The response includes all three labels, one for each\n object, as well as the confidence in the label:
\n\n {Name: lighthouse, Confidence: 98.4629}\n
\n {Name: rock,Confidence: 79.2097}\n
\n {Name: sea,Confidence: 75.061}\n
The list of labels can include multiple labels for the same object. For example, if the\n input image shows a flower (for example, a tulip), the operation might return the following\n three labels.
\n\n {Name: flower,Confidence: 99.0562}\n
\n {Name: plant,Confidence: 99.0562}\n
\n {Name: tulip,Confidence: 99.0562}\n
In this example, the detection algorithm more precisely identifies the flower as a\n tulip.
\nIf the object detected is a person, the operation doesn't provide the same facial\n details that the DetectFaces operation provides.
\nThis is a stateless API operation that doesn't return any data.
\nThis operation requires permissions to perform the\n rekognition:DetectLabels action.
Detects instances of real-world entities within an image (JPEG or PNG) provided as\n input. This includes objects like flower, tree, and table; events like wedding, graduation,\n and birthday party; and concepts like landscape, evening, and nature.
\nFor an example, see Analyzing images stored in an Amazon S3 bucket in the\n Amazon Rekognition Developer Guide.
\nYou pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.
\n\n Optional Parameters\n
\nYou can specify one or both of the GENERAL_LABELS and\n IMAGE_PROPERTIES feature types when calling the DetectLabels API. Including\n GENERAL_LABELS will ensure the response includes the labels detected in the\n input image, while including IMAGE_PROPERTIES will ensure the response includes\n information about the image quality and color.
When using GENERAL_LABELS and/or IMAGE_PROPERTIES you can\n provide filtering criteria to the Settings parameter. You can filter with sets of individual\n labels or with label categories. You can specify inclusive filters, exclusive filters, or a\n combination of inclusive and exclusive filters. For more information on filtering see Detecting\n Labels in an Image.
When getting labels, you can specify MinConfidence to control the\n confidence threshold for the labels returned. The default is 55%. You can also add the\n MaxLabels parameter to limit the number of labels returned. The default and\n upper limit is 1000 labels. These arguments are only valid when supplying GENERAL_LABELS as a\n feature type.
\n Response Elements\n
\nFor each object, scene, and concept the API returns one or more labels. The API\n returns the following types of information about labels:
\nName - The name of the detected label.
\nConfidence - The level of confidence in the label assigned to a detected object.\n
\nParents - The ancestor labels for a detected label. DetectLabels returns a\n hierarchical taxonomy of detected labels. For example, a detected car might be assigned\n the label car. The label car has two parent labels: Vehicle (its parent) and\n Transportation (its grandparent). The response includes the all ancestors for a label,\n where every ancestor is a unique label. In the previous example, Car, Vehicle, and\n Transportation are returned as unique labels in the response.
\nAliases - Possible Aliases for the label.
\nCategories - The label categories that the detected label belongs to.
\nBoundingBox — Bounding boxes are described for all instances of detected common\n object labels, returned in an array of Instance objects. An Instance object contains a\n BoundingBox object, describing the location of the label on the input image. It also\n includes the confidence for the accuracy of the detected bounding box.
\nThe API returns the following information regarding the image, as part of the\n ImageProperties structure:
\nQuality - Information about the Sharpness, Brightness, and Contrast of the input\n image, scored between 0 to 100. Image quality is returned for the entire image, as well as\n the background and the foreground.
\nDominant Color - An array of the dominant colors in the image.
\nForeground - Information about the sharpness, brightness, and dominant colors of the\n input image’s foreground.
\nBackground - Information about the sharpness, brightness, and dominant colors of the\n input image’s background.
\nThe list of returned labels will include at least one label for every detected object,\n along with information about that label. In the following example, suppose the input image has\n a lighthouse, the sea, and a rock. The response includes all three labels, one for each\n object, as well as the confidence in the label:
\n\n {Name: lighthouse, Confidence: 98.4629}\n
\n {Name: rock,Confidence: 79.2097}\n
\n {Name: sea,Confidence: 75.061}\n
The list of labels can include multiple labels for the same object. For example, if the\n input image shows a flower (for example, a tulip), the operation might return the following\n three labels.
\n\n {Name: flower,Confidence: 99.0562}\n
\n {Name: plant,Confidence: 99.0562}\n
\n {Name: tulip,Confidence: 99.0562}\n
In this example, the detection algorithm more precisely identifies the flower as a\n tulip.
\nIf the object detected is a person, the operation doesn't provide the same facial\n details that the DetectFaces operation provides.
\nThis is a stateless API operation that doesn't return any data.
\nThis operation requires permissions to perform the\n rekognition:DetectLabels action.
The dominant colors found in the background of an image, defined with RGB values, \n CSS color name, simplified color name, and PixelPercentage (the percentage of \n image pixels that have a particular color).
" + "smithy.api#documentation": "The dominant colors found in the background of an image, defined with RGB values, CSS\n color name, simplified color name, and PixelPercentage (the percentage of image pixels that\n have a particular color).
" } } }, @@ -3820,7 +3933,7 @@ "DominantColors": { "target": "com.amazonaws.rekognition#DominantColors", "traits": { - "smithy.api#documentation": "The dominant colors found in the foreground of an image, defined with RGB values, \n CSS color name, simplified color name, and PixelPercentage (the percentage of image \n pixels that have a particular color).
" + "smithy.api#documentation": "The dominant colors found in the foreground of an image, defined with RGB values, CSS\n color name, simplified color name, and PixelPercentage (the percentage of image pixels that\n have a particular color).
" } } }, @@ -3834,30 +3947,30 @@ "Quality": { "target": "com.amazonaws.rekognition#DetectLabelsImageQuality", "traits": { - "smithy.api#documentation": "Information about the quality of the image foreground as defined by brightness, \n sharpness, and contrast. The higher the value the greater the brightness, \n sharpness, and contrast respectively.
" + "smithy.api#documentation": "Information about the quality of the image foreground as defined by brightness, sharpness,\n and contrast. The higher the value the greater the brightness, sharpness, and contrast\n respectively.
" } }, "DominantColors": { "target": "com.amazonaws.rekognition#DominantColors", "traits": { - "smithy.api#documentation": "Information about the dominant colors found in an image, described with RGB values, \n CSS color name, simplified color name, and PixelPercentage (the percentage of image pixels \n that have a particular color).
" + "smithy.api#documentation": "Information about the dominant colors found in an image, described with RGB values, CSS\n color name, simplified color name, and PixelPercentage (the percentage of image pixels that\n have a particular color).
" } }, "Foreground": { "target": "com.amazonaws.rekognition#DetectLabelsImageForeground", "traits": { - "smithy.api#documentation": "Information about the properties of an image’s foreground, including the \n foreground’s quality and dominant colors, including the quality and dominant colors of the image.
" + "smithy.api#documentation": "Information about the properties of an image’s foreground, including the foreground’s\n quality and dominant colors, including the quality and dominant colors of the image.
" } }, "Background": { "target": "com.amazonaws.rekognition#DetectLabelsImageBackground", "traits": { - "smithy.api#documentation": "Information about the properties of an image’s background, including \n the background’s quality and dominant colors, including the quality \n and dominant colors of the image.
" + "smithy.api#documentation": "Information about the properties of an image’s background, including the background’s\n quality and dominant colors, including the quality and dominant colors of the image.
" } } }, "traits": { - "smithy.api#documentation": "Information about the quality and dominant colors of an input image. \n Quality and color information is returned for the entire image, foreground, and background.
" + "smithy.api#documentation": "Information about the quality and dominant colors of an input image. Quality and color\n information is returned for the entire image, foreground, and background.
" } }, "com.amazonaws.rekognition#DetectLabelsImagePropertiesSettings": { @@ -3867,7 +3980,7 @@ "target": "com.amazonaws.rekognition#DetectLabelsMaxDominantColors", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of dominant colors to return when detecting labels in an image. The default value is 10.
" + "smithy.api#documentation": "The maximum number of dominant colors to return when detecting labels in an image. The\n default value is 10.
" } } }, @@ -3898,7 +4011,7 @@ } }, "traits": { - "smithy.api#documentation": "The quality of an image provided for label detection, with regard to brightness, sharpness, and contrast.
" + "smithy.api#documentation": "The quality of an image provided for label detection, with regard to brightness,\n sharpness, and contrast.
" } }, "com.amazonaws.rekognition#DetectLabelsMaxDominantColors": { @@ -3924,25 +4037,25 @@ "MaxLabels": { "target": "com.amazonaws.rekognition#UInteger", "traits": { - "smithy.api#documentation": "Maximum number of labels you want the service to return in the response. The service\n returns the specified number of highest confidence labels.
" + "smithy.api#documentation": "Maximum number of labels you want the service to return in the response. The service\n returns the specified number of highest confidence labels. Only valid when GENERAL_LABELS is\n specified as a feature type in the Feature input parameter.
" } }, "MinConfidence": { "target": "com.amazonaws.rekognition#Percent", "traits": { - "smithy.api#documentation": "Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't\n return any labels with confidence lower than this specified value.
\nIf MinConfidence is not specified, the operation returns labels with a\n confidence values greater than or equal to 55 percent.
Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't\n return any labels with confidence lower than this specified value.
\nIf MinConfidence is not specified, the operation returns labels with a\n confidence values greater than or equal to 55 percent. Only valid when GENERAL_LABELS is\n specified as a feature type in the Feature input parameter.
A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label detection \n feature, while specifying IMAGE_PROPERTIES returns information regarding image color and quality. \n If no option is specified GENERAL_LABELS is used by default.
" + "smithy.api#documentation": "A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label\n detection feature, while specifying IMAGE_PROPERTIES returns information regarding image color\n and quality. If no option is specified GENERAL_LABELS is used by default.
" } }, "Settings": { "target": "com.amazonaws.rekognition#DetectLabelsSettings", "traits": { - "smithy.api#documentation": "A list of the filters to be applied to returned detected labels and image properties. Specified \n filters can be inclusive, exclusive, or a combination of both. Filters can be used for individual \n labels or label categories. The exact label names or label categories must be supplied. For \n a full list of labels and label categories, see Detecting labels.
" + "smithy.api#documentation": "A list of the filters to be applied to returned detected labels and image properties.\n Specified filters can be inclusive, exclusive, or a combination of both. Filters can be used\n for individual labels or label categories. The exact label names or label categories must be\n supplied. For a full list of labels and label categories, see Detecting labels.
" } } }, @@ -3974,7 +4087,7 @@ "ImageProperties": { "target": "com.amazonaws.rekognition#DetectLabelsImageProperties", "traits": { - "smithy.api#documentation": "Information about the properties of the input image, such as brightness, sharpness, contrast, and dominant colors.
" + "smithy.api#documentation": "Information about the properties of the input image, such as brightness, sharpness,\n contrast, and dominant colors.
" } } }, @@ -3999,7 +4112,7 @@ } }, "traits": { - "smithy.api#documentation": "Settings for the DetectLabels request. Settings can include \n filters for both GENERAL_LABELS and IMAGE_PROPERTIES. GENERAL_LABELS filters can be inclusive \n or exclusive and applied to individual labels or label categories. IMAGE_PROPERTIES filters \n allow specification of a maximum number of dominant colors.
" + "smithy.api#documentation": "Settings for the DetectLabels request. Settings can include filters for both\n GENERAL_LABELS and IMAGE_PROPERTIES. GENERAL_LABELS filters can be inclusive or exclusive and\n applied to individual labels or label categories. IMAGE_PROPERTIES filters allow specification\n of a maximum number of dominant colors.
" } }, "com.amazonaws.rekognition#DetectModerationLabels": { @@ -4427,7 +4540,7 @@ "UserStatus": { "target": "com.amazonaws.rekognition#UserStatus", "traits": { - "smithy.api#documentation": "The status of an update made to a User. Reflects if the User has been updated for every requested change.
" + "smithy.api#documentation": "The status of an update made to a User. Reflects if the User has been updated for every\n requested change.
" } } }, @@ -4508,7 +4621,24 @@ } ], "traits": { - "smithy.api#documentation": "Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project.\n DistributeDatasetEntries moves 20% of the training dataset images to the test dataset.\n An entry is a JSON Line that describes an image.\n
You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. \n The training dataset must contain the images that you want to split. The test dataset \n must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset.
\nDistributing a dataset takes a while to complete. To check the status call DescribeDataset. The operation\n is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. \n If the dataset split fails, the value of Status is UPDATE_FAILED.
This operation requires permissions to perform the rekognition:DistributeDatasetEntries action.
Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project.\n DistributeDatasetEntries moves 20% of the training dataset images to the test dataset.\n An entry is a JSON Line that describes an image.\n
You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. \n The training dataset must contain the images that you want to split. The test dataset \n must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset.
\nDistributing a dataset takes a while to complete. To check the status call DescribeDataset. The operation\n is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. \n If the dataset split fails, the value of Status is UPDATE_FAILED.
This operation requires permissions to perform the rekognition:DistributeDatasetEntries action.
Indicates the direction the eyes are gazing in (independent of the head pose) as determined by its pitch and yaw.
" + "smithy.api#documentation": "Indicates the direction the eyes are gazing in (independent of the head pose) as\n determined by its pitch and yaw.
" } }, "com.amazonaws.rekognition#EyeOpen": { @@ -5281,7 +5411,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains filters for the object labels returned by DetectLabels. Filters can be inclusive, \n exclusive, or a combination of both and can be applied to individual labels or entire label categories.\n To see a list of label categories, see Detecting Labels.
" + "smithy.api#documentation": "Contains filters for the object labels returned by DetectLabels. Filters can be inclusive,\n exclusive, or a combination of both and can be applied to individual labels or entire label\n categories. To see a list of label categories, see Detecting Labels.
" } }, "com.amazonaws.rekognition#Geometry": { @@ -5486,7 +5616,7 @@ "JobId": { "target": "com.amazonaws.rekognition#JobId", "traits": { - "smithy.api#documentation": "Job identifier for the celebrity recognition operation for which you \n want to obtain results. The job identifer is returned by an initial call \n to StartCelebrityRecognition.
" + "smithy.api#documentation": "Job identifier for the celebrity recognition operation for which you want to obtain\n results. The job identifer is returned by an initial call to StartCelebrityRecognition.
" } }, "Video": { @@ -5495,7 +5625,7 @@ "JobTag": { "target": "com.amazonaws.rekognition#JobTag", "traits": { - "smithy.api#documentation": "A job identifier specified in the call to StartCelebrityRecognition and \n returned in the job completion notification sent to your \n Amazon Simple Notification Service topic.
" + "smithy.api#documentation": "A job identifier specified in the call to StartCelebrityRecognition and returned in the\n job completion notification sent to your Amazon Simple Notification Service topic.
" } } }, @@ -5574,7 +5704,7 @@ "AggregateBy": { "target": "com.amazonaws.rekognition#ContentModerationAggregateBy", "traits": { - "smithy.api#documentation": "Defines how to aggregate results of the StartContentModeration request. \n Default aggregation option is TIMESTAMPS. \n SEGMENTS mode aggregates moderation labels over time.
" + "smithy.api#documentation": "Defines how to aggregate results of the StartContentModeration request. Default\n aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.
" } } }, @@ -5599,7 +5729,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains metadata about a content moderation request, \n including the SortBy and AggregateBy options.
" + "smithy.api#documentation": "Contains metadata about a content moderation request, including the SortBy and AggregateBy\n options.
" } }, "com.amazonaws.rekognition#GetContentModerationResponse": { @@ -5644,7 +5774,7 @@ "JobId": { "target": "com.amazonaws.rekognition#JobId", "traits": { - "smithy.api#documentation": "Job identifier for the content moderation operation for which you \n want to obtain results. The job identifer is returned by an initial call \n to StartContentModeration.
" + "smithy.api#documentation": "Job identifier for the content moderation operation for which you want to obtain results.\n The job identifer is returned by an initial call to StartContentModeration.
" } }, "Video": { @@ -5653,13 +5783,13 @@ "JobTag": { "target": "com.amazonaws.rekognition#JobTag", "traits": { - "smithy.api#documentation": "A job identifier specified in the call to StartContentModeration and \n returned in the job completion notification sent to your \n Amazon Simple Notification Service topic.
" + "smithy.api#documentation": "A job identifier specified in the call to StartContentModeration and returned in the job\n completion notification sent to your Amazon Simple Notification Service topic.
" } }, "GetRequestMetadata": { "target": "com.amazonaws.rekognition#GetContentModerationRequestMetadata", "traits": { - "smithy.api#documentation": "Information about the paramters used when getting a response. Includes \n information on aggregation and sorting methods.
" + "smithy.api#documentation": "Information about the paramters used when getting a response. Includes information on\n aggregation and sorting methods.
" } } }, @@ -5699,7 +5829,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.
\nFace detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling StartFaceDetection\n which returns a job identifier (JobId). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to\n the Amazon Simple Notification Service topic registered in the initial call to StartFaceDetection. To get the results\n of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED.\n If so, call GetFaceDetection and pass the job identifier\n (JobId) from the initial call to StartFaceDetection.
\n GetFaceDetection returns an array of detected faces (Faces) sorted by the time the faces were detected.
Use MaxResults parameter to limit the number of labels returned. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set\n of results. To get the next page of results, call GetFaceDetection and populate the NextToken request parameter with the token\n value returned from the previous call to GetFaceDetection.
Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.
\nFace detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling StartFaceDetection\n which returns a job identifier (JobId). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to\n the Amazon Simple Notification Service topic registered in the initial call to StartFaceDetection. To get the results\n of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED.\n If so, call GetFaceDetection and pass the job identifier\n (JobId) from the initial call to StartFaceDetection.
\n GetFaceDetection returns an array of detected faces (Faces) sorted by the time the faces were detected.
Use MaxResults parameter to limit the number of labels returned. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set\n of results. To get the next page of results, call GetFaceDetection and populate the NextToken request parameter with the token\n value returned from the previous call to GetFaceDetection.
Note that for the GetFaceDetection operation, the returned values for\n FaceOccluded and EyeDirection will always be \"null\".
Job identifier for the face detection operation for which you \n want to obtain results. The job identifer is returned by an initial call \n to StartFaceDetection.
" + "smithy.api#documentation": "Job identifier for the face detection operation for which you want to obtain results. The\n job identifer is returned by an initial call to StartFaceDetection.
" } }, "Video": { @@ -5779,7 +5909,7 @@ "JobTag": { "target": "com.amazonaws.rekognition#JobTag", "traits": { - "smithy.api#documentation": "A job identifier specified in the call to StartFaceDetection and \n returned in the job completion notification sent to your \n Amazon Simple Notification Service topic.
" + "smithy.api#documentation": "A job identifier specified in the call to StartFaceDetection and returned in the job\n completion notification sent to your Amazon Simple Notification Service topic.
" } } }, @@ -5816,7 +5946,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the results of a specific Face Liveness session. It requires the\n sessionId as input, which was created using\n CreateFaceLivenessSession. Returns the corresponding Face Liveness confidence\n score, a reference image that includes a face bounding box, and audit images that also contain\n face bounding boxes. The Face Liveness confidence score ranges from 0 to 100. The reference\n image can optionally be returned.
Retrieves the results of a specific Face Liveness session. It requires the\n sessionId as input, which was created using\n CreateFaceLivenessSession. Returns the corresponding Face Liveness confidence\n score, a reference image that includes a face bounding box, and audit images that also contain\n face bounding boxes. The Face Liveness confidence score ranges from 0 to 100.
The number of audit images returned by GetFaceLivenessSessionResults is\n defined by the AuditImagesLimit paramater when calling\n CreateFaceLivenessSession. Reference images are always returned when\n possible.
Probabalistic confidence score for if the person in the given video was live, represented as a\n float value between 0 to 100.
" + "smithy.api#documentation": "Probabalistic confidence score for if the person in the given video was live, represented\n as a float value between 0 to 100.
" } }, "ReferenceImage": { @@ -5866,7 +5996,7 @@ "AuditImages": { "target": "com.amazonaws.rekognition#AuditImages", "traits": { - "smithy.api#documentation": "A set of images from the Face Liveness video that can be used for audit purposes. It\n includes a bounding box of the face and the Base64-encoded bytes that return an image. If the\n CreateFaceLivenessSession request included an OutputConfig argument, the image will be\n uploaded to an S3Object specified in the output configuration.
" + "smithy.api#documentation": "A set of images from the Face Liveness video that can be used for audit purposes. It\n includes a bounding box of the face and the Base64-encoded bytes that return an image. If the\n CreateFaceLivenessSession request included an OutputConfig argument, the image will be\n uploaded to an S3Object specified in the output configuration. If no Amazon S3 bucket is defined,\n raw bytes are sent instead.
" } } }, @@ -5983,7 +6113,7 @@ "JobId": { "target": "com.amazonaws.rekognition#JobId", "traits": { - "smithy.api#documentation": "Job identifier for the face search operation for which you \n want to obtain results. The job identifer is returned by an initial call \n to StartFaceSearch.
" + "smithy.api#documentation": "Job identifier for the face search operation for which you want to obtain results. The job\n identifer is returned by an initial call to StartFaceSearch.
" } }, "Video": { @@ -5992,7 +6122,7 @@ "JobTag": { "target": "com.amazonaws.rekognition#JobTag", "traits": { - "smithy.api#documentation": "A job identifier specified in the call to StartFaceSearch and \n returned in the job completion notification sent to your \n Amazon Simple Notification Service topic.
" + "smithy.api#documentation": "A job identifier specified in the call to StartFaceSearch and returned in the job\n completion notification sent to your Amazon Simple Notification Service topic.
" } } }, @@ -6096,7 +6226,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains metadata about a label detection request, \n including the SortBy and AggregateBy options.
" + "smithy.api#documentation": "Contains metadata about a label detection request, including the SortBy and AggregateBy\n options.
" } }, "com.amazonaws.rekognition#GetLabelDetectionResponse": { @@ -6141,7 +6271,7 @@ "JobId": { "target": "com.amazonaws.rekognition#JobId", "traits": { - "smithy.api#documentation": "Job identifier for the label detection operation for which you \n want to obtain results. The job identifer is returned by an initial call \n to StartLabelDetection.
" + "smithy.api#documentation": "Job identifier for the label detection operation for which you want to obtain results. The\n job identifer is returned by an initial call to StartLabelDetection.
" } }, "Video": { @@ -6150,13 +6280,13 @@ "JobTag": { "target": "com.amazonaws.rekognition#JobTag", "traits": { - "smithy.api#documentation": "A job identifier specified in the call to StartLabelDetection and \n returned in the job completion notification sent to your \n Amazon Simple Notification Service topic.
" + "smithy.api#documentation": "A job identifier specified in the call to StartLabelDetection and returned in the job\n completion notification sent to your Amazon Simple Notification Service topic.
" } }, "GetRequestMetadata": { "target": "com.amazonaws.rekognition#GetLabelDetectionRequestMetadata", "traits": { - "smithy.api#documentation": "Information about the paramters used when getting a response. Includes \n information on aggregation and sorting methods.
" + "smithy.api#documentation": "Information about the paramters used when getting a response. Includes information on\n aggregation and sorting methods.
" } } }, @@ -6273,7 +6403,7 @@ "JobId": { "target": "com.amazonaws.rekognition#JobId", "traits": { - "smithy.api#documentation": "Job identifier for the person tracking operation for which you \n want to obtain results. The job identifer is returned by an initial call \n to StartPersonTracking.
" + "smithy.api#documentation": "Job identifier for the person tracking operation for which you want to obtain results. The\n job identifer is returned by an initial call to StartPersonTracking.
" } }, "Video": { @@ -6282,7 +6412,7 @@ "JobTag": { "target": "com.amazonaws.rekognition#JobTag", "traits": { - "smithy.api#documentation": "A job identifier specified in the call to StartCelebrityRecognition and \n returned in the job completion notification sent to your \n Amazon Simple Notification Service topic.
" + "smithy.api#documentation": "A job identifier specified in the call to StartCelebrityRecognition and returned in the\n job completion notification sent to your Amazon Simple Notification Service topic.
" } } }, @@ -6405,7 +6535,7 @@ "JobId": { "target": "com.amazonaws.rekognition#JobId", "traits": { - "smithy.api#documentation": "Job identifier for the segment detection operation for which you \n want to obtain results. The job identifer is returned by an initial call \n to StartSegmentDetection.
" + "smithy.api#documentation": "Job identifier for the segment detection operation for which you want to obtain results.\n The job identifer is returned by an initial call to StartSegmentDetection.
" } }, "Video": { @@ -6414,7 +6544,7 @@ "JobTag": { "target": "com.amazonaws.rekognition#JobTag", "traits": { - "smithy.api#documentation": "A job identifier specified in the call to StartSegmentDetection and \n returned in the job completion notification sent to your \n Amazon Simple Notification Service topic.
" + "smithy.api#documentation": "A job identifier specified in the call to StartSegmentDetection and returned in the job\n completion notification sent to your Amazon Simple Notification Service topic.
" } } }, @@ -6454,7 +6584,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.
\nText detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by \n calling StartTextDetection which returns a job identifier (JobId)\n When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartTextDetection. To get the results\n of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. \n if so, call GetTextDetection and pass the job identifier (JobId) from the initial call\n of StartLabelDetection.
\n GetTextDetection returns an array of detected text (TextDetections) sorted by \n the time the text was detected, up to 50 words per frame of video.
Each element of the array includes the detected text, the precentage confidence in the acuracy \n of the detected text, the time the text was detected, bounding box information for where the text\n was located, and unique identifiers for words and their lines.
\nUse MaxResults parameter to limit the number of text detections returned. If there are more results than \n specified in MaxResults, the value of NextToken in the operation response contains\n a pagination token for getting the next set of results. To get the next page of results, call GetTextDetection\n and populate the NextToken request parameter with the token value returned from the previous \n call to GetTextDetection.
Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.
\nText detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by \n calling StartTextDetection which returns a job identifier (JobId)\n When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartTextDetection. To get the results\n of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. \n if so, call GetTextDetection and pass the job identifier (JobId) from the initial call\n of StartLabelDetection.
\n GetTextDetection returns an array of detected text (TextDetections) sorted by \n the time the text was detected, up to 100 words per frame of video.
Each element of the array includes the detected text, the precentage confidence in the acuracy \n of the detected text, the time the text was detected, bounding box information for where the text\n was located, and unique identifiers for words and their lines.
\nUse MaxResults parameter to limit the number of text detections returned. If there are more results than \n specified in MaxResults, the value of NextToken in the operation response contains\n a pagination token for getting the next set of results. To get the next page of results, call GetTextDetection\n and populate the NextToken request parameter with the token value returned from the previous \n call to GetTextDetection.
Job identifier for the text detection operation for which you \n want to obtain results. The job identifer is returned by an initial call \n to StartTextDetection.
" + "smithy.api#documentation": "Job identifier for the text detection operation for which you want to obtain results. The\n job identifer is returned by an initial call to StartTextDetection.
" } }, "Video": { @@ -6537,7 +6667,7 @@ "JobTag": { "target": "com.amazonaws.rekognition#JobTag", "traits": { - "smithy.api#documentation": "A job identifier specified in the call to StartTextDetection and \n returned in the job completion notification sent to your \n Amazon Simple Notification Service topic.
" + "smithy.api#documentation": "A job identifier specified in the call to StartTextDetection and returned in the job\n completion notification sent to your Amazon Simple Notification Service topic.
" } } }, @@ -6736,7 +6866,7 @@ "Bytes": { "target": "com.amazonaws.rekognition#ImageBlob", "traits": { - "smithy.api#documentation": "Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to \n DetectCustomLabels is 4MB.
Blob of image bytes up to 5 MBs. Note that the maximum image size you can\n pass to DetectCustomLabels is 4MB.
If Label represents an object, Instances contains the bounding boxes for each instance of the detected object.\n Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.
If Label represents an object, Instances contains the bounding\n boxes for each instance of the detected object. Bounding boxes are returned for common object\n labels such as people, cars, furniture, apparel or pets.
Structure containing details about the detected label, including the name, detected instances, parent labels, and level of\n confidence.
\n\n
" + "smithy.api#documentation": "Structure containing details about the detected label, including the name, detected\n instances, parent labels, and level of confidence.
\n" } }, "com.amazonaws.rekognition#LabelAlias": { @@ -7965,6 +8095,29 @@ ], "traits": { "smithy.api#documentation": "
\nLists the entries (images) within a dataset. An entry is a\nJSON Line that contains the information for a single image, including\nthe image location, assigned labels, and object location bounding boxes. For \nmore information, see Creating a manifest file.
\nJSON Lines in the response include information about non-terminal\n errors found in the dataset. \n Non terminal errors are reported in errors lists within each JSON Line. The\n same information is reported in the training and testing validation result manifests that\n Amazon Rekognition Custom Labels creates during model training.\n
You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.\n
\nThis operation requires permissions to perform the rekognition:ListDatasetEntries action.
Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see \n Labeling images.\n
\n\n Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images\n in the Amazon Rekognition Custom Labels Developer Guide.
", + "smithy.api#examples": [ + { + "title": "To list the entries in an Amazon Rekognition Custom Labels dataset", + "documentation": "Lists the JSON line entries in an Amazon Rekognition Custom Labels dataset.", + "input": { + "DatasetArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-proj-2/dataset/train/1690564858106", + "NextToken": "", + "MaxResults": 100 + }, + "output": { + "DatasetLabelDescriptions": [ + { + "LabelName": "camellia", + "LabelStats": { + "EntryCount": 1 + } + }, + { + "LabelName": "with_leaves", + "LabelStats": { + "EntryCount": 2 + } + }, + { + "LabelName": "mediterranean_spurge", + "LabelStats": { + "EntryCount": 1 + } + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8274,13 +8460,13 @@ "UserId": { "target": "com.amazonaws.rekognition#UserId", "traits": { - "smithy.api#documentation": "An array of user IDs to match when listing faces in a collection.
" + "smithy.api#documentation": "An array of user IDs to filter results with when listing faces in a collection.
" } }, "FaceIds": { "target": "com.amazonaws.rekognition#FaceIdList", "traits": { - "smithy.api#documentation": "An array of face IDs to match when listing faces in a collection.
" + "smithy.api#documentation": "An array of face IDs to filter results with when listing faces in a collection.
" } } }, @@ -8651,7 +8837,7 @@ "NextToken": { "target": "com.amazonaws.rekognition#PaginationToken", "traits": { - "smithy.api#documentation": "A pagination token to be used with the subsequent request if the response is truncated.
" + "smithy.api#documentation": "A pagination token to be used with the subsequent request if the response is\n truncated.
" } } }, @@ -8687,7 +8873,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains settings that specify the location of an Amazon S3 bucket used \n to store the output of a Face Liveness session. Note that the S3 bucket must be located \n in the caller's AWS account and in the same region as the Face Liveness end-point. Additionally, the Amazon S3 object keys are \n auto-generated by the Face Liveness system.
" + "smithy.api#documentation": "Contains settings that specify the location of an Amazon S3 bucket used to store the output of\n a Face Liveness session. Note that the S3 bucket must be located in the caller's AWS account\n and in the same region as the Face Liveness end-point. Additionally, the Amazon S3 object keys are\n auto-generated by the Face Liveness system.
" } }, "com.amazonaws.rekognition#LivenessS3KeyPrefix": { @@ -10366,52 +10552,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -10419,13 +10609,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -10435,224 +10634,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://rekognition-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://rekognition-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://rekognition-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://rekognition-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://rekognition.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://rekognition.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://rekognition.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://rekognition.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -11803,7 +11953,7 @@ } ], "traits": { - "smithy.api#documentation": "Searches for UserIDs using a supplied image. It first detects the largest face in the\n image, and then searches a specified collection for matching UserIDs.
\nThe operation returns an array of UserIDs that match the face in the supplied image,\n ordered by similarity score with the highest similarity first. It also returns a bounding box\n for the face found in the input image.
\nInformation about faces detected in the supplied image, but not used for the search, is\n returned in an array of UnsearchedFace objects. If no valid face is detected\n in the image, the response will contain an empty UserMatches list and no\n SearchedFace object.
Searches for UserIDs using a supplied image. It first detects the largest face in the\n image, and then searches a specified collection for matching UserIDs.
\nThe operation returns an array of UserIDs that match the face in the supplied image,\n ordered by similarity score with the highest similarity first. It also returns a bounding box\n for the face found in the input image.
\nInformation about faces detected in the supplied image, but not used for the search, is\n returned in an array of UnsearchedFace objects. If no valid face is detected in\n the image, the response will contain an empty UserMatches list and no\n SearchedFace object.
A list of FaceDetail objects containing the BoundingBox for the largest face in image,\n as well as the confidence in the bounding box, that was searched for matches. If no valid\n face is detected in the image the response will contain no SearchedFace object.
" + "smithy.api#documentation": "A list of FaceDetail objects containing the BoundingBox for the largest face in image, as\n well as the confidence in the bounding box, that was searched for matches. If no valid face is\n detected in the image the response will contain no SearchedFace object.
" } }, "UnsearchedFaces": { "target": "com.amazonaws.rekognition#UnsearchedFacesList", "traits": { - "smithy.api#documentation": "List of UnsearchedFace objects. Contains the face details infered from the specified\n image but not used for search. Contains reasons that describe why a face wasn't used for\n Search.
" + "smithy.api#documentation": "List of UnsearchedFace objects. Contains the face details infered from the specified image\n but not used for search. Contains reasons that describe why a face wasn't used for Search.\n
" } } }, @@ -11990,13 +12140,13 @@ "UserMatches": { "target": "com.amazonaws.rekognition#UserMatchList", "traits": { - "smithy.api#documentation": "An array of UserMatch objects that matched the input face along with the confidence in\n the match. Array will be empty if there are no matches.
" + "smithy.api#documentation": "An array of UserMatch objects that matched the input face along with the confidence in the\n match. Array will be empty if there are no matches.
" } }, "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "Version number of the face detection model associated with the input\n CollectionId.
" + "smithy.api#documentation": "Version number of the face detection model associated with the input CollectionId.
" } }, "SearchedFace": { @@ -12027,7 +12177,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides face metadata such as FaceId, BoundingBox, Confidence of the input face used for search.
" + "smithy.api#documentation": "Provides face metadata such as FaceId, BoundingBox, Confidence of the input face used for\n search.
" } }, "com.amazonaws.rekognition#SearchedFaceDetails": { @@ -12904,7 +13054,21 @@ } ], "traits": { - "smithy.api#documentation": "Starts the running of the version of a model. Starting a model takes a while\n to complete. To check the current state of the model, use DescribeProjectVersions.
\nOnce the model is running, you can detect custom labels in new images by calling \n DetectCustomLabels.
\nYou are charged for the amount of time that the model is running. To stop a running\n model, call StopProjectVersion.
\nFor more information, see Running a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels Guide.
\nThis operation requires permissions to perform the \n rekognition:StartProjectVersion action.
Starts the running of the version of a model. Starting a model takes a while\n to complete. To check the current state of the model, use DescribeProjectVersions.
\nOnce the model is running, you can detect custom labels in new images by calling \n DetectCustomLabels.
\nYou are charged for the amount of time that the model is running. To stop a running\n model, call StopProjectVersion.
\nFor more information, see Running a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels Guide.
\nThis operation requires permissions to perform the \n rekognition:StartProjectVersion action.
Stops a running model. The operation might take a while to complete. To\n check the current status, call DescribeProjectVersions.
\nThis operation requires permissions to perform the rekognition:StopProjectVersion action.
Stops a running model. The operation might take a while to complete. To\n check the current status, call DescribeProjectVersions.
\nThis operation requires permissions to perform the rekognition:StopProjectVersion action.
Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully associated.
" + "smithy.api#documentation": "Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully\n associated.
" } }, "com.amazonaws.rekognition#UnsuccessfulFaceAssociationList": { @@ -14302,7 +14478,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully deleted.
" + "smithy.api#documentation": "Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully\n deleted.
" } }, "com.amazonaws.rekognition#UnsuccessfulFaceDeletionReason": { @@ -14363,7 +14539,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully disassociated.
" + "smithy.api#documentation": "Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully\n disassociated.
" } }, "com.amazonaws.rekognition#UnsuccessfulFaceDisassociationList": { @@ -14497,7 +14673,20 @@ } ], "traits": { - "smithy.api#documentation": "Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the\n information for a single image, including\n the image location, assigned labels, and object location bounding boxes. For more information, \n see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.\n
\nIf the source-ref field in the JSON line references an existing image, the existing image in the dataset\n is updated. \n If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset.
You specify the changes that you want to make in the Changes input parameter. \n There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less\nthan 5MB.
\n UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete.\n Use DescribeDataset to check the \n current status. The dataset updated successfully if the value of Status is\n UPDATE_COMPLETE.
To check if any non-terminal errors occured, call ListDatasetEntries\n and check for the presence of errors lists in the JSON Lines.
Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). \n Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.\n
This operation requires permissions to perform the rekognition:UpdateDatasetEntries action.
Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the\n information for a single image, including\n the image location, assigned labels, and object location bounding boxes. For more information, \n see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.\n
\nIf the source-ref field in the JSON line references an existing image, the existing image in the dataset\n is updated. \n If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset.
You specify the changes that you want to make in the Changes input parameter. \n There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less\nthan 5MB.
\n UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete.\n Use DescribeDataset to check the \n current status. The dataset updated successfully if the value of Status is\n UPDATE_COMPLETE.
To check if any non-terminal errors occured, call ListDatasetEntries\n and check for the presence of errors lists in the JSON Lines.
Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). \n Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.\n
This operation requires permissions to perform the rekognition:UpdateDatasetEntries action.
The password that was returned by the TransferDomainToAnotherAwsAccount request.
", "smithy.api#required": {} @@ -109,7 +109,8 @@ "smithy.api#length": { "min": 0, "max": 255 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.route53domains#AssociateDelegationSignerToDomain": { @@ -389,6 +390,12 @@ "traits": { "smithy.api#documentation": "A complex type that contains information about whether the specified domain can be\n\t\t\ttransferred to Route 53.
" } + }, + "Message": { + "target": "com.amazonaws.route53domains#Message", + "traits": { + "smithy.api#documentation": "Provides an explanation for when a domain can't be transferred.
" + } } }, "traits": { @@ -402,7 +409,8 @@ "smithy.api#length": { "min": 0, "max": 255 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.route53domains#Consent": { @@ -527,7 +535,8 @@ "smithy.api#length": { "min": 0, "max": 255 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.route53domains#ContactNumber": { @@ -536,7 +545,8 @@ "smithy.api#length": { "min": 0, "max": 30 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.route53domains#ContactType": { @@ -2083,6 +2093,9 @@ "smithy.api#enumValue": "ZW" } } + }, + "traits": { + "smithy.api#sensitive": {} } }, "com.amazonaws.route53domains#Currency": { @@ -2716,6 +2729,12 @@ "com.amazonaws.route53domains#DuplicateRequest": { "type": "structure", "members": { + "requestId": { + "target": "com.amazonaws.route53domains#RequestId", + "traits": { + "smithy.api#documentation": "ID of the request operation.
" + } + }, "message": { "target": "com.amazonaws.route53domains#ErrorMessage", "traits": { @@ -2744,7 +2763,8 @@ "smithy.api#length": { "min": 0, "max": 254 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.route53domains#EnableDomainAutoRenew": { @@ -3919,6 +3939,9 @@ "smithy.api#output": {} } }, + "com.amazonaws.route53domains#Message": { + "type": "string" + }, "com.amazonaws.route53domains#Nameserver": { "type": "structure", "members": { @@ -4248,6 +4271,12 @@ } } }, + "com.amazonaws.route53domains#Password": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.route53domains#Price": { "type": "double", "traits": { @@ -4605,6 +4634,9 @@ "smithy.api#output": {} } }, + "com.amazonaws.route53domains#RequestId": { + "type": "string" + }, "com.amazonaws.route53domains#Reseller": { "type": "string" }, @@ -4938,52 +4970,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -4991,13 +5027,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -5007,224 +5052,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://route53domains-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://route53domains-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://route53domains-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://route53domains-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://route53domains.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://route53domains.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://route53domains.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://route53domains.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -5589,7 +5585,8 @@ "smithy.api#length": { "min": 0, "max": 255 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.route53domains#StatusFlag": { @@ -5900,7 +5897,7 @@ } }, "Password": { - "target": "com.amazonaws.route53domains#String", + "target": "com.amazonaws.route53domains#Password", "traits": { "smithy.api#documentation": "To finish transferring a domain to another Amazon Web Services account, the account\n\t\t\tthat the domain is being transferred to must submit an AcceptDomainTransferFromAnotherAwsAccount request. The request must include\n\t\t\tthe value of the Password element that was returned in the\n\t\t\t\tTransferDomainToAnotherAwsAccount response.
Whether the domain name can be transferred to Route 53.
\nYou can transfer only domains that have a value of TRANSFERABLE or\n\t\t\t\t\tTransferable.
Valid values:
\nThe domain name can be transferred to Route 53.
\nThe domain name can't be transferred to Route 53.
\nReserved for future use.
\nThe domain already exists in the current Amazon Web Services account.
\nthe domain exists in another Amazon Web Services account.
\nPremium domain transfer is not supported.
\nWhether the domain name can be transferred to Route 53.
\nYou can transfer only domains that have a value of TRANSFERABLE or\n\t\t\t\t\tTransferable.
Valid values:
\nThe domain name can be transferred to Route 53.
\nThe domain name can't be transferred to Route 53.
\nReserved for future use.
\nThe domain already exists in the current Amazon Web Services account.
\nThe domain exists in another Amazon Web Services account.
\nPremium domain transfer is not supported.
\nCreates an endpoint using the endpoint configuration specified in the request. SageMaker\n uses the endpoint to provision resources and deploy models. You create the endpoint\n configuration with the CreateEndpointConfig API.
\nUse this API to deploy models using SageMaker hosting services.
\nFor an example that calls this method when deploying a model to SageMaker hosting services,\n see the Create Endpoint example notebook.\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.
The endpoint name must be unique within an Amazon Web Services Region in your\n Amazon Web Services account.
\nWhen it receives the request, SageMaker creates the endpoint, launches the resources (ML\n compute instances), and deploys the model(s) on them.
\nWhen you call CreateEndpoint, a load call is made to DynamoDB to verify that your\n endpoint configuration exists. When you read data from a DynamoDB table supporting\n \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\n eventually consistent read.
When SageMaker receives the request, it sets the endpoint status to\n Creating. After it creates the endpoint, it sets the status to\n InService. SageMaker can then process incoming requests for inferences. To\n check the status of an endpoint, use the DescribeEndpoint API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location,\n SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the\n S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services\n account by default. If you previously deactivated Amazon Web Services STS for a region,\n you need to reactivate Amazon Web Services STS for that region. For more information, see\n Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Amazon Web Services Identity and Access Management User\n Guide.
\nTo 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 the\n role.
\nOption 1: For a full SageMaker access, search and attach the\n AmazonSageMakerFullAccess policy.
Option 2: For granting a limited access to an IAM role, paste the\n following Action elements manually into the JSON file of the IAM role:
\n\n \"Action\": [\"sagemaker:CreateEndpoint\",\n \"sagemaker:CreateEndpointConfig\"]\n
\n \"Resource\": [\n
\n \"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"\n
\n \"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"\n
\n ]\n
For more information, see SageMaker API\n Permissions: Actions, Permissions, and Resources\n Reference.
\nCreates an endpoint using the endpoint configuration specified in the request. SageMaker\n uses the endpoint to provision resources and deploy models. You create the endpoint\n configuration with the CreateEndpointConfig API.
\nUse this API to deploy models using SageMaker hosting services.
\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.
The endpoint name must be unique within an Amazon Web Services Region in your\n Amazon Web Services account.
\nWhen it receives the request, SageMaker creates the endpoint, launches the resources (ML\n compute instances), and deploys the model(s) on them.
\nWhen you call CreateEndpoint, a load call is made to DynamoDB to verify that your\n endpoint configuration exists. When you read data from a DynamoDB table supporting\n \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\n eventually consistent read.
When SageMaker receives the request, it sets the endpoint status to\n Creating. After it creates the endpoint, it sets the status to\n InService. SageMaker can then process incoming requests for inferences. To\n check the status of an endpoint, use the DescribeEndpoint API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location,\n SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the\n S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services\n account by default. If you previously deactivated Amazon Web Services STS for a region,\n you need to reactivate Amazon Web Services STS for that region. For more information, see\n Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Amazon Web Services Identity and Access Management User\n Guide.
\nTo 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 the\n role.
\nOption 1: For a full SageMaker access, search and attach the\n AmazonSageMakerFullAccess policy.
Option 2: For granting a limited access to an IAM role, paste the\n following Action elements manually into the JSON file of the IAM role:
\n\n \"Action\": [\"sagemaker:CreateEndpoint\",\n \"sagemaker:CreateEndpointConfig\"]\n
\n \"Resource\": [\n
\n \"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"\n
\n \"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"\n
\n ]\n
For more information, see SageMaker API\n Permissions: Actions, Permissions, and Resources\n Reference.
\nThe name of the model card to export.
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model card to export.
", "smithy.api#required": {} } }, @@ -9486,7 +9486,7 @@ "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 Amazon Web Services\n resources in the Amazon Web Services 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.
\nIf you supply ModelPackageGroupName, your model package belongs to the model group\n\t you specify and uses the tags associated with the model group. In this case, you cannot\n\t supply a tag argument.\n
The name of the model card that the model export job exports.
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model card that the model export job exports.
", "smithy.api#required": {} } }, @@ -18130,9 +18130,9 @@ "type": "structure", "members": { "ModelCardName": { - "target": "com.amazonaws.sagemaker#EntityName", + "target": "com.amazonaws.sagemaker#ModelCardNameOrArn", "traits": { - "smithy.api#documentation": "The name of the model card to describe.
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model card to describe.
", "smithy.api#required": {} } }, @@ -34012,9 +34012,9 @@ } }, "ModelCardName": { - "target": "com.amazonaws.sagemaker#EntityName", + "target": "com.amazonaws.sagemaker#ModelCardNameOrArn", "traits": { - "smithy.api#documentation": "List model card versions for the model card with the specified name.
", + "smithy.api#documentation": "List model card versions for the model card with the specified name or Amazon Resource Name (ARN).
", "smithy.api#required": {} } }, @@ -38137,6 +38137,16 @@ "smithy.api#documentation": "Configure the export output details for an Amazon SageMaker Model Card.
" } }, + "com.amazonaws.sagemaker#ModelCardNameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model-card/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})$" + } + }, "com.amazonaws.sagemaker#ModelCardProcessingStatus": { "type": "enum", "members": { @@ -42402,7 +42412,7 @@ "CompilerOptions": { "target": "com.amazonaws.sagemaker#CompilerOptions", "traits": { - "smithy.api#documentation": "Specifies additional parameters for compiler options in JSON format. The compiler\n options are TargetPlatform specific. It is required for NVIDIA accelerators\n and highly recommended for CPU compilations. For any other cases, it is optional to\n specify CompilerOptions.\n
\n DTYPE: Specifies the data type for the input. When compiling for\n ml_* (except for ml_inf) instances using PyTorch\n framework, provide the data type (dtype) of the model's input.\n \"float32\" is used if \"DTYPE\" is not specified.\n Options for data type are:
float32: Use either \"float\" or \"float32\".
int64: Use either \"int64\" or \"long\".
For example, {\"dtype\" : \"float32\"}.
\n CPU: Compilation for CPU supports the following compiler\n options.
\n mcpu: CPU micro-architecture. For example, {'mcpu':\n 'skylake-avx512'}\n
\n mattr: CPU flags. For example, {'mattr': ['+neon',\n '+vfpv4']}\n
\n ARM: Details of ARM CPU compilations.
\n NEON: NEON is an implementation of the Advanced SIMD\n extension used in ARMv7 processors.
For example, add {'mattr': ['+neon']} to the compiler\n options if compiling for ARM 32-bit platform with the NEON\n support.
\n NVIDIA: Compilation for NVIDIA GPU supports the following\n compiler options.
\n gpu_code: Specifies the targeted architecture.
\n trt-ver: Specifies the TensorRT versions in x.y.z.\n format.
\n cuda-ver: Specifies the CUDA version in x.y\n format.
For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver':\n '10.1'}\n
\n ANDROID: Compilation for the Android OS supports the following\n compiler options:
\n ANDROID_PLATFORM: Specifies the Android API levels.\n Available levels range from 21 to 29. For example,\n {'ANDROID_PLATFORM': 28}.
\n mattr: Add {'mattr': ['+neon']} to compiler\n options if compiling for ARM 32-bit platform with NEON support.
\n INFERENTIA: Compilation for target ml_inf1 uses compiler options\n passed in as a JSON string. For example,\n \"CompilerOptions\": \"\\\"--verbose 1 --num-neuroncores 2 -O2\\\"\".\n
For information about supported compiler options, see\n \n Neuron Compiler CLI.\n
\n\n CoreML: Compilation for the CoreML OutputConfig\n TargetDevice supports the following compiler options:
\n class_labels: Specifies the classification labels file\n name inside input tar.gz file. For example,\n {\"class_labels\": \"imagenet_labels_1000.txt\"}.\n Labels inside the txt file should be separated by newlines.
\n EIA: Compilation for the Elastic Inference Accelerator supports the following \n compiler options:
\n precision_mode: Specifies the precision of compiled artifacts. Supported values\n are \"FP16\" and \"FP32\". Default is\n \"FP32\".
\n signature_def_key: Specifies the signature to use for models in SavedModel\n format. Defaults is TensorFlow's default signature def key.
\n output_names: Specifies a list of output tensor names for \n models in FrozenGraph format. Set at most one API field, either: signature_def_key or output_names.
For example: \n {\"precision_mode\": \"FP32\", \"output_names\": [\"output:0\"]}\n
Specifies additional parameters for compiler options in JSON format. The compiler\n options are TargetPlatform specific. It is required for NVIDIA accelerators\n and highly recommended for CPU compilations. For any other cases, it is optional to\n specify CompilerOptions.\n
\n DTYPE: Specifies the data type for the input. When compiling for\n ml_* (except for ml_inf) instances using PyTorch\n framework, provide the data type (dtype) of the model's input.\n \"float32\" is used if \"DTYPE\" is not specified.\n Options for data type are:
float32: Use either \"float\" or \"float32\".
int64: Use either \"int64\" or \"long\".
For example, {\"dtype\" : \"float32\"}.
\n CPU: Compilation for CPU supports the following compiler\n options.
\n mcpu: CPU micro-architecture. For example, {'mcpu':\n 'skylake-avx512'}\n
\n mattr: CPU flags. For example, {'mattr': ['+neon',\n '+vfpv4']}\n
\n ARM: Details of ARM CPU compilations.
\n NEON: NEON is an implementation of the Advanced SIMD\n extension used in ARMv7 processors.
For example, add {'mattr': ['+neon']} to the compiler\n options if compiling for ARM 32-bit platform with the NEON\n support.
\n NVIDIA: Compilation for NVIDIA GPU supports the following\n compiler options.
\n gpu_code: Specifies the targeted architecture.
\n trt-ver: Specifies the TensorRT versions in x.y.z.\n format.
\n cuda-ver: Specifies the CUDA version in x.y\n format.
For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver':\n '10.1'}\n
\n ANDROID: Compilation for the Android OS supports the following\n compiler options:
\n ANDROID_PLATFORM: Specifies the Android API levels.\n Available levels range from 21 to 29. For example,\n {'ANDROID_PLATFORM': 28}.
\n mattr: Add {'mattr': ['+neon']} to compiler\n options if compiling for ARM 32-bit platform with NEON support.
\n INFERENTIA: Compilation for target ml_inf1 uses compiler options\n passed in as a JSON string. For example,\n \"CompilerOptions\": \"\\\"--verbose 1 --num-neuroncores 2 -O2\\\"\".\n
For information about supported compiler options, see\n \n Neuron Compiler CLI Reference Guide.\n
\n\n CoreML: Compilation for the CoreML OutputConfig\n TargetDevice supports the following compiler options:
\n class_labels: Specifies the classification labels file\n name inside input tar.gz file. For example,\n {\"class_labels\": \"imagenet_labels_1000.txt\"}.\n Labels inside the txt file should be separated by newlines.
\n EIA: Compilation for the Elastic Inference Accelerator supports the following \n compiler options:
\n precision_mode: Specifies the precision of compiled artifacts. Supported values\n are \"FP16\" and \"FP32\". Default is\n \"FP32\".
\n signature_def_key: Specifies the signature to use for models in SavedModel\n format. Defaults is TensorFlow's default signature def key.
\n output_names: Specifies a list of output tensor names for \n models in FrozenGraph format. Set at most one API field, either: signature_def_key or output_names.
For example: \n {\"precision_mode\": \"FP32\", \"output_names\": [\"output:0\"]}\n
The endpoint type to receive recommendations for. By default this is null, and the results of \n the inference recommendation job return a combined list of both real-time and serverless benchmarks.\n By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.
" } + }, + "SupportedResponseMIMETypes": { + "target": "com.amazonaws.sagemaker#RecommendationJobSupportedResponseMIMETypes", + "traits": { + "smithy.api#documentation": "The supported MIME types for the output data.
" + } } }, "traits": { @@ -47354,6 +47370,22 @@ "target": "com.amazonaws.sagemaker#String" } }, + "com.amazonaws.sagemaker#RecommendationJobSupportedResponseMIMEType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[-\\w]+\\/.+$" + } + }, + "com.amazonaws.sagemaker#RecommendationJobSupportedResponseMIMETypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#RecommendationJobSupportedResponseMIMEType" + } + }, "com.amazonaws.sagemaker#RecommendationJobType": { "type": "enum", "members": { @@ -54933,6 +54965,12 @@ "traits": { "smithy.api#enumValue": "ml.trn1n.32xlarge" } + }, + "ML_P5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.48xlarge" + } } } }, @@ -55960,6 +55998,9 @@ "traits": { "smithy.api#documentation": "A list of tags associated with the transform job.
" } + }, + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#BatchDataCaptureConfig" } }, "traits": { @@ -58285,9 +58326,9 @@ "type": "structure", "members": { "ModelCardName": { - "target": "com.amazonaws.sagemaker#EntityName", + "target": "com.amazonaws.sagemaker#ModelCardNameOrArn", "traits": { - "smithy.api#documentation": "The name of the model card to update.
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model card to update.
", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/secrets-manager.2017-10-17.json b/codegen/sdk-codegen/aws-models/secrets-manager.2017-10-17.json index 49425f8230f..724bc1b2dbe 100644 --- a/codegen/sdk-codegen/aws-models/secrets-manager.2017-10-17.json +++ b/codegen/sdk-codegen/aws-models/secrets-manager.2017-10-17.json @@ -1237,6 +1237,9 @@ }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" } ], "traits": { diff --git a/codegen/sdk-codegen/aws-models/service-catalog.2015-12-10.json b/codegen/sdk-codegen/aws-models/service-catalog.2015-12-10.json index 679cd0b6017..b8a67f2a1a6 100644 --- a/codegen/sdk-codegen/aws-models/service-catalog.2015-12-10.json +++ b/codegen/sdk-codegen/aws-models/service-catalog.2015-12-10.json @@ -378,52 +378,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -431,13 +435,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -447,224 +460,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://servicecatalog-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://servicecatalog-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://servicecatalog-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://servicecatalog-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://servicecatalog.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://servicecatalog.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://servicecatalog.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://servicecatalog.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -1413,7 +1377,7 @@ "Value": { "target": "com.amazonaws.servicecatalog#AccessLevelFilterValue", "traits": { - "smithy.api#documentation": "The user to which the access level applies. The only supported value is Self.
The user to which the access level applies. The only supported value is self.
\n Requests the import \n of a resource \n as an Service Catalog provisioned product \n that is associated \n to an Service Catalog product and provisioning artifact. \n Once imported, \n all supported governance actions are supported \n on the provisioned product.\n
\n\n Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets, and non-root nested stacks are not supported.\n
\n\n The CloudFormation stack must have one \n of the following statuses \n to be imported: CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE, and IMPORT_ROLLBACK_COMPLETE.\n
\n Import \n of the resource requires \n that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact.\n
\n\n When you import an existing CloudFormation stack \n into a portfolio, \n constraints \n that are associated \n with the product \n aren't applied \n during the import process. \n The constraints are applied \n after you call UpdateProvisionedProduct \n for the provisioned product.\n
\n The user or role \n that performs this operation \n must have the cloudformation:GetTemplate and cloudformation:DescribeStacks IAM policy permissions.\n
\n Requests the import of a resource as an Service Catalog provisioned product \n that is associated to an Service Catalog product and provisioning artifact. \n Once imported, all supported governance actions are supported on the provisioned product.\n
\n\n Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets,\n and non-root nested stacks, are not supported.\n
\n\n The CloudFormation stack must have one \n of the following statuses \n to be imported: CREATE_COMPLETE, UPDATE_COMPLETE, \n UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE, and \n IMPORT_ROLLBACK_COMPLETE.\n
\n Import of the resource requires that the CloudFormation stack template matches \n the associated Service Catalog product provisioning artifact.\n
\n\n When you import an existing CloudFormation stack \n into a portfolio, Service Catalog does not apply the product's associated constraints \n during the import process. Service Catalog applies the constraints \n after you call UpdateProvisionedProduct for the provisioned product.\n
\n The user or role that performs this operation must have the cloudformation:GetTemplate \n and cloudformation:DescribeStacks IAM policy permissions.\n
You can only import one provisioned product at a time. The product's CloudFormation stack must have the \n IMPORT_COMPLETE status before you import another.
The user-friendly name of the provisioned product. The value must be unique for the Amazon Web Services account. The name cannot be updated after the product is provisioned.
", + "smithy.api#documentation": "The user-friendly name of the provisioned product. The value must be unique for the Amazon Web Services account. \n The name cannot be updated after the product is provisioned.
", "smithy.api#required": {} } }, @@ -8078,6 +8042,12 @@ "traits": { "smithy.api#enumValue": "TERRAFORM_OPEN_SOURCE" } + }, + "TERRAFORM_CLOUD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERRAFORM_CLOUD" + } } }, "traits": { @@ -8581,13 +8551,13 @@ "LastProvisioningRecordId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The record identifier of the last request performed on this provisioned product of the following types:
\n\n ProvisionedProduct\n
\n\n UpdateProvisionedProduct\n
\n\n ExecuteProvisionedProductPlan\n
\n\n TerminateProvisionedProduct\n
\nThe record identifier of the last request performed on this provisioned product of the following types:
\n\n ProvisionProduct\n
\n\n UpdateProvisionedProduct\n
\n\n ExecuteProvisionedProductPlan\n
\n\n TerminateProvisionedProduct\n
\nThe record identifier of the last successful request performed on this provisioned product of the following types:
\n\n ProvisionedProduct\n
\n\n UpdateProvisionedProduct\n
\n\n ExecuteProvisionedProductPlan\n
\n\n TerminateProvisionedProduct\n
\nThe record identifier of the last successful request performed on this provisioned product of the following types:
\n\n ProvisionProduct\n
\n\n UpdateProvisionedProduct\n
\n\n ExecuteProvisionedProductPlan\n
\n\n TerminateProvisionedProduct\n
\nThe record identifier of the last request performed on this provisioned product of the following types:
\n\n ProvisionedProduct\n
\n\n UpdateProvisionedProduct\n
\n\n ExecuteProvisionedProductPlan\n
\n\n TerminateProvisionedProduct\n
\nThe record identifier of the last request performed on this provisioned product of the following types:
\n\n ProvisionProduct\n
\n\n UpdateProvisionedProduct\n
\n\n ExecuteProvisionedProductPlan\n
\n\n TerminateProvisionedProduct\n
\nThe record identifier of the last successful request performed on this provisioned product of the following types:
\n\n ProvisionedProduct\n
\n\n UpdateProvisionedProduct\n
\n\n ExecuteProvisionedProductPlan\n
\n\n TerminateProvisionedProduct\n
\nThe record identifier of the last successful request performed on this provisioned product of the following types:
\n\n ProvisionProduct\n
\n\n UpdateProvisionedProduct\n
\n\n ExecuteProvisionedProductPlan\n
\n\n TerminateProvisionedProduct\n
\nThe type of provisioning artifact.
\n\n CLOUD_FORMATION_TEMPLATE - CloudFormation template
\n MARKETPLACE_AMI - Amazon Web Services Marketplace AMI
\n MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services Resources
The type of provisioning artifact.
\n\n CLOUD_FORMATION_TEMPLATE - CloudFormation template
The type of provisioning artifact.
\n\n CLOUD_FORMATION_TEMPLATE - CloudFormation template
\n MARKETPLACE_AMI - Amazon Web Services Marketplace AMI
\n MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services Resources
\n TERRAFORM_OPEN_SOURCE - Terraform open source configuration file
The type of provisioning artifact.
\n\n CLOUD_FORMATION_TEMPLATE - CloudFormation template
\n TERRAFORM_OPEN_SOURCE - Terraform open source configuration file
If set to true, Service Catalog stops validating the specified provisioning artifact even if it is invalid.
" + "smithy.api#documentation": "If set to true, Service Catalog stops validating the specified provisioning artifact even if it is invalid.
\nService Catalog does not support template validation for the TERRAFORM_OS product type.
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.
The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, \n TERRAFORM_OPEN_SOURCE, and TERRAFORM_CLOUD.
The search filters.
\nWhen the key is SearchQuery, the searchable fields are arn, \n createdTime, id, lastRecordId,\n idempotencyToken, name, physicalId, productId, \n provisioningArtifact, type, status,\n tags, userArn, userArnSession, lastProvisioningRecordId, lastSuccessfulProvisioningRecordId, \n productName, and provisioningArtifactName.
Example: \"SearchQuery\":[\"status:AVAILABLE\"]\n
The search filters.
\nWhen the key is SearchQuery, the searchable fields are arn, \n createdTime, id, lastRecordId,\n idempotencyToken, name, physicalId, productId, \n provisioningArtifactId, type, status,\n tags, userArn, userArnSession, lastProvisioningRecordId, lastSuccessfulProvisioningRecordId, \n productName, and provisioningArtifactName.
Example: \"SearchQuery\":[\"status:AVAILABLE\"]\n
Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing \n or Principal sharing for an existing portfolio share.
The portfolio share cannot be updated if the CreatePortfolioShare operation is IN_PROGRESS, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be COMPLETED.
You must provide the accountId or organization node in the input, but not both.
If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare separately for each share type.
This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare API for that action.
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is \n then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, \n but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal \n name association for the portfolio. Although this user may not know which principal names are associated through \n Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then \n Service Catalog recommends using PrincipalType as IAM. With this configuration, \n the PrincipalARN must already exist in the recipient account before it can be associated.
Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing \n or Principal sharing for an existing portfolio share.
The portfolio share cannot be updated if the CreatePortfolioShare operation is IN_PROGRESS, as the share is not available to recipient entities. \n In this case, you must wait for the portfolio share to be completed.
You must provide the accountId or organization node in the input, but not both.
If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare separately for each share type.
This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare API for that action.
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is \n then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, \n but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal \n name association for the portfolio. Although this user may not know which principal names are associated through \n Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then \n Service Catalog recommends using PrincipalType as IAM. With this configuration, \n the PrincipalARN must already exist in the recipient account before it can be associated.
Indicates that email sending is disabled for your entire Amazon SES account.
\nYou can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.
", + "smithy.api#documentation": "Indicates that email sending is disabled for your entire Amazon SES account.
\nYou can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -52,20 +52,20 @@ "HeaderName": { "target": "com.amazonaws.ses#HeaderName", "traits": { - "smithy.api#documentation": "The name of the header to add. Must be between 1 and 50 characters, inclusive, and\n consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
", + "smithy.api#documentation": "The name of the header to add to the incoming message. The name must contain at least\n one character, and can contain up to 50 characters. It consists of alphanumeric (a–z,\n A–Z, 0–9) characters and dashes.
", "smithy.api#required": {} } }, "HeaderValue": { "target": "com.amazonaws.ses#HeaderValue", "traits": { - "smithy.api#documentation": "Must be less than 2048 characters, and must not contain newline characters (\"\\r\" or\n \"\\n\").
", + "smithy.api#documentation": "The content to include in the header. This value can contain up to 2048 characters. It\n can't contain newline (\\n) or carriage return (\\r)\n characters.
When included in a receipt rule, this action adds a header to the received\n email.
\nFor information about adding a header using a receipt rule, see the Amazon SES\n Developer Guide.
" + "smithy.api#documentation": "When included in a receipt rule, this action adds a header to the received\n email.
\nFor information about adding a header using a receipt rule, see the Amazon SES Developer Guide.
" } }, "com.amazonaws.ses#Address": { @@ -107,18 +107,20 @@ "type": "timestamp" }, "com.amazonaws.ses#BehaviorOnMXFailure": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UseDefaultValue", - "name": "UseDefaultValue" - }, - { - "value": "RejectMessage", - "name": "RejectMessage" + "type": "enum", + "members": { + "UseDefaultValue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UseDefaultValue" } - ] + }, + "RejectMessage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RejectMessage" + } + } } }, "com.amazonaws.ses#Body": { @@ -147,7 +149,7 @@ "TopicArn": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is\n taken. An example of an Amazon SNS topic ARN is\n arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about\n Amazon SNS topics, see the Amazon SNS Developer Guide.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is\n taken. You can find the ARN of a topic by using the ListTopics operation in\n Amazon SNS.
\nFor more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
" } }, "SmtpReplyCode": { @@ -173,13 +175,13 @@ "Sender": { "target": "com.amazonaws.ses#Address", "traits": { - "smithy.api#documentation": "The email address of the sender of the bounced email. This is the address from which\n the bounce message will be sent.
", + "smithy.api#documentation": "The email address of the sender of the bounced email. This is the address from which\n the bounce message is sent.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "When included in a receipt rule, this action rejects the received email by returning a\n bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service\n (Amazon SNS).
\nFor information about sending a bounce message in response to a received email, see\n the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "When included in a receipt rule, this action rejects the received email by returning a\n bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service\n (Amazon SNS).
\nFor information about sending a bounce message in response to a received email, see\n the Amazon SES Developer Guide.
" } }, "com.amazonaws.ses#BounceMessage": { @@ -192,34 +194,44 @@ "type": "string" }, "com.amazonaws.ses#BounceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DoesNotExist", - "name": "DoesNotExist" - }, - { - "value": "MessageTooLarge", - "name": "MessageTooLarge" - }, - { - "value": "ExceededQuota", - "name": "ExceededQuota" - }, - { - "value": "ContentRejected", - "name": "ContentRejected" - }, - { - "value": "Undefined", - "name": "Undefined" - }, - { - "value": "TemporaryFailure", - "name": "TemporaryFailure" + "type": "enum", + "members": { + "DoesNotExist": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DoesNotExist" } - ] + }, + "MessageTooLarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MessageTooLarge" + } + }, + "ExceededQuota": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExceededQuota" + } + }, + "ContentRejected": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContentRejected" + } + }, + "Undefined": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Undefined" + } + }, + "TemporaryFailure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TemporaryFailure" + } + } } }, "com.amazonaws.ses#BouncedRecipientInfo": { @@ -235,7 +247,7 @@ "RecipientArn": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to receive\n email for the recipient of the bounced email. For more information about sending\n authorization, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to receive\n email for the recipient of the bounced email. For more information about sending\n authorization, see the Amazon SES Developer Guide.
" } }, "BounceType": { @@ -252,7 +264,7 @@ } }, "traits": { - "smithy.api#documentation": "Recipient-related information to include in the Delivery Status Notification (DSN)\n when an email that Amazon SES receives on your behalf bounces.
\nFor information about receiving email through Amazon SES, see the Amazon SES\n Developer Guide.
" + "smithy.api#documentation": "Recipient-related information to include in the Delivery Status Notification (DSN)\n when an email that Amazon SES receives on your behalf bounces.
\nFor information about receiving email through Amazon SES, see the Amazon SES Developer\n Guide.
" } }, "com.amazonaws.ses#BouncedRecipientInfoList": { @@ -299,7 +311,7 @@ "Status": { "target": "com.amazonaws.ses#BulkEmailStatus", "traits": { - "smithy.api#documentation": "The status of a message sent using the SendBulkTemplatedEmail\n operation.
Possible values for this parameter include:
\n\n Success: Amazon SES accepted the message, and will attempt to deliver\n it to the recipients.
\n MessageRejected: The message was rejected because it contained a\n virus.
\n MailFromDomainNotVerified: The sender's email address or domain\n was not verified.
\n ConfigurationSetDoesNotExist: The configuration set you specified\n does not exist.
\n TemplateDoesNotExist: The template you specified does not\n exist.
\n AccountSuspended: Your account has been shut down because of\n issues related to your email sending practices.
\n AccountThrottled: The number of emails you can send has been\n reduced because your account has exceeded its allocated sending limit.
\n AccountDailyQuotaExceeded: You have reached or exceeded the\n maximum number of emails you can send from your account in a 24-hour\n period.
\n InvalidSendingPoolName: The configuration set you specified\n refers to an IP pool that does not exist.
\n AccountSendingPaused: Email sending for the Amazon SES account was\n disabled using the UpdateAccountSendingEnabled\n operation.
\n ConfigurationSetSendingPaused: Email sending for this\n configuration set was disabled using the UpdateConfigurationSetSendingEnabled operation.
\n InvalidParameterValue: One or more of the parameters you\n specified when calling this operation was invalid. See the error message for\n additional information.
\n TransientFailure: Amazon SES was unable to process your request\n because of a temporary issue.
\n Failed: Amazon SES was unable to process your request. See the error\n message for additional information.
The status of a message sent using the SendBulkTemplatedEmail\n operation.
Possible values for this parameter include:
\n\n Success: Amazon SES accepted the message, and attempts to deliver it\n to the recipients.
\n MessageRejected: The message was rejected because it contained a\n virus.
\n MailFromDomainNotVerified: The sender's email address or domain\n was not verified.
\n ConfigurationSetDoesNotExist: The configuration set you specified\n does not exist.
\n TemplateDoesNotExist: The template you specified does not\n exist.
\n AccountSuspended: Your account has been shut down because of\n issues related to your email sending practices.
\n AccountThrottled: The number of emails you can send has been\n reduced because your account has exceeded its allocated sending limit.
\n AccountDailyQuotaExceeded: You have reached or exceeded the\n maximum number of emails you can send from your account in a 24-hour\n period.
\n InvalidSendingPoolName: The configuration set you specified\n refers to an IP pool that does not exist.
\n AccountSendingPaused: Email sending for the Amazon SES account was\n disabled using the UpdateAccountSendingEnabled\n operation.
\n ConfigurationSetSendingPaused: Email sending for this\n configuration set was disabled using the UpdateConfigurationSetSendingEnabled operation.
\n InvalidParameterValue: One or more of the parameters you\n specified when calling this operation was invalid. See the error message for\n additional information.
\n TransientFailure: Amazon SES was unable to process your request\n because of a temporary issue.
\n Failed: Amazon SES was unable to process your request. See the error\n message for additional information.
Creates a receipt rule set by cloning an existing one. All receipt rules and\n configurations are copied to the new receipt rule set and are completely independent of\n the source rule set.
\nFor information about setting up rule sets, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Creates a receipt rule set by cloning an existing one. All receipt rules and\n configurations are copied to the new receipt rule set and are completely independent of\n the source rule set.
\nFor information about setting up rule sets, see the Amazon SES Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#CloneReceiptRuleSetRequest": { @@ -446,7 +484,7 @@ "RuleSetName": { "target": "com.amazonaws.ses#ReceiptRuleSetName", "traits": { - "smithy.api#documentation": "The name of the rule set to create. The name must:
\nThis value can only contain ASCII letters (a-z, A-Z), numbers (0-9),\n underscores (_), or dashes (-).
\nStart and end with a letter or number.
\nContain less than 64 characters.
\nThe name of the rule set to create. The name must meet the following\n requirements:
\nContain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or\n dashes (-).
\nStart and end with a letter or number.
\nContain 64 characters or fewer.
\nRepresents a request to create a receipt rule set by cloning an existing one. You use\n receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" + "smithy.api#documentation": "Represents a request to create a receipt rule set by cloning an existing one. You use\n receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES\n Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#CloneReceiptRuleSetResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#CloudWatchDestination": { @@ -481,7 +521,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains information associated with an Amazon CloudWatch event destination to which email\n sending events are published.
\nEvent destinations, such as Amazon CloudWatch, are associated with configuration sets, which\n enable you to publish email sending events. For information about using configuration\n sets, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Contains information associated with an Amazon CloudWatch event destination to which email\n sending events are published.
\nEvent destinations, such as Amazon CloudWatch, are associated with configuration sets, which\n enable you to publish email sending events. For information about using configuration\n sets, see the Amazon SES Developer\n Guide.
" } }, "com.amazonaws.ses#CloudWatchDimensionConfiguration": { @@ -490,27 +530,27 @@ "DimensionName": { "target": "com.amazonaws.ses#DimensionName", "traits": { - "smithy.api#documentation": "The name of an Amazon CloudWatch dimension associated with an email sending metric. The name\n must:
\nThis value can only contain ASCII letters (a-z, A-Z), numbers (0-9),\n underscores (_), or dashes (-).
\nContain less than 256 characters.
\nThe name of an Amazon CloudWatch dimension associated with an email sending metric. The name\n must meet the following requirements:
\nContain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes\n (-), or colons (:).
\nContain 256 characters or fewer.
\nThe place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you\n want Amazon SES to use the message tags that you specify using an\n X-SES-MESSAGE-TAGS header or a parameter to the\n SendEmail/SendRawEmail API, choose\n messageTag. If you want Amazon SES to use your own email headers, choose\n emailHeader.
The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. To use\n the message tags that you specify using an X-SES-MESSAGE-TAGS header or a\n parameter to the SendEmail/SendRawEmail API, specify\n messageTag. To use your own email headers, specify\n emailHeader. To put a custom tag on any link included in your email,\n specify linkTag.
The default value of the dimension that is published to Amazon CloudWatch if you do not provide\n the value of the dimension when you send an email. The default value must:
\nThis value can only contain ASCII letters (a-z, A-Z), numbers (0-9),\n underscores (_), or dashes (-).
\nContain less than 256 characters.
\nThe default value of the dimension that is published to Amazon CloudWatch if you do not provide\n the value of the dimension when you send an email. The default value must meet the\n following requirements:
\nContain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes\n (-), at signs (@), or periods (.).
\nContain 256 characters or fewer.
\nContains the dimension configuration to use when you publish email sending events to\n Amazon CloudWatch.
\nFor information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide.
" + "smithy.api#documentation": "Contains the dimension configuration to use when you publish email sending events to\n Amazon CloudWatch.
\nFor information about publishing email sending events to Amazon CloudWatch, see the Amazon SES\n Developer Guide.
" } }, "com.amazonaws.ses#CloudWatchDimensionConfigurations": { @@ -525,13 +565,13 @@ "Name": { "target": "com.amazonaws.ses#ConfigurationSetName", "traits": { - "smithy.api#documentation": "The name of the configuration set. The name must meet the following\n requirements:
\nContain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes\n (-).
\nContain 64 characters or fewer.
\nThe name of the configuration set. The name must meet the following\n requirements:
\nContain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes\n (-).
\nContain 64 characters or fewer.
\nThe name of the configuration set.
\nConfiguration sets let you create groups of rules that you can apply to the emails you\n send using Amazon SES. For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide.
" + "smithy.api#documentation": "The name of the configuration set.
\nConfiguration sets let you create groups of rules that you can apply to the emails you\n send using Amazon SES. For more information about using configuration sets, see Using Amazon SES\n Configuration Sets in the Amazon SES Developer Guide.
" } }, "com.amazonaws.ses#ConfigurationSetAlreadyExistsException": { @@ -558,26 +598,32 @@ } }, "com.amazonaws.ses#ConfigurationSetAttribute": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "eventDestinations", - "name": "EVENT_DESTINATIONS" - }, - { - "value": "trackingOptions", - "name": "TRACKING_OPTIONS" - }, - { - "value": "deliveryOptions", - "name": "DELIVERY_OPTIONS" - }, - { - "value": "reputationOptions", - "name": "REPUTATION_OPTIONS" + "type": "enum", + "members": { + "EVENT_DESTINATIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eventDestinations" + } + }, + "TRACKING_OPTIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "trackingOptions" } - ] + }, + "DELIVERY_OPTIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deliveryOptions" + } + }, + "REPUTATION_OPTIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "reputationOptions" + } + } } }, "com.amazonaws.ses#ConfigurationSetAttributeList": { @@ -630,7 +676,7 @@ "code": "ConfigurationSetSendingPausedException", "httpResponseCode": 400 }, - "smithy.api#documentation": "Indicates that email sending is disabled for the configuration set.
\nYou can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.
", + "smithy.api#documentation": "Indicates that email sending is disabled for the configuration set.
\nYou can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -659,7 +705,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents textual data, plus an optional character set specification.
\nBy default, the text must be 7-bit ASCII, due to the constraints of the SMTP protocol.\n If the text must contain any other characters, then you must also specify a character\n set. Examples include UTF-8, ISO-8859-1, and Shift_JIS.
" + "smithy.api#documentation": "Represents textual data, plus an optional character set specification.
\nBy default, the text must be 7-bit ASCII, due to the constraints of the SMTP protocol.\n If the text must contain any other characters, then you must also specify a character\n set. Examples include UTF-8, ISO-8859-1, and Shift_JIS.
" } }, "com.amazonaws.ses#Counter": { @@ -688,7 +734,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a configuration set.
\nConfiguration sets enable you to publish email sending events. For information about\n using configuration sets, see the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Creates a configuration set.
\nConfiguration sets enable you to publish email sending events. For information about\n using configuration sets, see the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#CreateConfigurationSetEventDestination": { @@ -720,7 +766,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a configuration set event destination.
\nWhen you create or update an event destination, you must provide one, and only\n one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
\nAn event destination is the AWS service to which Amazon SES publishes the email sending\n events associated with a configuration set. For information about using configuration\n sets, see the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Creates a configuration set event destination.
\nWhen you create or update an event destination, you must provide one, and only\n one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
\nAn event destination is the Amazon Web Services service to which Amazon SES publishes the email sending\n events associated with a configuration set. For information about using configuration\n sets, see the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#CreateConfigurationSetEventDestinationRequest": { @@ -736,20 +782,22 @@ "EventDestination": { "target": "com.amazonaws.ses#EventDestination", "traits": { - "smithy.api#documentation": "An object that describes the AWS service that email sending event information will\n be published to.
", + "smithy.api#documentation": "An object that describes the Amazon Web Services service that email sending event where information\n is published.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents a request to create a configuration set event destination. A configuration\n set event destination, which can be either Amazon CloudWatch or Amazon Kinesis Firehose, describes an AWS service\n in which Amazon SES publishes the email sending events associated with a configuration set.\n For information about using configuration sets, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to create a configuration set event destination. A configuration\n set event destination, which can be either Amazon CloudWatch or Amazon Kinesis Firehose, describes an Amazon Web Services service\n in which Amazon SES publishes the email sending events associated with a configuration set.\n For information about using configuration sets, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#CreateConfigurationSetEventDestinationResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#CreateConfigurationSetRequest": { @@ -764,14 +812,16 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to create a configuration set. Configuration sets enable you to\n publish email sending events. For information about using configuration sets, see the\n Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to create a configuration set. Configuration sets enable you to\n publish email sending events. For information about using configuration sets, see the\n Amazon SES\n Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#CreateConfigurationSetResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#CreateConfigurationSetTrackingOptions": { @@ -794,7 +844,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an association between a configuration set and a custom domain for open and\n click event tracking.
\nBy default, images and links used for tracking open and click events are hosted on\n domains operated by Amazon SES. You can configure a subdomain of your own to handle these\n events. For information about using custom domains, see the Amazon SES Developer Guide.
" + "smithy.api#documentation": "Creates an association between a configuration set and a custom domain for open and\n click event tracking.
\nBy default, images and links used for tracking open and click events are hosted on\n domains operated by Amazon SES. You can configure a subdomain of your own to handle these\n events. For information about using custom domains, see the Amazon SES Developer Guide.
" } }, "com.amazonaws.ses#CreateConfigurationSetTrackingOptionsRequest": { @@ -815,14 +865,16 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to create an open and click tracking option object in a\n configuration set.
" + "smithy.api#documentation": "Represents a request to create an open and click tracking option object in a\n configuration set.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#CreateConfigurationSetTrackingOptionsResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#CreateCustomVerificationEmailTemplate": { @@ -848,7 +900,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new custom verification email template.
\nFor more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Creates a new custom verification email template.
\nFor more information about custom verification email templates, see Using\n Custom Verification Email Templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#CreateCustomVerificationEmailTemplateRequest": { @@ -878,7 +930,7 @@ "TemplateContent": { "target": "com.amazonaws.ses#TemplateContent", "traits": { - "smithy.api#documentation": "The content of the custom verification email. The total size of the email must be less\n than 10 MB. The message body may contain HTML, with some limitations. For more\n information, see Custom Verification Email Frequently Asked Questions in the Amazon SES\n Developer Guide.
", + "smithy.api#documentation": "The content of the custom verification email. The total size of the email must be less\n than 10 MB. The message body may contain HTML, with some limitations. For more\n information, see Custom\n Verification Email Frequently Asked Questions in the Amazon SES\n Developer Guide.
", "smithy.api#required": {} } }, @@ -898,7 +950,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to create a custom verification email template.
" + "smithy.api#documentation": "Represents a request to create a custom verification email template.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#CreateReceiptFilter": { @@ -918,7 +971,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new IP address filter.
\nFor information about setting up IP address filters, see the Amazon SES Developer Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Creates a new IP address filter.
\nFor information about setting up IP address filters, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#CreateReceiptFilterRequest": { @@ -933,14 +986,16 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to create a new IP address filter. You use IP address filters\n when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" + "smithy.api#documentation": "Represents a request to create a new IP address filter. You use IP address filters\n when you receive email with Amazon SES. For more information, see the Amazon SES\n Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#CreateReceiptFilterResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#CreateReceiptRule": { @@ -975,7 +1030,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a receipt rule.
\nFor information about setting up receipt rules, see the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Creates a receipt rule.
\nFor information about setting up receipt rules, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#CreateReceiptRuleRequest": { @@ -984,14 +1039,14 @@ "RuleSetName": { "target": "com.amazonaws.ses#ReceiptRuleSetName", "traits": { - "smithy.api#documentation": "The name of the rule set that the receipt rule will be added to.
", + "smithy.api#documentation": "The name of the rule set where the receipt rule is added.
", "smithy.api#required": {} } }, "After": { "target": "com.amazonaws.ses#ReceiptRuleName", "traits": { - "smithy.api#documentation": "The name of an existing rule after which the new rule will be placed. If this\n parameter is null, the new rule will be inserted at the beginning of the rule\n list.
" + "smithy.api#documentation": "The name of an existing rule after which the new rule is placed. If this parameter is\n null, the new rule is inserted at the beginning of the rule list.
" } }, "Rule": { @@ -1003,14 +1058,16 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to create a receipt rule. You use receipt rules to receive email\n with Amazon SES. For more information, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to create a receipt rule. You use receipt rules to receive email\n with Amazon SES. For more information, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#CreateReceiptRuleResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#CreateReceiptRuleSet": { @@ -1030,7 +1087,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an empty receipt rule set.
\nFor information about setting up receipt rule sets, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Creates an empty receipt rule set.
\nFor information about setting up receipt rule sets, see the Amazon SES Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#CreateReceiptRuleSetRequest": { @@ -1039,20 +1096,22 @@ "RuleSetName": { "target": "com.amazonaws.ses#ReceiptRuleSetName", "traits": { - "smithy.api#documentation": "The name of the rule set to create. The name must:
\nThis value can only contain ASCII letters (a-z, A-Z), numbers (0-9),\n underscores (_), or dashes (-).
\nStart and end with a letter or number.
\nContain less than 64 characters.
\nThe name of the rule set to create. The name must meet the following\n requirements:
\nContain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or\n dashes (-).
\nStart and end with a letter or number.
\nContain 64 characters or fewer.
\nRepresents a request to create an empty receipt rule set. You use receipt rule sets to\n receive email with Amazon SES. For more information, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to create an empty receipt rule set. You use receipt rule sets to\n receive email with Amazon SES. For more information, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#CreateReceiptRuleSetResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#CreateTemplate": { @@ -1075,7 +1134,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an email template. Email templates enable you to send personalized email to\n one or more destinations in a single API operation. For more information, see the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Creates an email template. Email templates enable you to send personalized email to\n one or more destinations in a single operation. For more information, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#CreateTemplateRequest": { @@ -1084,40 +1143,50 @@ "Template": { "target": "com.amazonaws.ses#Template", "traits": { - "smithy.api#documentation": "The content of the email, composed of a subject line, an HTML part, and a text-only\n part.
", + "smithy.api#documentation": "The content of the email, composed of a subject line and either an HTML part or a\n text-only part.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents a request to create an email template. For more information, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to create an email template. For more information, see the Amazon SES\n Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#CreateTemplateResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ses#CustomMailFromStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Pending", - "name": "Pending" - }, - { - "value": "Success", - "name": "Success" - }, - { - "value": "Failed", - "name": "Failed" - }, - { - "value": "TemporaryFailure", - "name": "TemporaryFailure" + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" } - ] + }, + "TemporaryFailure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TemporaryFailure" + } + } } }, "com.amazonaws.ses#CustomRedirectDomain": { @@ -1247,7 +1316,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a configuration set. Configuration sets enable you to publish email sending\n events. For information about using configuration sets, see the Amazon SES Developer Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Deletes a configuration set. Configuration sets enable you to publish email sending\n events. For information about using configuration sets, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#DeleteConfigurationSetEventDestination": { @@ -1267,7 +1336,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a configuration set event destination. Configuration set event destinations\n are associated with configuration sets, which enable you to publish email sending\n events. For information about using configuration sets, see the Amazon SES Developer Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Deletes a configuration set event destination. Configuration set event destinations\n are associated with configuration sets, which enable you to publish email sending\n events. For information about using configuration sets, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#DeleteConfigurationSetEventDestinationRequest": { @@ -1289,14 +1358,16 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to delete a configuration set event destination. Configuration\n set event destinations are associated with configuration sets, which enable you to\n publish email sending events. For information about using configuration sets, see the\n Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to delete a configuration set event destination. Configuration\n set event destinations are associated with configuration sets, which enable you to\n publish email sending events. For information about using configuration sets, see the\n Amazon SES\n Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#DeleteConfigurationSetEventDestinationResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#DeleteConfigurationSetRequest": { @@ -1311,14 +1382,16 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to delete a configuration set. Configuration sets enable you to\n publish email sending events. For information about using configuration sets, see the\n Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to delete a configuration set. Configuration sets enable you to\n publish email sending events. For information about using configuration sets, see the\n Amazon SES\n Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#DeleteConfigurationSetResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#DeleteConfigurationSetTrackingOptions": { @@ -1338,7 +1411,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an association between a configuration set and a custom domain for open and\n click event tracking.
\nBy default, images and links used for tracking open and click events are hosted on\n domains operated by Amazon SES. You can configure a subdomain of your own to handle these\n events. For information about using custom domains, see the Amazon SES Developer Guide.
\nDeleting this kind of association will result in emails sent using the specified\n configuration set to capture open and click events using the standard,\n Amazon SES-operated domains.
\nDeletes an association between a configuration set and a custom domain for open and\n click event tracking.
\nBy default, images and links used for tracking open and click events are hosted on\n domains operated by Amazon SES. You can configure a subdomain of your own to handle these\n events. For information about using custom domains, see the Amazon SES Developer Guide.
\nDeleting this kind of association results in emails sent using the specified\n configuration set to capture open and click events using the standard,\n Amazon SES-operated domains.
\nThe name of the configuration set from which you want to delete the tracking\n options.
", + "smithy.api#documentation": "The name of the configuration set.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents a request to delete open and click tracking options in a configuration set.\n
" + "smithy.api#documentation": "Represents a request to delete open and click tracking options in a configuration set.\n
", + "smithy.api#input": {} } }, "com.amazonaws.ses#DeleteConfigurationSetTrackingOptionsResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#DeleteCustomVerificationEmailTemplate": { @@ -1372,7 +1447,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Deletes an existing custom verification email template.
\nFor more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Deletes an existing custom verification email template.
\nFor more information about custom verification email templates, see Using\n Custom Verification Email Templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#DeleteCustomVerificationEmailTemplateRequest": { @@ -1381,13 +1456,14 @@ "TemplateName": { "target": "com.amazonaws.ses#TemplateName", "traits": { - "smithy.api#documentation": "The name of the custom verification email template that you want to delete.
", + "smithy.api#documentation": "The name of the custom verification email template to delete.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents a request to delete an existing custom verification email template.
" + "smithy.api#documentation": "Represents a request to delete an existing custom verification email template.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#DeleteIdentity": { @@ -1399,7 +1475,7 @@ "target": "com.amazonaws.ses#DeleteIdentityResponse" }, "traits": { - "smithy.api#documentation": "Deletes the specified identity (an email address or a domain) from the list of\n verified identities.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Deletes the specified identity (an email address or a domain) from the list of\n verified identities.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#DeleteIdentityPolicy": { @@ -1411,7 +1487,7 @@ "target": "com.amazonaws.ses#DeleteIdentityPolicyResponse" }, "traits": { - "smithy.api#documentation": "Deletes the specified sending authorization policy for the given identity (an email\n address or a domain). This API returns successfully even if a policy with the specified\n name does not exist.
\nThis API is for the identity owner only. If you have not verified the identity,\n this API will return an error.
\nSending authorization is a feature that enables an identity owner to authorize other\n senders to use its identities. For information about using sending authorization, see\n the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Deletes the specified sending authorization policy for the given identity (an email\n address or a domain). This operation returns successfully even if a policy with the\n specified name does not exist.
\nThis operation is for the identity owner only. If you have not verified the\n identity, it returns an error.
\nSending authorization is a feature that enables an identity owner to authorize other\n senders to use its identities. For information about using sending authorization, see\n the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#DeleteIdentityPolicyRequest": { @@ -1420,7 +1496,7 @@ "Identity": { "target": "com.amazonaws.ses#Identity", "traits": { - "smithy.api#documentation": "The identity that is associated with the policy that you want to delete. You can\n specify the identity by using its name or by using its Amazon Resource Name (ARN).\n Examples: user@example.com, example.com,\n arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this API, you must own the identity.
", + "smithy.api#documentation": "The identity that is associated with the policy to delete. You can specify the\n identity by using its name or by using its Amazon Resource Name (ARN). Examples:\n user@example.com, example.com,\n arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this operation, you must own the identity.
", "smithy.api#required": {} } }, @@ -1433,14 +1509,16 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to delete a sending authorization policy for an identity. Sending\n authorization is an Amazon SES feature that enables you to authorize other senders to use\n your identities. For information, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to delete a sending authorization policy for an identity. Sending\n authorization is an Amazon SES feature that enables you to authorize other senders to use\n your identities. For information, see the Amazon SES Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#DeleteIdentityPolicyResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#DeleteIdentityRequest": { @@ -1449,20 +1527,22 @@ "Identity": { "target": "com.amazonaws.ses#Identity", "traits": { - "smithy.api#documentation": "The identity to be removed from the list of identities for the AWS Account.
", + "smithy.api#documentation": "The identity to be removed from the list of identities for the Amazon Web Services account.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents a request to delete one of your Amazon SES identities (an email address or\n domain).
" + "smithy.api#documentation": "Represents a request to delete one of your Amazon SES identities (an email address or\n domain).
", + "smithy.api#input": {} } }, "com.amazonaws.ses#DeleteIdentityResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#DeleteReceiptFilter": { @@ -1474,7 +1554,7 @@ "target": "com.amazonaws.ses#DeleteReceiptFilterResponse" }, "traits": { - "smithy.api#documentation": "Deletes the specified IP address filter.
\nFor information about managing IP address filters, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Deletes the specified IP address filter.
\nFor information about managing IP address filters, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#DeleteReceiptFilterRequest": { @@ -1489,14 +1569,16 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to delete an IP address filter. You use IP address filters when\n you receive email with Amazon SES. For more information, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to delete an IP address filter. You use IP address filters when\n you receive email with Amazon SES. For more information, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#DeleteReceiptFilterResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#DeleteReceiptRule": { @@ -1513,7 +1595,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified receipt rule.
\nFor information about managing receipt rules, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Deletes the specified receipt rule.
\nFor information about managing receipt rules, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#DeleteReceiptRuleRequest": { @@ -1535,14 +1617,16 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to delete a receipt rule. You use receipt rules to receive email\n with Amazon SES. For more information, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to delete a receipt rule. You use receipt rules to receive email\n with Amazon SES. For more information, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#DeleteReceiptRuleResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#DeleteReceiptRuleSet": { @@ -1559,7 +1643,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified receipt rule set and all of the receipt rules it\n contains.
\nThe currently active rule set cannot be deleted.
\nFor information about managing receipt rule sets, see the Amazon SES Developer Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Deletes the specified receipt rule set and all of the receipt rules it\n contains.
\nThe currently active rule set cannot be deleted.
\nFor information about managing receipt rule sets, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#DeleteReceiptRuleSetRequest": { @@ -1574,14 +1658,16 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to delete a receipt rule set and all of the receipt rules it\n contains. You use receipt rule sets to receive email with Amazon SES. For more information,\n see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to delete a receipt rule set and all of the receipt rules it\n contains. You use receipt rule sets to receive email with Amazon SES. For more information,\n see the Amazon SES Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#DeleteReceiptRuleSetResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#DeleteTemplate": { @@ -1593,7 +1679,7 @@ "target": "com.amazonaws.ses#DeleteTemplateResponse" }, "traits": { - "smithy.api#documentation": "Deletes an email template.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Deletes an email template.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#DeleteTemplateRequest": { @@ -1608,12 +1694,16 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to delete an email template. For more information, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to delete an email template. For more information, see the Amazon SES\n Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#DeleteTemplateResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ses#DeleteVerifiedEmailAddress": { "type": "operation", @@ -1639,7 +1729,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to delete an email address from the list of email addresses you\n have attempted to verify under your AWS account.
" + "smithy.api#documentation": "Represents a request to delete an email address from the list of email addresses you\n have attempted to verify under your Amazon Web Services account.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#DeliveryOptions": { @@ -1665,14 +1756,15 @@ "target": "com.amazonaws.ses#DescribeActiveReceiptRuleSetResponse" }, "traits": { - "smithy.api#documentation": "Returns the metadata and receipt rules for the receipt rule set that is currently\n active.
\nFor information about setting up receipt rule sets, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Returns the metadata and receipt rules for the receipt rule set that is currently\n active.
\nFor information about setting up receipt rule sets, see the Amazon SES Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#DescribeActiveReceiptRuleSetRequest": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Represents a request to return the metadata and receipt rules for the receipt rule set\n that is currently active. You use receipt rule sets to receive email with Amazon SES. For\n more information, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to return the metadata and receipt rules for the receipt rule set\n that is currently active. You use receipt rule sets to receive email with Amazon SES. For\n more information, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#DescribeActiveReceiptRuleSetResponse": { @@ -1692,7 +1784,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the metadata and receipt rules for the receipt rule set that is currently\n active.
" + "smithy.api#documentation": "Represents the metadata and receipt rules for the receipt rule set that is currently\n active.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#DescribeConfigurationSet": { @@ -1709,7 +1802,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the details of the specified configuration set. For information about using\n configuration sets, see the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Returns the details of the specified configuration set. For information about using\n configuration sets, see the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#DescribeConfigurationSetRequest": { @@ -1730,7 +1823,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to return the details of a configuration set. Configuration sets\n enable you to publish email sending events. For information about using configuration\n sets, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to return the details of a configuration set. Configuration sets\n enable you to publish email sending events. For information about using configuration\n sets, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#DescribeConfigurationSetResponse": { @@ -1765,7 +1859,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the details of a configuration set. Configuration sets enable you to\n publish email sending events. For information about using configuration sets, see the\n Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents the details of a configuration set. Configuration sets enable you to\n publish email sending events. For information about using configuration sets, see the\n Amazon SES\n Developer Guide.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#DescribeReceiptRule": { @@ -1785,7 +1880,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the details of the specified receipt rule.
\nFor information about setting up receipt rules, see the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Returns the details of the specified receipt rule.
\nFor information about setting up receipt rules, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#DescribeReceiptRuleRequest": { @@ -1807,7 +1902,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to return the details of a receipt rule. You use receipt rules to\n receive email with Amazon SES. For more information, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to return the details of a receipt rule. You use receipt rules to\n receive email with Amazon SES. For more information, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#DescribeReceiptRuleResponse": { @@ -1821,7 +1917,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the details of a receipt rule.
" + "smithy.api#documentation": "Represents the details of a receipt rule.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#DescribeReceiptRuleSet": { @@ -1838,7 +1935,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the details of the specified receipt rule set.
\nFor information about managing receipt rule sets, see the Amazon SES Developer Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Returns the details of the specified receipt rule set.
\nFor information about managing receipt rule sets, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#DescribeReceiptRuleSetRequest": { @@ -1853,7 +1950,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to return the details of a receipt rule set. You use receipt rule\n sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" + "smithy.api#documentation": "Represents a request to return the details of a receipt rule set. You use receipt rule\n sets to receive email with Amazon SES. For more information, see the Amazon SES\n Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#DescribeReceiptRuleSetResponse": { @@ -1873,7 +1971,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the details of the specified receipt rule set.
" + "smithy.api#documentation": "Represents the details of the specified receipt rule set.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#Destination": { @@ -1899,7 +1998,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the destination of the message, consisting of To:, CC:, and BCC:\n fields.
\nAmazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the\n local part of a destination email address (the part of the\n email address that precedes the @ sign) may only contain 7-bit ASCII\n characters. If the domain part of an address (the\n part after the @ sign) contains non-ASCII characters, they must be encoded using\n Punycode, as described in RFC3492.
\nRepresents the destination of the message, consisting of To:, CC:, and BCC:\n fields.
\nAmazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the\n email address string must be 7-bit ASCII. If you want to send to or from email\n addresses that contain Unicode characters in the domain part of an address, you must\n encode the domain using Punycode. Punycode is not permitted in the local part of the\n email address (the part before the @ sign) nor in the \"friendly from\" name. If you\n want to use Unicode characters in the \"friendly from\" name, you must encode the\n \"friendly from\" name using MIME encoded-word syntax, as described in Sending raw email\n using the Amazon SES API. For more information about Punycode, see RFC 3492.
\nThe name of the event destination. The name must:
\nThis value can only contain ASCII letters (a-z, A-Z), numbers (0-9),\n underscores (_), or dashes (-).
\nContain less than 64 characters.
\nThe name of the event destination. The name must meet the following\n requirements:
\nContain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or\n dashes (-).
\nContain 64 characters or fewer.
\nThe type of email sending events to publish to the event destination.
", + "smithy.api#documentation": "The type of email sending events to publish to the event destination.
\n\n send - The call was successful and Amazon SES is attempting to deliver\n the email.
\n reject - Amazon SES determined that the email contained a virus and\n rejected it.
\n bounce - The recipient's mail server permanently rejected the\n email. This corresponds to a hard bounce.
\n complaint - The recipient marked the email as spam.
\n delivery - Amazon SES successfully delivered the email to the\n recipient's mail server.
\n open - The recipient received the email and opened it in their\n email client.
\n click - The recipient clicked one or more links in the\n email.
\n renderingFailure - Amazon SES did not send the email because of a\n template rendering issue.
Contains information about the event destination that the specified email sending\n events will be published to.
\nWhen you create or update an event destination, you must provide one, and only\n one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).
\nEvent destinations are associated with configuration sets, which enable you to publish\n email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about\n using configuration sets, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Contains information about an event destination.
\nWhen you create or update an event destination, you must provide one, and only\n one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).
\nEvent destinations are associated with configuration sets, which enable you to publish\n email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about\n using configuration sets, see the Amazon SES Developer\n Guide.
" } }, "com.amazonaws.ses#EventDestinationAlreadyExistsException": { @@ -2096,42 +2207,56 @@ } }, "com.amazonaws.ses#EventType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "send", - "name": "SEND" - }, - { - "value": "reject", - "name": "REJECT" - }, - { - "value": "bounce", - "name": "BOUNCE" - }, - { - "value": "complaint", - "name": "COMPLAINT" - }, - { - "value": "delivery", - "name": "DELIVERY" - }, - { - "value": "open", - "name": "OPEN" - }, - { - "value": "click", - "name": "CLICK" - }, - { - "value": "renderingFailure", - "name": "RENDERING_FAILURE" + "type": "enum", + "members": { + "SEND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "send" + } + }, + "REJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "reject" + } + }, + "BOUNCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "bounce" + } + }, + "COMPLAINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "complaint" + } + }, + "DELIVERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delivery" + } + }, + "OPEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open" } - ] + }, + "CLICK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "click" + } + }, + "RENDERING_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "renderingFailure" + } + } } }, "com.amazonaws.ses#EventTypes": { @@ -2156,13 +2281,13 @@ "Value": { "target": "com.amazonaws.ses#ExtensionFieldValue", "traits": { - "smithy.api#documentation": "The value of the header to add. Must be less than 2048 characters, and must not\n contain newline characters (\"\\r\" or \"\\n\").
", + "smithy.api#documentation": "The value of the header to add. Must contain 2048 characters or fewer, and must not\n contain newline characters (\"\\r\" or \"\\n\").
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Additional X-headers to include in the Delivery Status Notification (DSN) when an\n email that Amazon SES receives on your behalf bounces.
\nFor information about receiving email through Amazon SES, see the Amazon SES\n Developer Guide.
" + "smithy.api#documentation": "Additional X-headers to include in the Delivery Status Notification (DSN) when an\n email that Amazon SES receives on your behalf bounces.
\nFor information about receiving email through Amazon SES, see the Amazon SES Developer\n Guide.
" } }, "com.amazonaws.ses#ExtensionFieldList": { @@ -2215,7 +2340,7 @@ "target": "com.amazonaws.ses#GetAccountSendingEnabledResponse" }, "traits": { - "smithy.api#documentation": "Returns the email sending status of the Amazon SES account for the current region.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Returns the email sending status of the Amazon SES account for the current Region.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#GetAccountSendingEnabledResponse": { @@ -2225,12 +2350,13 @@ "target": "com.amazonaws.ses#Enabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Describes whether email sending is enabled or disabled for your Amazon SES account in the\n current AWS Region.
" + "smithy.api#documentation": "Describes whether email sending is enabled or disabled for your Amazon SES account in the\n current Amazon Web Services Region.
" } } }, "traits": { - "smithy.api#documentation": "Represents a request to return the email sending status for your Amazon SES account in the\n current AWS Region.
" + "smithy.api#documentation": "Represents a request to return the email sending status for your Amazon SES account in the\n current Amazon Web Services Region.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#GetCustomVerificationEmailTemplate": { @@ -2247,7 +2373,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the custom email verification template for the template name you\n specify.
\nFor more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Returns the custom email verification template for the template name you\n specify.
\nFor more information about custom verification email templates, see Using\n Custom Verification Email Templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#GetCustomVerificationEmailTemplateRequest": { @@ -2256,13 +2382,14 @@ "TemplateName": { "target": "com.amazonaws.ses#TemplateName", "traits": { - "smithy.api#documentation": "The name of the custom verification email template that you want to retrieve.
", + "smithy.api#documentation": "The name of the custom verification email template to retrieve.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents a request to retrieve an existing custom verification email\n template.
" + "smithy.api#documentation": "Represents a request to retrieve an existing custom verification email\n template.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#GetCustomVerificationEmailTemplateResponse": { @@ -2306,7 +2433,8 @@ } }, "traits": { - "smithy.api#documentation": "The content of the custom verification email template.
" + "smithy.api#documentation": "The content of the custom verification email template.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#GetIdentityDkimAttributes": { @@ -2318,7 +2446,7 @@ "target": "com.amazonaws.ses#GetIdentityDkimAttributesResponse" }, "traits": { - "smithy.api#documentation": "Returns the current status of Easy DKIM signing for an entity. For domain name\n identities, this operation also returns the DKIM tokens that are required for Easy DKIM\n signing, and whether Amazon SES has successfully verified that these tokens have been\n published.
\nThis operation takes a list of identities as input and returns the following\n information for each:
\nWhether Easy DKIM signing is enabled or disabled.
\nA set of DKIM tokens that represent the identity. If the identity is an email\n address, the tokens represent the domain of that address.
\nWhether Amazon SES has successfully verified the DKIM tokens published in the\n domain's DNS. This information is only returned for domain name identities, not\n for email addresses.
\nThis operation is throttled at one request per second and can only get DKIM attributes\n for up to 100 identities at a time.
\nFor more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
" + "smithy.api#documentation": "Returns the current status of Easy DKIM signing for an entity. For domain name\n identities, this operation also returns the DKIM tokens that are required for Easy DKIM\n signing, and whether Amazon SES has successfully verified that these tokens have been\n published.
\nThis operation takes a list of identities as input and returns the following\n information for each:
\nWhether Easy DKIM signing is enabled or disabled.
\nA set of DKIM tokens that represent the identity. If the identity is an email\n address, the tokens represent the domain of that address.
\nWhether Amazon SES has successfully verified the DKIM tokens published in the\n domain's DNS. This information is only returned for domain name identities, not\n for email addresses.
\nThis operation is throttled at one request per second and can only get DKIM attributes\n for up to 100 identities at a time.
\nFor more information about creating DNS records using DKIM tokens, go to the Amazon SES\n Developer Guide.
" } }, "com.amazonaws.ses#GetIdentityDkimAttributesRequest": { @@ -2333,7 +2461,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request for the status of Amazon SES Easy DKIM signing for an identity. For\n domain identities, this request also returns the DKIM tokens that are required for Easy\n DKIM signing, and whether Amazon SES successfully verified that these tokens were published.\n For more information about Easy DKIM, see the Amazon SES Developer Guide.
" + "smithy.api#documentation": "Represents a request for the status of Amazon SES Easy DKIM signing for an identity. For\n domain identities, this request also returns the DKIM tokens that are required for Easy\n DKIM signing, and whether Amazon SES successfully verified that these tokens were published.\n For more information about Easy DKIM, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#GetIdentityDkimAttributesResponse": { @@ -2348,7 +2477,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the status of Amazon SES Easy DKIM signing for an identity. For domain\n identities, this response also contains the DKIM tokens that are required for Easy DKIM\n signing, and whether Amazon SES successfully verified that these tokens were\n published.
" + "smithy.api#documentation": "Represents the status of Amazon SES Easy DKIM signing for an identity. For domain\n identities, this response also contains the DKIM tokens that are required for Easy DKIM\n signing, and whether Amazon SES successfully verified that these tokens were\n published.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#GetIdentityMailFromDomainAttributes": { @@ -2360,7 +2490,7 @@ "target": "com.amazonaws.ses#GetIdentityMailFromDomainAttributesResponse" }, "traits": { - "smithy.api#documentation": "Returns the custom MAIL FROM attributes for a list of identities (email addresses :\n domains).
\nThis operation is throttled at one request per second and can only get custom MAIL\n FROM attributes for up to 100 identities at a time.
" + "smithy.api#documentation": "Returns the custom MAIL FROM attributes for a list of identities (email addresses :\n domains).
\nThis operation is throttled at one request per second and can only get custom MAIL\n FROM attributes for up to 100 identities at a time.
" } }, "com.amazonaws.ses#GetIdentityMailFromDomainAttributesRequest": { @@ -2375,7 +2505,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to return the Amazon SES custom MAIL FROM attributes for a list of\n identities. For information about using a custom MAIL FROM domain, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to return the Amazon SES custom MAIL FROM attributes for a list of\n identities. For information about using a custom MAIL FROM domain, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#GetIdentityMailFromDomainAttributesResponse": { @@ -2390,7 +2521,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the custom MAIL FROM attributes for a list of identities.
" + "smithy.api#documentation": "Represents the custom MAIL FROM attributes for a list of identities.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#GetIdentityNotificationAttributes": { @@ -2402,7 +2534,7 @@ "target": "com.amazonaws.ses#GetIdentityNotificationAttributesResponse" }, "traits": { - "smithy.api#documentation": "Given a list of verified identities (email addresses and/or domains), returns a\n structure describing identity notification attributes.
\nThis operation is throttled at one request per second and can only get notification\n attributes for up to 100 identities at a time.
\nFor more information about using notifications with Amazon SES, see the Amazon SES\n Developer Guide.
" + "smithy.api#documentation": "Given a list of verified identities (email addresses and/or domains), returns a\n structure describing identity notification attributes.
\nThis operation is throttled at one request per second and can only get notification\n attributes for up to 100 identities at a time.
\nFor more information about using notifications with Amazon SES, see the Amazon SES\n Developer Guide.
" } }, "com.amazonaws.ses#GetIdentityNotificationAttributesRequest": { @@ -2417,7 +2549,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to return the notification attributes for a list of identities\n you verified with Amazon SES. For information about Amazon SES notifications, see the Amazon SES\n Developer Guide.
" + "smithy.api#documentation": "Represents a request to return the notification attributes for a list of identities\n you verified with Amazon SES. For information about Amazon SES notifications, see the Amazon SES\n Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#GetIdentityNotificationAttributesResponse": { @@ -2432,7 +2565,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the notification attributes for a list of identities.
" + "smithy.api#documentation": "Represents the notification attributes for a list of identities.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#GetIdentityPolicies": { @@ -2444,7 +2578,7 @@ "target": "com.amazonaws.ses#GetIdentityPoliciesResponse" }, "traits": { - "smithy.api#documentation": "Returns the requested sending authorization policies for the given identity (an email\n address or a domain). The policies are returned as a map of policy names to policy\n contents. You can retrieve a maximum of 20 policies at a time.
\nThis API is for the identity owner only. If you have not verified the identity,\n this API will return an error.
\nSending authorization is a feature that enables an identity owner to authorize other\n senders to use its identities. For information about using sending authorization, see\n the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Returns the requested sending authorization policies for the given identity (an email\n address or a domain). The policies are returned as a map of policy names to policy\n contents. You can retrieve a maximum of 20 policies at a time.
\nThis operation is for the identity owner only. If you have not verified the\n identity, it returns an error.
\nSending authorization is a feature that enables an identity owner to authorize other\n senders to use its identities. For information about using sending authorization, see\n the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#GetIdentityPoliciesRequest": { @@ -2453,7 +2587,7 @@ "Identity": { "target": "com.amazonaws.ses#Identity", "traits": { - "smithy.api#documentation": "The identity for which the policies will be retrieved. You can specify an identity by\n using its name or by using its Amazon Resource Name (ARN). Examples:\n user@example.com, example.com,\n arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this API, you must own the identity.
", + "smithy.api#documentation": "The identity for which the policies are retrieved. You can specify an identity by\n using its name or by using its Amazon Resource Name (ARN). Examples:\n user@example.com, example.com,\n arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this operation, you must own the identity.
", "smithy.api#required": {} } }, @@ -2466,7 +2600,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to return the requested sending authorization policies for an\n identity. Sending authorization is an Amazon SES feature that enables you to authorize other\n senders to use your identities. For information, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to return the requested sending authorization policies for an\n identity. Sending authorization is an Amazon SES feature that enables you to authorize other\n senders to use your identities. For information, see the Amazon SES Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#GetIdentityPoliciesResponse": { @@ -2481,7 +2616,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the requested sending authorization policies.
" + "smithy.api#documentation": "Represents the requested sending authorization policies.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#GetIdentityVerificationAttributes": { @@ -2493,7 +2629,7 @@ "target": "com.amazonaws.ses#GetIdentityVerificationAttributesResponse" }, "traits": { - "smithy.api#documentation": "Given a list of identities (email addresses and/or domains), returns the verification\n status and (for domain identities) the verification token for each identity.
\nThe verification status of an email address is \"Pending\" until the email address owner\n clicks the link within the verification email that Amazon SES sent to that address. If the\n email address owner clicks the link within 24 hours, the verification status of the\n email address changes to \"Success\". If the link is not clicked within 24 hours, the\n verification status changes to \"Failed.\" In that case, if you still want to verify the\n email address, you must restart the verification process from the beginning.
\nFor domain identities, the domain's verification status is \"Pending\" as Amazon SES searches\n for the required TXT record in the DNS settings of the domain. When Amazon SES detects the\n record, the domain's verification status changes to \"Success\". If Amazon SES is unable to\n detect the record within 72 hours, the domain's verification status changes to \"Failed.\"\n In that case, if you still want to verify the domain, you must restart the verification\n process from the beginning.
\nThis operation is throttled at one request per second and can only get verification\n attributes for up to 100 identities at a time.
", + "smithy.api#documentation": "Given a list of identities (email addresses and/or domains), returns the verification\n status and (for domain identities) the verification token for each identity.
\nThe verification status of an email address is \"Pending\" until the email address owner\n clicks the link within the verification email that Amazon SES sent to that address. If the\n email address owner clicks the link within 24 hours, the verification status of the\n email address changes to \"Success\". If the link is not clicked within 24 hours, the\n verification status changes to \"Failed.\" In that case, to verify the email address, you\n must restart the verification process from the beginning.
\nFor domain identities, the domain's verification status is \"Pending\" as Amazon SES searches\n for the required TXT record in the DNS settings of the domain. When Amazon SES detects the\n record, the domain's verification status changes to \"Success\". If Amazon SES is unable to\n detect the record within 72 hours, the domain's verification status changes to \"Failed.\"\n In that case, to verify the domain, you must restart the verification process from the\n beginning.
\nThis operation is throttled at one request per second and can only get verification\n attributes for up to 100 identities at a time.
", "smithy.waiters#waitable": { "IdentityExists": { "acceptors": [ @@ -2525,7 +2661,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to return the Amazon SES verification status of a list of identities.\n For domain identities, this request also returns the verification token. For information\n about verifying identities with Amazon SES, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to return the Amazon SES verification status of a list of identities.\n For domain identities, this request also returns the verification token. For information\n about verifying identities with Amazon SES, see the Amazon SES Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#GetIdentityVerificationAttributesResponse": { @@ -2540,7 +2677,8 @@ } }, "traits": { - "smithy.api#documentation": "The Amazon SES verification status of a list of identities. For domain identities, this\n response also contains the verification token.
" + "smithy.api#documentation": "The Amazon SES verification status of a list of identities. For domain identities, this\n response also contains the verification token.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#GetSendQuota": { @@ -2552,7 +2690,7 @@ "target": "com.amazonaws.ses#GetSendQuotaResponse" }, "traits": { - "smithy.api#documentation": "Provides the sending limits for the Amazon SES account.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Provides the sending limits for the Amazon SES account.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#GetSendQuotaResponse": { @@ -2569,7 +2707,7 @@ "target": "com.amazonaws.ses#MaxSendRate", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of emails that Amazon SES can accept from the user's account per\n second.
\nThe rate at which Amazon SES accepts the user's messages might be less than the maximum\n send rate.
\nThe maximum number of emails that Amazon SES can accept from the user's account per\n second.
\nThe rate at which Amazon SES accepts the user's messages might be less than the maximum\n send rate.
\nRepresents your Amazon SES daily sending quota, maximum send rate, and the number of emails\n you have sent in the last 24 hours.
" + "smithy.api#documentation": "Represents your Amazon SES daily sending quota, maximum send rate, and the number of emails\n you have sent in the last 24 hours.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#GetSendStatistics": { @@ -2593,7 +2732,7 @@ "target": "com.amazonaws.ses#GetSendStatisticsResponse" }, "traits": { - "smithy.api#documentation": "Provides sending statistics for the current AWS Region. The result is a list of data\n points, representing the last two weeks of sending activity. Each data point in the list\n contains statistics for a 15-minute period of time.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Provides sending statistics for the current Amazon Web Services Region. The result is a list of data\n points, representing the last two weeks of sending activity. Each data point in the list\n contains statistics for a 15-minute period of time.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#GetSendStatisticsResponse": { @@ -2607,7 +2746,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a list of data points. This list contains aggregated data from the previous\n two weeks of your sending activity with Amazon SES.
" + "smithy.api#documentation": "Represents a list of data points. This list contains aggregated data from the previous\n two weeks of your sending activity with Amazon SES.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#GetTemplate": { @@ -2624,7 +2764,7 @@ } ], "traits": { - "smithy.api#documentation": "Displays the template object (which includes the Subject line, HTML part and text\n part) for the template you specify.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Displays the template object (which includes the Subject line, HTML part and text\n part) for the template you specify.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#GetTemplateRequest": { @@ -2633,10 +2773,13 @@ "TemplateName": { "target": "com.amazonaws.ses#TemplateName", "traits": { - "smithy.api#documentation": "The name of the template you want to retrieve.
", + "smithy.api#documentation": "The name of the template to retrieve.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.ses#GetTemplateResponse": { @@ -2645,6 +2788,9 @@ "Template": { "target": "com.amazonaws.ses#Template" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ses#HeaderName": { @@ -2680,7 +2826,7 @@ "DkimTokens": { "target": "com.amazonaws.ses#VerificationTokenList", "traits": { - "smithy.api#documentation": "A set of character strings that represent the domain's identity. Using these tokens,\n you need to create DNS CNAME records that point to DKIM public keys that are hosted by\n Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection\n process might take up to 72 hours. After successful detection, Amazon SES is able to\n DKIM-sign email originating from that domain. (This only applies to domain identities,\n not email address identities.)
\nFor more information about creating DNS records using DKIM tokens, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "A set of character strings that represent the domain's identity. Using these tokens,\n you need to create DNS CNAME records that point to DKIM public keys that are hosted by\n Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection\n process might take up to 72 hours. After successful detection, Amazon SES is able to\n DKIM-sign email originating from that domain. (This only applies to domain identities,\n not email address identities.)
\nFor more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.
" } } }, @@ -2714,7 +2860,7 @@ "BehaviorOnMXFailure": { "target": "com.amazonaws.ses#BehaviorOnMXFailure", "traits": { - "smithy.api#documentation": "The action that Amazon SES takes if it cannot successfully read the required MX record when\n you send an email. A value of UseDefaultValue indicates that if Amazon SES\n cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as\n the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES\n cannot read the required MX record, Amazon SES returns a\n MailFromDomainNotVerified error and does not send the email.
The custom MAIL FROM setup states that result in this behavior are\n Pending, Failed, and TemporaryFailure.
The action that Amazon SES takes if it cannot successfully read the required MX record when\n you send an email. A value of UseDefaultValue indicates that if Amazon SES\n cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as\n the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES\n cannot read the required MX record, Amazon SES returns a\n MailFromDomainNotVerified error and does not send the email.
The custom MAIL FROM setup states that result in this behavior are\n Pending, Failed, and TemporaryFailure.
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce\n notifications.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes bounce\n notifications.
", "smithy.api#required": {} } }, "ComplaintTopic": { "target": "com.amazonaws.ses#NotificationTopic", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint\n notifications.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes complaint\n notifications.
", "smithy.api#required": {} } }, "DeliveryTopic": { "target": "com.amazonaws.ses#NotificationTopic", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery\n notifications.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes delivery\n notifications.
", "smithy.api#required": {} } }, @@ -2751,7 +2897,7 @@ "target": "com.amazonaws.ses#Enabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Describes whether Amazon SES will forward bounce and complaint notifications as email.\n true indicates that Amazon SES will forward bounce and complaint\n notifications as email, while false indicates that bounce and complaint\n notifications will be published only to the specified bounce and complaint Amazon SNS\n topics.
Describes whether Amazon SES forwards bounce and complaint notifications as email.\n true indicates that Amazon SES forwards bounce and complaint notifications\n as email, while false indicates that bounce and complaint notifications are\n published only to the specified bounce and complaint Amazon SNS topics.
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of\n type Bounce. A value of true specifies that Amazon SES will include\n headers in bounce notifications, and a value of false specifies that Amazon SES\n will not include headers in bounce notifications.
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of\n type Bounce. A value of true specifies that Amazon SES includes\n headers in bounce notifications, and a value of false specifies that Amazon SES\n does not include headers in bounce notifications.
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of\n type Complaint. A value of true specifies that Amazon SES will\n include headers in complaint notifications, and a value of false specifies\n that Amazon SES will not include headers in complaint notifications.
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of\n type Complaint. A value of true specifies that Amazon SES includes\n headers in complaint notifications, and a value of false specifies that\n Amazon SES does not include headers in complaint notifications.
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of\n type Delivery. A value of true specifies that Amazon SES will\n include headers in delivery notifications, and a value of false specifies\n that Amazon SES will not include headers in delivery notifications.
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of\n type Delivery. A value of true specifies that Amazon SES includes\n headers in delivery notifications, and a value of false specifies that\n Amazon SES does not include headers in delivery notifications.
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#documentation": "Indicates that the provided Amazon Web Services 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 } @@ -2987,7 +3135,7 @@ "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#documentation": "Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid,\n or that Amazon SES could not publish to the bucket, possibly due to permissions issues.\n For information about giving permissions, see the Amazon SES\n Developer Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3076,24 +3224,26 @@ "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:
\nWhen the tracking domain you specified is not verified in Amazon SES.
\nWhen the tracking domain you specified is not a valid domain or\n subdomain.
\nIndicates 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:
\nWhen the tracking domain you specified is not verified in Amazon SES.
\nWhen the tracking domain you specified is not a valid domain or\n subdomain.
\nContains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event\n destination.
\nEvent destinations, such as Amazon Kinesis Firehose, are associated with configuration sets, which enable\n you to publish email sending events. For information about using configuration sets, see\n the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event\n destination.
\nEvent destinations, such as Amazon Kinesis Firehose, are associated with configuration sets, which enable\n you to publish email sending events. For information about using configuration sets, see\n the Amazon SES\n Developer Guide.
" } }, "com.amazonaws.ses#LambdaAction": { @@ -3124,25 +3274,25 @@ "TopicArn": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is\n taken. An example of an Amazon SNS topic ARN is\n arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about\n Amazon SNS topics, see the Amazon SNS Developer Guide.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is\n executed. You can find the ARN of a topic by using the ListTopics operation in\n Amazon SNS.
\nFor more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
" } }, "FunctionArn": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda\n function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction.\n For more information about AWS Lambda, see the AWS Lambda Developer Guide.
The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function. An example of an Amazon Web Services Lambda\n function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction.\n For more information about Amazon Web Services Lambda, see the Amazon Web Services Lambda Developer Guide.
The invocation type of the AWS Lambda function. An invocation type of\n RequestResponse means that the execution of the function will\n immediately result in a response, and a value of Event means that the\n function will be invoked asynchronously. The default value is Event. For\n information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.
There is a 30-second timeout on RequestResponse invocations. You\n should use Event invocation in most cases. Use\n RequestResponse only when you want to make a mail flow decision,\n such as whether to stop the receipt rule or the receipt rule set.
The invocation type of the Amazon Web Services Lambda function. An invocation type of\n RequestResponse means that the execution of the function immediately\n results in a response, and a value of Event means that the function is\n invoked asynchronously. The default value is Event. For information about\n Amazon Web Services Lambda invocation types, see the Amazon Web Services Lambda Developer Guide.
There is a 30-second timeout on RequestResponse invocations. You\n should use Event invocation in most cases. Use\n RequestResponse only to make a mail flow decision, such as whether\n to stop the receipt rule or the receipt rule set.
When included in a receipt rule, this action calls an AWS Lambda function and,\n optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
\nTo enable Amazon SES to call your AWS Lambda function or to publish to an Amazon SNS topic of\n another account, Amazon SES must have permission to access those resources. For information\n about giving permissions, see the Amazon SES Developer\n Guide.
\nFor information about using AWS Lambda actions in receipt rules, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "When included in a receipt rule, this action calls an Amazon Web Services Lambda function and,\n optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
\nTo enable Amazon SES to call your Amazon Web Services Lambda function or to publish to an Amazon SNS topic of\n another account, Amazon SES must have permission to access those resources. For information\n about giving permissions, see the Amazon SES Developer\n Guide.
\nFor information about using Amazon Web Services Lambda actions in receipt rules, see the Amazon SES\n Developer Guide.
" } }, "com.amazonaws.ses#LastAttemptDate": { @@ -3177,7 +3327,7 @@ "target": "com.amazonaws.ses#ListConfigurationSetsResponse" }, "traits": { - "smithy.api#documentation": "Provides a list of the configuration sets associated with your Amazon SES account in the\n current AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer\n Guide.\n
\nYou can execute this operation no more than once per second. This operation will\n return up to 1,000 configuration sets each time it is run. If your Amazon SES account has\n more than 1,000 configuration sets, this operation will also return a NextToken element.\n You can then execute the ListConfigurationSets operation again, passing the\n NextToken parameter and the value of the NextToken element to retrieve\n additional results.
Provides a list of the configuration sets associated with your Amazon SES account in the\n current Amazon Web Services Region. For information about using configuration sets, see Monitoring\n Your Amazon SES Sending Activity in the Amazon SES Developer\n Guide.\n
\nYou can execute this operation no more than once per second. This operation returns up\n to 1,000 configuration sets each time it is run. If your Amazon SES account has more than\n 1,000 configuration sets, this operation also returns NextToken. You can\n then execute the ListConfigurationSets operation again, passing the\n NextToken parameter and the value of the NextToken element to retrieve\n additional results.
Represents a request to list the configuration sets associated with your AWS account.\n Configuration sets enable you to publish email sending events. For information about\n using configuration sets, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to list the configuration sets associated with your\n Amazon Web Services account. Configuration sets enable you to publish email sending events. For\n information about using configuration sets, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#ListConfigurationSetsResponse": { @@ -3217,7 +3368,8 @@ } }, "traits": { - "smithy.api#documentation": "A list of configuration sets associated with your AWS account. Configuration sets\n enable you to publish email sending events. For information about using configuration\n sets, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "A list of configuration sets associated with your Amazon Web Services account. Configuration sets\n enable you to publish email sending events. For information about using configuration\n sets, see the Amazon SES Developer\n Guide.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#ListCustomVerificationEmailTemplates": { @@ -3229,7 +3381,7 @@ "target": "com.amazonaws.ses#ListCustomVerificationEmailTemplatesResponse" }, "traits": { - "smithy.api#documentation": "Lists the existing custom verification email templates for your account in the current\n AWS Region.
\nFor more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
", + "smithy.api#documentation": "Lists the existing custom verification email templates for your account in the current\n Amazon Web Services Region.
\nFor more information about custom verification email templates, see Using\n Custom Verification Email Templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3249,12 +3401,13 @@ "MaxResults": { "target": "com.amazonaws.ses#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of custom verification email templates to return. This value must\n be at least 1 and less than or equal to 50. If you do not specify a value, or if you\n specify a value less than 1 or greater than 50, the operation will return up to 50\n results.
" + "smithy.api#documentation": "The maximum number of custom verification email templates to return. This value must\n be at least 1 and less than or equal to 50. If you do not specify a value, or if you\n specify a value less than 1 or greater than 50, the operation returns up to 50\n results.
" } } }, "traits": { - "smithy.api#documentation": "Represents a request to list the existing custom verification email templates for your\n account.
\nFor more information about custom verification email templates, see Using Custom\n Verification Email Templates in the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to list the existing custom verification email templates for your\n account.
\nFor more information about custom verification email templates, see Using\n Custom Verification Email Templates in the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#ListCustomVerificationEmailTemplatesResponse": { @@ -3274,7 +3427,8 @@ } }, "traits": { - "smithy.api#documentation": "A paginated list of custom verification email templates.
" + "smithy.api#documentation": "A paginated list of custom verification email templates.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#ListIdentities": { @@ -3286,7 +3440,7 @@ "target": "com.amazonaws.ses#ListIdentitiesResponse" }, "traits": { - "smithy.api#documentation": "Returns a list containing all of the identities (email addresses and domains) for your\n AWS account in the current AWS Region, regardless of verification status.
\nYou can execute this operation no more than once per second.
", + "smithy.api#documentation": "Returns a list containing all of the identities (email addresses and domains) for your\n Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status.
\nYou can execute this operation no more than once per second.
\nIt's recommended that for successive pagination calls of this API, you continue to\n the use the same parameter/value pairs as used in the original call, e.g., if you\n used IdentityType=Domain in the the original call and received a\n NextToken in the response, you should continue providing the\n IdentityType=Domain parameter for further NextToken\n calls; however, if you didn't provide the IdentityType parameter in the\n original call, then continue to not provide it for successive pagination calls.\n Using this protocol will ensure consistent results.
The type of the identities to list. Possible values are \"EmailAddress\" and \"Domain\".\n If this parameter is omitted, then all identities will be listed.
" + "smithy.api#documentation": "The type of the identities to list. Possible values are \"EmailAddress\" and \"Domain\".\n If this parameter is omitted, then all identities are listed.
" } }, "NextToken": { @@ -3318,7 +3472,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to return a list of all identities (email addresses and domains)\n that you have attempted to verify under your AWS account, regardless of verification\n status.
" + "smithy.api#documentation": "Represents a request to return a list of all identities (email addresses and domains)\n that you have attempted to verify under your Amazon Web Services account, regardless of verification\n status.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#ListIdentitiesResponse": { @@ -3339,7 +3494,8 @@ } }, "traits": { - "smithy.api#documentation": "A list of all identities that you have attempted to verify under your AWS account,\n regardless of verification status.
" + "smithy.api#documentation": "A list of all identities that you have attempted to verify under your Amazon Web Services account,\n regardless of verification status.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#ListIdentityPolicies": { @@ -3351,7 +3507,7 @@ "target": "com.amazonaws.ses#ListIdentityPoliciesResponse" }, "traits": { - "smithy.api#documentation": "Returns a list of sending authorization policies that are attached to the given\n identity (an email address or a domain). This API returns only a list. If you want the\n actual policy content, you can use GetIdentityPolicies.
This API is for the identity owner only. If you have not verified the identity,\n this API will return an error.
\nSending authorization is a feature that enables an identity owner to authorize other\n senders to use its identities. For information about using sending authorization, see\n the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Returns a list of sending authorization policies that are attached to the given\n identity (an email address or a domain). This operation returns only a list. To get the\n actual policy content, use GetIdentityPolicies.
This operation is for the identity owner only. If you have not verified the\n identity, it returns an error.
\nSending authorization is a feature that enables an identity owner to authorize other\n senders to use its identities. For information about using sending authorization, see\n the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#ListIdentityPoliciesRequest": { @@ -3360,13 +3516,14 @@ "Identity": { "target": "com.amazonaws.ses#Identity", "traits": { - "smithy.api#documentation": "The identity that is associated with the policy for which the policies will be listed.\n You can specify an identity by using its name or by using its Amazon Resource Name\n (ARN). Examples: user@example.com, example.com,\n arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this API, you must own the identity.
", + "smithy.api#documentation": "The identity that is associated with the policy for which the policies are listed. You\n can specify an identity by using its name or by using its Amazon Resource Name (ARN).\n Examples: user@example.com, example.com,\n arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this operation, you must own the identity.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents a request to return a list of sending authorization policies that are\n attached to an identity. Sending authorization is an Amazon SES feature that enables you to\n authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
" + "smithy.api#documentation": "Represents a request to return a list of sending authorization policies that are\n attached to an identity. Sending authorization is an Amazon SES feature that enables you to\n authorize other senders to use your identities. For information, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#ListIdentityPoliciesResponse": { @@ -3381,7 +3538,8 @@ } }, "traits": { - "smithy.api#documentation": "A list of names of sending authorization policies that apply to an identity.
" + "smithy.api#documentation": "A list of names of sending authorization policies that apply to an identity.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#ListReceiptFilters": { @@ -3393,14 +3551,15 @@ "target": "com.amazonaws.ses#ListReceiptFiltersResponse" }, "traits": { - "smithy.api#documentation": "Lists the IP address filters associated with your AWS account in the current AWS\n Region.
\nFor information about managing IP address filters, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Lists the IP address filters associated with your Amazon Web Services account in the current\n Amazon Web Services Region.
\nFor information about managing IP address filters, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#ListReceiptFiltersRequest": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Represents a request to list the IP address filters that exist under your AWS account.\n You use IP address filters when you receive email with Amazon SES. For more information, see\n the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to list the IP address filters that exist under your\n Amazon Web Services account. You use IP address filters when you receive email with Amazon SES. For more\n information, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#ListReceiptFiltersResponse": { @@ -3414,7 +3573,8 @@ } }, "traits": { - "smithy.api#documentation": "A list of IP address filters that exist under your AWS account.
" + "smithy.api#documentation": "A list of IP address filters that exist under your Amazon Web Services account.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#ListReceiptRuleSets": { @@ -3426,7 +3586,7 @@ "target": "com.amazonaws.ses#ListReceiptRuleSetsResponse" }, "traits": { - "smithy.api#documentation": "Lists the receipt rule sets that exist under your AWS account in the current AWS\n Region. If there are additional receipt rule sets to be retrieved, you will receive a\n NextToken that you can provide to the next call to\n ListReceiptRuleSets to retrieve the additional entries.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Lists the receipt rule sets that exist under your Amazon Web Services account in the current\n Amazon Web Services Region. If there are additional receipt rule sets to be retrieved, you receive a\n NextToken that you can provide to the next call to\n ListReceiptRuleSets to retrieve the additional entries.
For information about managing receipt rule sets, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#ListReceiptRuleSetsRequest": { @@ -3440,7 +3600,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to list the receipt rule sets that exist under your AWS account.\n You use receipt rule sets to receive email with Amazon SES. For more information, see the\n Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to list the receipt rule sets that exist under your\n Amazon Web Services account. You use receipt rule sets to receive email with Amazon SES. For more\n information, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#ListReceiptRuleSetsResponse": { @@ -3460,7 +3621,8 @@ } }, "traits": { - "smithy.api#documentation": "A list of receipt rule sets that exist under your AWS account.
" + "smithy.api#documentation": "A list of receipt rule sets that exist under your Amazon Web Services account.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#ListTemplates": { @@ -3472,7 +3634,7 @@ "target": "com.amazonaws.ses#ListTemplatesResponse" }, "traits": { - "smithy.api#documentation": "Lists the email templates present in your Amazon SES account in the current AWS\n Region.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Lists the email templates present in your Amazon SES account in the current\n Amazon Web Services Region.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#ListTemplatesRequest": { @@ -3487,9 +3649,12 @@ "MaxItems": { "target": "com.amazonaws.ses#MaxItems", "traits": { - "smithy.api#documentation": "The maximum number of templates to return. This value must be at least 1 and less than\n or equal to 10. If you do not specify a value, or if you specify a value less than 1 or\n greater than 10, the operation will return up to 10 results.
" + "smithy.api#documentation": "The maximum number of templates to return. This value must be at least 1 and less than\n or equal to 100. If more than 100 items are requested, the page size will automatically\n set to 100. If you do not specify a value, 10 is the default page size.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.ses#ListTemplatesResponse": { @@ -3504,9 +3669,12 @@ "NextToken": { "target": "com.amazonaws.ses#NextToken", "traits": { - "smithy.api#documentation": "A token indicating that there are additional email templates available to be listed.\n Pass this token to a subsequent call to ListTemplates to retrieve the next\n 50 email templates.
A token indicating that there are additional email templates available to be listed.\n Pass this token to a subsequent call to ListTemplates to retrieve the next\n set of email templates within your page size.
A list of email addresses that you have verified with Amazon SES under your AWS\n account.
" + "smithy.api#documentation": "A list of email addresses that you have verified with Amazon SES under your\n Amazon Web Services account.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#MailFromDomainAttributes": { @@ -3594,7 +3763,7 @@ "Subject": { "target": "com.amazonaws.ses#Content", "traits": { - "smithy.api#documentation": "The subject of the message: A short summary of the content, which will appear in the\n recipient's inbox.
", + "smithy.api#documentation": "The subject of the message: A short summary of the content, which appears in the\n recipient's inbox.
", "smithy.api#required": {} } }, @@ -3637,7 +3806,7 @@ } }, "traits": { - "smithy.api#documentation": "Message-related information to include in the Delivery Status Notification (DSN) when\n an email that Amazon SES receives on your behalf bounces.
\nFor information about receiving email through Amazon SES, see the Amazon SES\n Developer Guide.
" + "smithy.api#documentation": "Message-related information to include in the Delivery Status Notification (DSN) when\n an email that Amazon SES receives on your behalf bounces.
\nFor information about receiving email through Amazon SES, see the Amazon SES Developer\n Guide.
" } }, "com.amazonaws.ses#MessageId": { @@ -3666,20 +3835,20 @@ "Name": { "target": "com.amazonaws.ses#MessageTagName", "traits": { - "smithy.api#documentation": "The name of the tag. The name must:
\nThis value can only contain ASCII letters (a-z, A-Z), numbers (0-9),\n underscores (_), or dashes (-).
\nContain less than 256 characters.
\nThe name of the tag. The name must meet the following requirements:
\nContain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or\n dashes (-).
\nContain 256 characters or fewer.
\nThe value of the tag. The value must:
\nThis value can only contain ASCII letters (a-z, A-Z), numbers (0-9),\n underscores (_), or dashes (-).
\nContain less than 256 characters.
\nThe value of the tag. The value must meet the following requirements:
\nContain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or\n dashes (-).
\nContain 256 characters or fewer.
\nContains the name and value of a tag that you can provide to SendEmail or\n SendRawEmail to apply to an email.
Message tags, which you use with configuration sets, enable you to publish email\n sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
" + "smithy.api#documentation": "Contains the name and value of a tag that you can provide to SendEmail or\n SendRawEmail to apply to an email.
Message tags, which you use with configuration sets, enable you to publish email\n sending events. For information about using configuration sets, see the Amazon SES\n Developer Guide.
" } }, "com.amazonaws.ses#MessageTagList": { @@ -3730,22 +3899,26 @@ "type": "string" }, "com.amazonaws.ses#NotificationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Bounce", - "name": "Bounce" - }, - { - "value": "Complaint", - "name": "Complaint" - }, - { - "value": "Delivery", - "name": "Delivery" + "type": "enum", + "members": { + "Bounce": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bounce" + } + }, + "Complaint": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Complaint" } - ] + }, + "Delivery": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Delivery" + } + } } }, "com.amazonaws.ses#Policy": { @@ -3823,7 +3996,7 @@ "ConfigurationSetName": { "target": "com.amazonaws.ses#ConfigurationSetName", "traits": { - "smithy.api#documentation": "The name of the configuration set that you want to specify the delivery options\n for.
", + "smithy.api#documentation": "The name of the configuration set.
", "smithy.api#required": {} } }, @@ -3835,14 +4008,16 @@ } }, "traits": { - "smithy.api#documentation": "A request to modify the delivery options for a configuration set.
" + "smithy.api#documentation": "A request to modify the delivery options for a configuration set.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#PutConfigurationSetDeliveryOptionsResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An HTTP 200 response if the request succeeds, or an error message if the request\n fails.
" + "smithy.api#documentation": "An HTTP 200 response if the request succeeds, or an error message if the request\n fails.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#PutIdentityPolicy": { @@ -3859,7 +4034,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds or updates a sending authorization policy for the specified identity (an email\n address or a domain).
\nThis API is for the identity owner only. If you have not verified the identity,\n this API will return an error.
\nSending authorization is a feature that enables an identity owner to authorize other\n senders to use its identities. For information about using sending authorization, see\n the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Adds or updates a sending authorization policy for the specified identity (an email\n address or a domain).
\nThis operation is for the identity owner only. If you have not verified the\n identity, it returns an error.
\nSending authorization is a feature that enables an identity owner to authorize other\n senders to use its identities. For information about using sending authorization, see\n the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#PutIdentityPolicyRequest": { @@ -3868,34 +4043,36 @@ "Identity": { "target": "com.amazonaws.ses#Identity", "traits": { - "smithy.api#documentation": "The identity that the policy will apply to. You can specify an identity by using its\n name or by using its Amazon Resource Name (ARN). Examples:\n user@example.com, example.com,\n arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this API, you must own the identity.
", + "smithy.api#documentation": "The identity to which that the policy applies. You can specify an identity by using\n its name or by using its Amazon Resource Name (ARN). Examples:\n user@example.com, example.com,\n arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this operation, you must own the identity.
", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.ses#PolicyName", "traits": { - "smithy.api#documentation": "The name of the policy.
\nThe policy name cannot exceed 64 characters and can only include alphanumeric\n characters, dashes, and underscores.
", + "smithy.api#documentation": "The name of the policy.
\nThe policy name cannot exceed 64 characters and can only include alphanumeric\n characters, dashes, and underscores.
", "smithy.api#required": {} } }, "Policy": { "target": "com.amazonaws.ses#Policy", "traits": { - "smithy.api#documentation": "The text of the policy in JSON format. The policy cannot exceed 4 KB.
\nFor information about the syntax of sending authorization policies, see the Amazon SES Developer\n Guide.
", + "smithy.api#documentation": "The text of the policy in JSON format. The policy cannot exceed 4 KB.
\nFor information about the syntax of sending authorization policies, see the Amazon SES\n Developer Guide.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents a request to add or update a sending authorization policy for an identity.\n Sending authorization is an Amazon SES feature that enables you to authorize other senders to\n use your identities. For information, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to add or update a sending authorization policy for an identity.\n Sending authorization is an Amazon SES feature that enables you to authorize other senders to\n use your identities. For information, see the Amazon SES Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#PutIdentityPolicyResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#RawMessage": { @@ -3904,7 +4081,7 @@ "Data": { "target": "com.amazonaws.ses#RawMessageData", "traits": { - "smithy.api#documentation": "The raw data of the message. This data needs to base64-encoded if you are accessing\n Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS\n SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must\n ensure that the message format complies with Internet email standards regarding email\n header fields, MIME types, and MIME encoding.
\nThe To:, CC:, and BCC: headers in the raw message can contain a group list.
\nIf you are using SendRawEmail with sending authorization, you can include\n X-headers in the raw message to specify the \"Source,\" \"From,\" and \"Return-Path\"\n addresses. For more information, see the documentation for SendRawEmail.
Do not include these X-headers in the DKIM signature, because they are removed by\n Amazon SES before sending the email.
\nFor more information, go to the Amazon SES Developer\n Guide.
", + "smithy.api#documentation": "The raw data of the message. This data needs to base64-encoded if you are accessing\n Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services\n SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must\n ensure that the message format complies with Internet email standards regarding email\n header fields, MIME types, and MIME encoding.
\nThe To:, CC:, and BCC: headers in the raw message can contain a group list.
\nIf you are using SendRawEmail with sending authorization, you can include\n X-headers in the raw message to specify the \"Source,\" \"From,\" and \"Return-Path\"\n addresses. For more information, see the documentation for SendRawEmail.
Do not include these X-headers in the DKIM signature, because they are removed by\n Amazon SES before sending the email.
\nFor more information, go to the Amazon SES Developer Guide.
", "smithy.api#required": {} } } @@ -3940,7 +4117,7 @@ "LambdaAction": { "target": "com.amazonaws.ses#LambdaAction", "traits": { - "smithy.api#documentation": "Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
" + "smithy.api#documentation": "Calls an Amazon Web Services Lambda function, and optionally, publishes a notification to Amazon SNS.
" } }, "StopAction": { @@ -3963,7 +4140,7 @@ } }, "traits": { - "smithy.api#documentation": "An action that Amazon SES can take when it receives an email on behalf of one or more email\n addresses or domains that you own. An instance of this data type can represent only one\n action.
\nFor information about setting up receipt rules, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "An action that Amazon SES can take when it receives an email on behalf of one or more email\n addresses or domains that you own. An instance of this data type can represent only one\n action.
\nFor information about setting up receipt rules, see the Amazon SES\n Developer Guide.
" } }, "com.amazonaws.ses#ReceiptActionsList": { @@ -3978,7 +4155,7 @@ "Name": { "target": "com.amazonaws.ses#ReceiptFilterName", "traits": { - "smithy.api#documentation": "The name of the IP address filter. The name must:
\nThis value can only contain ASCII letters (a-z, A-Z), numbers (0-9),\n underscores (_), or dashes (-).
\nStart and end with a letter or number.
\nContain less than 64 characters.
\nThe name of the IP address filter. The name must meet the following\n requirements:
\nContain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or\n dashes (-).
\nStart and end with a letter or number.
\nContain 64 characters or fewer.
\nA receipt IP address filter enables you to specify whether to accept or reject mail\n originating from an IP address or range of IP addresses.
\nFor information about setting up IP address filters, see the Amazon SES Developer Guide.
" + "smithy.api#documentation": "A receipt IP address filter enables you to specify whether to accept or reject mail\n originating from an IP address or range of IP addresses.
\nFor information about setting up IP address filters, see the Amazon SES\n Developer Guide.
" } }, "com.amazonaws.ses#ReceiptFilterList": { @@ -4004,18 +4181,20 @@ "type": "string" }, "com.amazonaws.ses#ReceiptFilterPolicy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Block", - "name": "Block" - }, - { - "value": "Allow", - "name": "Allow" + "type": "enum", + "members": { + "Block": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Block" } - ] + }, + "Allow": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Allow" + } + } } }, "com.amazonaws.ses#ReceiptIpFilter": { @@ -4031,13 +4210,13 @@ "Cidr": { "target": "com.amazonaws.ses#Cidr", "traits": { - "smithy.api#documentation": "A single IP address or a range of IP addresses that you want to block or allow,\n specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single\n email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For\n more information about CIDR notation, see RFC 2317.
", + "smithy.api#documentation": "A single IP address or a range of IP addresses to block or allow, specified in\n Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is\n 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information\n about CIDR notation, see RFC\n 2317.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A receipt IP address filter enables you to specify whether to accept or reject mail\n originating from an IP address or range of IP addresses.
\nFor information about setting up IP address filters, see the Amazon SES Developer Guide.
" + "smithy.api#documentation": "A receipt IP address filter enables you to specify whether to accept or reject mail\n originating from an IP address or range of IP addresses.
\nFor information about setting up IP address filters, see the Amazon SES\n Developer Guide.
" } }, "com.amazonaws.ses#ReceiptRule": { @@ -4046,7 +4225,7 @@ "Name": { "target": "com.amazonaws.ses#ReceiptRuleName", "traits": { - "smithy.api#documentation": "The name of the receipt rule. The name must:
\nThis value can only contain ASCII letters (a-z, A-Z), numbers (0-9),\n underscores (_), or dashes (-).
\nStart and end with a letter or number.
\nContain less than 64 characters.
\nThe name of the receipt rule. The name must meet the following requirements:
\nContain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes\n (-), or periods (.).
\nStart and end with a letter or number.
\nContain 64 characters or fewer.
\nSpecifies whether Amazon SES should require that incoming email is delivered over a\n connection encrypted with Transport Layer Security (TLS). If this parameter is set to\n Require, Amazon SES will bounce emails that are not received over TLS. The\n default is Optional.
Specifies whether Amazon SES should require that incoming email is delivered over a\n connection encrypted with Transport Layer Security (TLS). If this parameter is set to\n Require, Amazon SES bounces emails that are not received over TLS. The\n default is Optional.
The recipient domains and email addresses that the receipt rule applies to. If this\n field is not specified, this rule will match all recipients under all verified\n domains.
" + "smithy.api#documentation": "The recipient domains and email addresses that the receipt rule applies to. If this\n field is not specified, this rule matches all recipients on all verified domains.
" } }, "Actions": { @@ -4084,7 +4263,7 @@ } }, "traits": { - "smithy.api#documentation": "Receipt rules enable you to specify which actions Amazon SES should take when it receives\n mail on behalf of one or more email addresses or domains that you own.
\nEach receipt rule defines a set of email addresses or domains that it applies to. If\n the email addresses or domains match at least one recipient address of the message,\n Amazon SES executes all of the receipt rule's actions on the message.
\nFor information about setting up receipt rules, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Receipt rules enable you to specify which actions Amazon SES should take when it receives\n mail on behalf of one or more email addresses or domains that you own.
\nEach receipt rule defines a set of email addresses or domains that it applies to. If\n the email addresses or domains match at least one recipient address of the message,\n Amazon SES executes all of the receipt rule's actions on the message.
\nFor information about setting up receipt rules, see the Amazon SES\n Developer Guide.
" } }, "com.amazonaws.ses#ReceiptRuleName": { @@ -4102,7 +4281,7 @@ "Name": { "target": "com.amazonaws.ses#ReceiptRuleSetName", "traits": { - "smithy.api#documentation": "The name of the receipt rule set. The name must:
\nThis value can only contain ASCII letters (a-z, A-Z), numbers (0-9),\n underscores (_), or dashes (-).
\nStart and end with a letter or number.
\nContain less than 64 characters.
\nThe name of the receipt rule set. The name must meet the following\n requirements:
\nContain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or\n dashes (-).
\nStart and end with a letter or number.
\nContain 64 characters or fewer.
\nInformation about a receipt rule set.
\nA receipt rule set is a collection of rules that specify what Amazon SES should do with\n mail it receives on behalf of your account's verified domains.
\nFor information about setting up receipt rule sets, see the Amazon SES\n Developer Guide.
" + "smithy.api#documentation": "Information about a receipt rule set.
\nA receipt rule set is a collection of rules that specify what Amazon SES should do with\n mail it receives on behalf of your account's verified domains.
\nFor information about setting up receipt rule sets, see the Amazon SES Developer Guide.
" } }, "com.amazonaws.ses#ReceiptRuleSetName": { @@ -4140,7 +4319,7 @@ "FinalRecipient": { "target": "com.amazonaws.ses#Address", "traits": { - "smithy.api#documentation": "The email address that the message was ultimately delivered to. This corresponds to\n the Final-Recipient in the DSN. If not specified,\n FinalRecipient will be set to the Recipient specified in\n the BouncedRecipientInfo structure. Either FinalRecipient or\n the recipient in BouncedRecipientInfo must be a recipient of the original\n bounced message.
Do not prepend the FinalRecipient email address with rfc\n 822;, as described in RFC 3798.
The email address that the message was ultimately delivered to. This corresponds to\n the Final-Recipient in the DSN. If not specified,\n FinalRecipient is set to the Recipient specified in the\n BouncedRecipientInfo structure. Either FinalRecipient or\n the recipient in BouncedRecipientInfo must be a recipient of the original\n bounced message.
Do not prepend the FinalRecipient email address with rfc\n 822;, as described in RFC 3798.
Recipient-related information to include in the Delivery Status Notification (DSN)\n when an email that Amazon SES receives on your behalf bounces.
\nFor information about receiving email through Amazon SES, see the Amazon SES\n Developer Guide.
" + "smithy.api#documentation": "Recipient-related information to include in the Delivery Status Notification (DSN)\n when an email that Amazon SES receives on your behalf bounces.
\nFor information about receiving email through Amazon SES, see the Amazon SES Developer\n Guide.
" } }, "com.amazonaws.ses#RecipientsList": { @@ -4215,7 +4394,7 @@ } ], "traits": { - "smithy.api#documentation": "Reorders the receipt rules within a receipt rule set.
\nAll of the rules in the rule set must be represented in this request. That is,\n this API will return an error if the reorder request doesn't explicitly position all\n of the rules.
\nFor information about managing receipt rule sets, see the Amazon SES Developer Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Reorders the receipt rules within a receipt rule set.
\nAll of the rules in the rule set must be represented in this request. That is, it\n is error if the reorder request doesn't explicitly position all of the rules.
\nFor information about managing receipt rule sets, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#ReorderReceiptRuleSetRequest": { @@ -4231,20 +4410,22 @@ "RuleNames": { "target": "com.amazonaws.ses#ReceiptRuleNamesList", "traits": { - "smithy.api#documentation": "A list of the specified receipt rule set's receipt rules in the order that you want to\n put them.
", + "smithy.api#documentation": "The specified receipt rule set's receipt rules, in order.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents a request to reorder the receipt rules within a receipt rule set. You use\n receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" + "smithy.api#documentation": "Represents a request to reorder the receipt rules within a receipt rule set. You use\n receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES\n Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#ReorderReceiptRuleSetResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#ReportingMta": { @@ -4257,20 +4438,20 @@ "target": "com.amazonaws.ses#Enabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Describes whether email sending is enabled or disabled for the configuration set. If\n the value is true, then Amazon SES will send emails that use the configuration\n set. If the value is false, Amazon SES will not send emails that use the\n configuration set. The default value is true. You can change this setting\n using UpdateConfigurationSetSendingEnabled.
Describes whether email sending is enabled or disabled for the configuration set. If\n the value is true, then Amazon SES sends emails that use the configuration set.\n If the value is false, Amazon SES does not send emails that use the\n configuration set. The default value is true. You can change this setting\n using UpdateConfigurationSetSendingEnabled.
Describes whether or not Amazon SES publishes reputation metrics for the configuration set,\n such as bounce and complaint rates, to Amazon CloudWatch.
\nIf the value is true, reputation metrics are published. If the value is\n false, reputation metrics are not published. The default value is\n false.
Describes whether or not Amazon SES publishes reputation metrics for the configuration set,\n such as bounce and complaint rates, to Amazon CloudWatch.
\nIf the value is true, reputation metrics are published. If the value is\n false, reputation metrics are not published. The default value is\n false.
The date and time at which the reputation metrics for the configuration set were last\n reset. Resetting these metrics is known as a fresh start.
\nWhen you disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled and later re-enable it, the\n reputation metrics for the configuration set (but not for the entire Amazon SES account) are\n reset.
\nIf email sending for the configuration set has never been disabled and later\n re-enabled, the value of this attribute is null.
The date and time at which the reputation metrics for the configuration set were last\n reset. Resetting these metrics is known as a fresh start.
\nWhen you disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled and later re-enable it, the\n reputation metrics for the configuration set (but not for the entire Amazon SES account) are\n reset.
\nIf email sending for the configuration set has never been disabled and later\n re-enabled, the value of this attribute is null.
The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An\n example of an Amazon SNS topic ARN is\n arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about\n Amazon SNS topics, see the Amazon SNS Developer Guide.
The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. You\n can find the ARN of a topic by using the ListTopics operation in\n Amazon SNS.
\nFor more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
" } }, "BucketName": { "target": "com.amazonaws.ses#S3BucketName", "traits": { - "smithy.api#documentation": "The name of the Amazon S3 bucket that incoming email will be saved to.
", + "smithy.api#documentation": "The name of the Amazon S3 bucket for incoming email.
", "smithy.api#required": {} } }, @@ -4352,12 +4533,12 @@ "KmsKeyArn": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "The customer master key that Amazon SES should use to encrypt your emails before saving\n them to the Amazon S3 bucket. You can use the default master key or a custom master key you\n created in AWS KMS as follows:
\nTo use the default master key, provide an ARN in the form of\n arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses.\n For example, if your AWS account ID is 123456789012 and you want to use the\n default master key in the US West (Oregon) region, the ARN of the default master\n key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If\n you use the default master key, you don't need to perform any extra steps to\n give Amazon SES permission to use the key.
To use a custom master key you created in AWS KMS, provide the ARN of the\n master key and ensure that you add a statement to your key's policy to give\n Amazon SES permission to use it. For more information about giving permissions, see\n the Amazon SES\n Developer Guide.
\nFor more information about key policies, see the AWS KMS Developer Guide. If\n you do not specify a master key, Amazon SES will not encrypt your emails.
\nYour mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail\n is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side\n encryption. This means that you must use the Amazon S3 encryption client to decrypt the\n email after retrieving it from Amazon S3, as the service has no access to use your AWS\n KMS keys for decryption. This encryption client is currently available with the\n AWS SDK for Java and AWS SDK for Ruby only. For more\n information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide.
\nThe customer master key that Amazon SES should use to encrypt your emails before saving\n them to the Amazon S3 bucket. You can use the default master key or a custom master key that\n you created in Amazon Web Services KMS as follows:
\nTo use the default master key, provide an ARN in the form of\n arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses.\n For example, if your Amazon Web Services account ID is 123456789012 and you want to use the\n default master key in the US West (Oregon) Region, the ARN of the default master\n key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If\n you use the default master key, you don't need to perform any extra steps to\n give Amazon SES permission to use the key.
To use a custom master key that you created in Amazon Web Services KMS, provide the ARN of\n the master key and ensure that you add a statement to your key's policy to give\n Amazon SES permission to use it. For more information about giving permissions, see\n the Amazon SES Developer\n Guide.
\nFor more information about key policies, see the Amazon Web Services KMS Developer Guide. If\n you do not specify a master key, Amazon SES does not encrypt your emails.
\nYour mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail\n is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side\n encryption. This means that you must use the Amazon S3 encryption client to decrypt the\n email after retrieving it from Amazon S3, as the service has no access to use your\n Amazon Web Services KMS keys for decryption. This encryption client is currently available with\n the Amazon Web Services SDK for Java and\n Amazon Web Services SDK for Ruby only. For\n more information about client-side encryption using Amazon Web Services KMS master keys, see the\n Amazon S3 Developer Guide.
\nWhen included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service\n (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
\nTo enable Amazon SES to write emails to your Amazon S3 bucket, use an AWS KMS key to encrypt\n your emails, or publish to an Amazon SNS topic of another account, Amazon SES must have permission\n to access those resources. For information about giving permissions, see the Amazon SES Developer\n Guide.
\nWhen you save your emails to an Amazon S3 bucket, the maximum email size (including\n headers) is 30 MB. Emails larger than that will bounce.
\nFor information about specifying Amazon S3 actions in receipt rules, see the Amazon SES Developer Guide.
" + "smithy.api#documentation": "When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service\n (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
\nTo enable Amazon SES to write emails to your Amazon S3 bucket, use an Amazon Web Services KMS key to encrypt\n your emails, or publish to an Amazon SNS topic of another account, Amazon SES must have permission\n to access those resources. For information about granting permissions, see the Amazon SES\n Developer Guide.
\nWhen you save your emails to an Amazon S3 bucket, the maximum email size (including\n headers) is 40 MB. Emails larger than that bounces.
\nFor information about specifying Amazon S3 actions in receipt rules, see the Amazon SES\n Developer Guide.
" } }, "com.amazonaws.ses#S3BucketName": { @@ -4372,7 +4553,7 @@ "TopicArn": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS\n topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more\n information about Amazon SNS topics, see the Amazon SNS Developer Guide.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. You can find the ARN of a\n topic by using the ListTopics operation in Amazon SNS.
\nFor more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
", "smithy.api#required": {} } }, @@ -4384,22 +4565,24 @@ } }, "traits": { - "smithy.api#documentation": "When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service\n (Amazon SNS). This action includes a complete copy of the email content in the Amazon SNS\n notifications. Amazon SNS notifications for all other actions simply provide information\n about the email. They do not include the email content itself.
\nIf you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission to\n publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a\n policy to the topic to give Amazon SES permissions to access it. For information about giving\n permissions, see the Amazon SES Developer\n Guide.
\nYou can only publish emails that are 150 KB or less (including the header) to\n Amazon SNS. Larger emails will bounce. If you anticipate emails larger than 150 KB, use\n the S3 action instead.
\nFor information about using a receipt rule to publish an Amazon SNS notification, see the\n Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service\n (Amazon SNS). This action includes a complete copy of the email content in the Amazon SNS\n notifications. Amazon SNS notifications for all other actions simply provide information\n about the email. They do not include the email content itself.
\nIf you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission to\n publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a\n policy to the topic to give Amazon SES permissions to access it. For information about giving\n permissions, see the Amazon SES Developer\n Guide.
\nYou can only publish emails that are 150 KB or less (including the header) to\n Amazon SNS. Larger emails bounce. If you anticipate emails larger than 150 KB, use the S3\n action instead.
\nFor information about using a receipt rule to publish an Amazon SNS notification, see the\n Amazon SES Developer Guide.
" } }, "com.amazonaws.ses#SNSActionEncoding": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UTF-8", - "name": "UTF8" - }, - { - "value": "Base64", - "name": "Base64" + "type": "enum", + "members": { + "UTF8": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UTF-8" } - ] + }, + "Base64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Base64" + } + } } }, "com.amazonaws.ses#SNSDestination": { @@ -4408,13 +4591,13 @@ "TopicARN": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "The ARN of the Amazon SNS topic that email sending events will be published to. An example\n of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For\n more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
The ARN of the Amazon SNS topic for email sending events. You can find the ARN of a topic\n by using the ListTopics Amazon SNS operation.
\nFor more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
\nEvent destinations, such as Amazon SNS, are associated with configuration sets, which\n enable you to publish email sending events. For information about using configuration\n sets, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
\nEvent destinations, such as Amazon SNS, are associated with configuration sets, which\n enable you to publish email sending events. For information about using configuration\n sets, see the Amazon SES Developer\n Guide.
" } }, "com.amazonaws.ses#SendBounce": { @@ -4431,7 +4614,7 @@ } ], "traits": { - "smithy.api#documentation": "Generates and sends a bounce message to the sender of an email you received through\n Amazon SES. You can only use this API on an email up to 24 hours after you receive it.
\nYou cannot use this API to send generic bounces for mail that was not received by\n Amazon SES.
\nFor information about receiving email through Amazon SES, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Generates and sends a bounce message to the sender of an email you received through\n Amazon SES. You can only use this operation on an email up to 24 hours after you receive\n it.
\nYou cannot use this operation to send generic bounces for mail that was not\n received by Amazon SES.
\nFor information about receiving email through Amazon SES, see the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#SendBounceRequest": { @@ -4454,13 +4637,13 @@ "Explanation": { "target": "com.amazonaws.ses#Explanation", "traits": { - "smithy.api#documentation": "Human-readable text for the bounce message to explain the failure. If not specified,\n the text will be auto-generated based on the bounced recipient information.
" + "smithy.api#documentation": "Human-readable text for the bounce message to explain the failure. If not specified,\n the text is auto-generated based on the bounced recipient information.
" } }, "MessageDsn": { "target": "com.amazonaws.ses#MessageDsn", "traits": { - "smithy.api#documentation": "Message-related DSN fields. If not specified, Amazon SES will choose the values.
" + "smithy.api#documentation": "Message-related DSN fields. If not specified, Amazon SES chooses the values.
" } }, "BouncedRecipientInfoList": { @@ -4473,12 +4656,13 @@ "BounceSenderArn": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n address in the \"From\" header of the bounce. For more information about sending\n authorization, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n address in the \"From\" header of the bounce. For more information about sending\n authorization, see the Amazon SES Developer Guide.
" } } }, "traits": { - "smithy.api#documentation": "Represents a request to send a bounce message to the sender of an email you received\n through Amazon SES.
" + "smithy.api#documentation": "Represents a request to send a bounce message to the sender of an email you received\n through Amazon SES.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#SendBounceResponse": { @@ -4492,7 +4676,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a unique message ID.
" + "smithy.api#documentation": "Represents a unique message ID.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#SendBulkTemplatedEmail": { @@ -4524,7 +4709,7 @@ } ], "traits": { - "smithy.api#documentation": "Composes an email message to multiple destinations. The message body is created using\n an email template.
\nIn order to send email using the SendBulkTemplatedEmail operation, your\n call to the API must meet the following requirements:
The call must refer to an existing email template. You can create email\n templates using the CreateTemplate operation.
\nThe message must be sent from a verified email address or domain.
\nIf your account is still in the Amazon SES sandbox, you may only send to verified\n addresses or domains, or to email addresses associated with the Amazon SES Mailbox\n Simulator. For more information, see Verifying\n Email Addresses and Domains in the Amazon SES Developer\n Guide.\n
\nThe maximum message size is 10 MB.
\nEach Destination parameter must include at least one recipient\n email address. The recipient address can be a To: address, a CC: address, or a\n BCC: address. If a recipient email address is invalid (that is, it is not in the\n format UserName@[SubDomain.]Domain.TopLevelDomain), the\n entire message will be rejected, even if the message contains other recipients\n that are valid.
The message may not include more than 50 recipients, across the To:, CC: and\n BCC: fields. If you need to send an email message to a larger audience, you can\n divide your recipient list into groups of 50 or fewer, and then call the\n SendBulkTemplatedEmail operation several times to send the\n message to each group.
The number of destinations you can contact in a single call to the API may be\n limited by your account's maximum sending rate.
\nComposes an email message to multiple destinations. The message body is created using\n an email template.
\nTo send email using this operation, your call must meet the following\n requirements:
\nThe call must refer to an existing email template. You can create email\n templates using CreateTemplate.
\nThe message must be sent from a verified email address or domain.
\nIf your account is still in the Amazon SES sandbox, you may send only to verified\n addresses or domains, or to email addresses associated with the Amazon SES Mailbox\n Simulator. For more information, see Verifying Email\n Addresses and Domains in the Amazon SES Developer\n Guide.\n
\nThe maximum message size is 10 MB.
\nEach Destination parameter must include at least one recipient\n email address. The recipient address can be a To: address, a CC: address, or a\n BCC: address. If a recipient email address is invalid (that is, it is not in the\n format UserName@[SubDomain.]Domain.TopLevelDomain), the\n entire message is rejected, even if the message contains other recipients that\n are valid.
The message may not include more than 50 recipients, across the To:, CC: and\n BCC: fields. If you need to send an email message to a larger audience, you can\n divide your recipient list into groups of 50 or fewer, and then call the\n SendBulkTemplatedEmail operation several times to send the\n message to each group.
The number of destinations you can contact in a single call can be limited by\n your account's maximum sending rate.
\nThe email address that is sending the email. This email address must be either\n individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.\n For information about verifying identities, see the Amazon SES Developer\n Guide.
\nIf you are sending on behalf of another user and have been permitted to do so by a\n sending authorization policy, then you must also specify the SourceArn\n parameter. For more information about sending authorization, see the Amazon SES Developer Guide.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the\n local part of a source email address (the part of the email\n address that precedes the @ sign) may only contain 7-bit ASCII\n characters. If the domain part of an address (the\n part after the @ sign) contains non-ASCII characters, they must be encoded using\n Punycode, as described in RFC3492. The sender name (also known as the friendly\n name) may contain non-ASCII characters. These characters must be\n encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word\n syntax uses the following form:\n =?charset?encoding?encoded-text?=.
The email address that is sending the email. This email address must be either\n individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.\n For information about verifying identities, see the Amazon SES Developer Guide.
\nIf you are sending on behalf of another user and have been permitted to do so by a\n sending authorization policy, then you must also specify the SourceArn\n parameter. For more information about sending authorization, see the Amazon SES Developer\n Guide.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the\n email address string must be 7-bit ASCII. If you want to send to or from email\n addresses that contain Unicode characters in the domain part of an address, you must\n encode the domain using Punycode. Punycode is not permitted in the local part of the\n email address (the part before the @ sign) nor in the \"friendly from\" name. If you\n want to use Unicode characters in the \"friendly from\" name, you must encode the\n \"friendly from\" name using MIME encoded-word syntax, as described in Sending raw email\n using the Amazon SES API. For more information about Punycode, see RFC 3492.
\nThis parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to send for\n the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to send from user@example.com, then you\n would specify the SourceArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n Source to be user@example.com.
For more information about sending authorization, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to send for\n the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to send from user@example.com, then you\n would specify the SourceArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n Source to be user@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
" } }, "ReplyToAddresses": { "target": "com.amazonaws.ses#AddressList", "traits": { - "smithy.api#documentation": "The reply-to email address(es) for the message. If the recipient replies to the\n message, each reply-to address will receive the reply.
" + "smithy.api#documentation": "The reply-to email address(es) for the message. If the recipient replies to the\n message, each reply-to address receives the reply.
" } }, "ReturnPath": { "target": "com.amazonaws.ses#Address", "traits": { - "smithy.api#documentation": "The email address that bounces and complaints will be forwarded to when feedback\n forwarding is enabled. If the message cannot be delivered to the recipient, then an\n error message will be returned from the recipient's ISP; this message will then be\n forwarded to the email address specified by the ReturnPath parameter. The\n ReturnPath parameter is never overwritten. This email address must be\n either individually verified with Amazon SES, or from a domain that has been verified with\n Amazon SES.
The email address that bounces and complaints are forwarded to when feedback\n forwarding is enabled. If the message cannot be delivered to the recipient, then an\n error message is returned from the recipient's ISP; this message is forwarded to the\n email address specified by the ReturnPath parameter. The\n ReturnPath parameter is never overwritten. This email address must be\n either individually verified with Amazon SES, or from a domain that has been verified with\n Amazon SES.
This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to use feedback@example.com, then you\n would specify the ReturnPathArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n ReturnPath to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to use feedback@example.com, then you\n would specify the ReturnPathArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n ReturnPath to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
" } }, "ConfigurationSetName": { @@ -4589,19 +4774,20 @@ "DefaultTemplateData": { "target": "com.amazonaws.ses#TemplateData", "traits": { - "smithy.api#documentation": "A list of replacement values to apply to the template when replacement data is not\n specified in a Destination object. These values act as a default or fallback option when\n no other data is available.
\nThe template data is a JSON object, typically consisting of key-value pairs in which\n the keys correspond to replacement tags in the email template.
" + "smithy.api#documentation": "A list of replacement values to apply to the template when replacement data is not\n specified in a Destination object. These values act as a default or fallback option when\n no other data is available.
\nThe template data is a JSON object, typically consisting of key-value pairs in which\n the keys correspond to replacement tags in the email template.
" } }, "Destinations": { "target": "com.amazonaws.ses#BulkEmailDestinationList", "traits": { - "smithy.api#documentation": "One or more Destination objects. All of the recipients in a\n Destination will receive the same version of the email. You can specify\n up to 50 Destination objects within a Destinations\n array.
One or more Destination objects. All of the recipients in a\n Destination receive the same version of the email. You can specify up\n to 50 Destination objects within a Destinations array.
Represents a request to send a templated email to multiple destinations using Amazon SES.\n For more information, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to send a templated email to multiple destinations using Amazon SES.\n For more information, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#SendBulkTemplatedEmailResponse": { @@ -4610,10 +4796,13 @@ "Status": { "target": "com.amazonaws.ses#BulkEmailDestinationStatusList", "traits": { - "smithy.api#documentation": "The unique message identifier returned from the SendBulkTemplatedEmail\n action.
One object per intended recipient. Check each response object and retry any messages\n with a failure status. (Note that order of responses will be respective to order of\n destinations in the request.)Receipt rules enable you to specify which actions
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ses#SendCustomVerificationEmail": { @@ -4642,7 +4831,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds an email address to the list of identities for your Amazon SES account in the current\n AWS Region and attempts to verify it. As a result of executing this operation, a\n customized verification email is sent to the specified address.
\nTo use this operation, you must first create a custom verification email template. For\n more information about creating and using custom verification email templates, see\n Using Custom\n Verification Email Templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Adds an email address to the list of identities for your Amazon SES account in the current\n Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a\n customized verification email is sent to the specified address.
\nTo use this operation, you must first create a custom verification email template. For\n more information about creating and using custom verification email templates, see\n Using\n Custom Verification Email Templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#SendCustomVerificationEmailRequest": { @@ -4670,7 +4859,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to send a custom verification email to a specified\n recipient.
" + "smithy.api#documentation": "Represents a request to send a custom verification email to a specified\n recipient.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#SendCustomVerificationEmailResponse": { @@ -4684,7 +4874,8 @@ } }, "traits": { - "smithy.api#documentation": "The response received when attempting to send the custom verification email.
" + "smithy.api#documentation": "The response received when attempting to send the custom verification email.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#SendDataPoint": { @@ -4761,7 +4952,7 @@ } ], "traits": { - "smithy.api#documentation": "Composes an email message and immediately queues it for sending. In order to send\n email using the SendEmail operation, your message must meet the following\n requirements:
The message must be sent from a verified email address or domain. If you\n attempt to send email using a non-verified address or domain, the operation will\n result in an \"Email address not verified\" error.
\nIf your account is still in the Amazon SES sandbox, you may only send to verified\n addresses or domains, or to email addresses associated with the Amazon SES Mailbox\n Simulator. For more information, see Verifying\n Email Addresses and Domains in the Amazon SES Developer\n Guide.\n
\nThe maximum message size is 10 MB.
\nThe message must include at least one recipient email address. The recipient\n address can be a To: address, a CC: address, or a BCC: address. If a recipient\n email address is invalid (that is, it is not in the format\n UserName@[SubDomain.]Domain.TopLevelDomain), the entire\n message will be rejected, even if the message contains other recipients that are\n valid.
\nThe message may not include more than 50 recipients, across the To:, CC: and\n BCC: fields. If you need to send an email message to a larger audience, you can\n divide your recipient list into groups of 50 or fewer, and then call the\n SendEmail operation several times to send the message to each\n group.
For every message that you send, the total number of recipients (including each\n recipient in the To:, CC: and BCC: fields) is counted against the maximum number of\n emails you can send in a 24-hour period (your sending quota).\n For more information about sending quotas in Amazon SES, see Managing Your Amazon SES\n Sending Limits in the Amazon SES Developer Guide.\n
\nComposes an email message and immediately queues it for sending. To send email using\n this operation, your message must meet the following requirements:
\nThe message must be sent from a verified email address or domain. If you\n attempt to send email using a non-verified address or domain, the operation\n results in an \"Email address not verified\" error.
\nIf your account is still in the Amazon SES sandbox, you may only send to verified\n addresses or domains, or to email addresses associated with the Amazon SES Mailbox\n Simulator. For more information, see Verifying Email\n Addresses and Domains in the Amazon SES Developer\n Guide.\n
\nThe maximum message size is 10 MB.
\nThe message must include at least one recipient email address. The recipient\n address can be a To: address, a CC: address, or a BCC: address. If a recipient\n email address is invalid (that is, it is not in the format\n UserName@[SubDomain.]Domain.TopLevelDomain), the entire\n message is rejected, even if the message contains other recipients that are\n valid.
\nThe message may not include more than 50 recipients, across the To:, CC: and\n BCC: fields. If you need to send an email message to a larger audience, you can\n divide your recipient list into groups of 50 or fewer, and then call the\n SendEmail operation several times to send the message to each\n group.
For every message that you send, the total number of recipients (including each\n recipient in the To:, CC: and BCC: fields) is counted against the maximum number of\n emails you can send in a 24-hour period (your sending quota).\n For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending\n Limits in the Amazon SES Developer Guide.\n
\nThe email address that is sending the email. This email address must be either\n individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.\n For information about verifying identities, see the Amazon SES Developer\n Guide.
\nIf you are sending on behalf of another user and have been permitted to do so by a\n sending authorization policy, then you must also specify the SourceArn\n parameter. For more information about sending authorization, see the Amazon SES Developer Guide.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the\n local part of a source email address (the part of the email\n address that precedes the @ sign) may only contain 7-bit ASCII\n characters. If the domain part of an address (the\n part after the @ sign) contains non-ASCII characters, they must be encoded using\n Punycode, as described in RFC3492. The sender name (also known as the friendly\n name) may contain non-ASCII characters. These characters must be\n encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word\n syntax uses the following form:\n =?charset?encoding?encoded-text?=.
The email address that is sending the email. This email address must be either\n individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.\n For information about verifying identities, see the Amazon SES Developer Guide.
\nIf you are sending on behalf of another user and have been permitted to do so by a\n sending authorization policy, then you must also specify the SourceArn\n parameter. For more information about sending authorization, see the Amazon SES Developer\n Guide.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the\n email address string must be 7-bit ASCII. If you want to send to or from email\n addresses that contain Unicode characters in the domain part of an address, you must\n encode the domain using Punycode. Punycode is not permitted in the local part of the\n email address (the part before the @ sign) nor in the \"friendly from\" name. If you\n want to use Unicode characters in the \"friendly from\" name, you must encode the\n \"friendly from\" name using MIME encoded-word syntax, as described in Sending raw email\n using the Amazon SES API. For more information about Punycode, see RFC 3492.
\nThe reply-to email address(es) for the message. If the recipient replies to the\n message, each reply-to address will receive the reply.
" + "smithy.api#documentation": "The reply-to email address(es) for the message. If the recipient replies to the\n message, each reply-to address receives the reply.
" } }, "ReturnPath": { "target": "com.amazonaws.ses#Address", "traits": { - "smithy.api#documentation": "The email address that bounces and complaints will be forwarded to when feedback\n forwarding is enabled. If the message cannot be delivered to the recipient, then an\n error message will be returned from the recipient's ISP; this message will then be\n forwarded to the email address specified by the ReturnPath parameter. The\n ReturnPath parameter is never overwritten. This email address must be\n either individually verified with Amazon SES, or from a domain that has been verified with\n Amazon SES.
The email address that bounces and complaints are forwarded to when feedback\n forwarding is enabled. If the message cannot be delivered to the recipient, then an\n error message is returned from the recipient's ISP; this message is forwarded to the\n email address specified by the ReturnPath parameter. The\n ReturnPath parameter is never overwritten. This email address must be\n either individually verified with Amazon SES, or from a domain that has been verified with\n Amazon SES.
This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to send for\n the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to send from user@example.com, then you\n would specify the SourceArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n Source to be user@example.com.
For more information about sending authorization, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to send for\n the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to send from user@example.com, then you\n would specify the SourceArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n Source to be user@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
" } }, "ReturnPathArn": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to use feedback@example.com, then you\n would specify the ReturnPathArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n ReturnPath to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to use feedback@example.com, then you\n would specify the ReturnPathArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n ReturnPath to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
" } }, "Tags": { @@ -4826,7 +5017,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to send a single formatted email using Amazon SES. For more\n information, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to send a single formatted email using Amazon SES. For more\n information, see the Amazon SES Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#SendEmailResponse": { @@ -4841,7 +5033,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a unique message ID.
" + "smithy.api#documentation": "Represents a unique message ID.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#SendRawEmail": { @@ -4870,7 +5063,7 @@ } ], "traits": { - "smithy.api#documentation": "Composes an email message and immediately queues it for sending.
\n\nThis operation is more flexible than the SendEmail API operation. When\n you use the SendRawEmail operation, you can specify the headers of the\n message as well as its content. This flexibility is useful, for example, when you want\n to send a multipart MIME email (such a message that contains both a text and an HTML\n version). You can also use this operation to send messages that include\n attachments.
The SendRawEmail operation has the following requirements:
You can only send email from verified email addresses or domains. If you try\n to send email from an address that isn't verified, the operation results in an\n \"Email address not verified\" error.
\nIf your account is still in the Amazon SES sandbox, you can only send email to other\n verified addresses in your account, or to addresses that are associated with the\n Amazon SES mailbox simulator.
\nThe maximum message size, including attachments, is 10 MB.
\nEach message has to include at least one recipient address. A recipient\n address includes any address on the To:, CC:, or BCC: lines.
\nIf you send a single message to more than one recipient address, and one of\n the recipient addresses isn't in a valid format (that is, it's not in the format\n UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES\n rejects the entire message, even if the other addresses are valid.
\nEach message can include up to 50 recipient addresses across the To:, CC:, or\n BCC: lines. If you need to send a single message to more than 50 recipients, you\n have to split the list of recipient addresses into groups of less than 50\n recipients, and send separate messages to each group.
\nAmazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message\n parts. However, if Amazon SES has to modify the contents of your message (for\n example, if you use open and click tracking), 8-bit content isn't preserved. For\n this reason, we highly recommend that you encode all content that isn't 7-bit\n ASCII. For more information, see MIME Encoding in the Amazon SES Developer\n Guide.
\nAdditionally, keep the following considerations in mind when using the\n SendRawEmail operation:
Although you can customize the message headers when using the\n SendRawEmail operation, Amazon SES will automatically apply its own\n Message-ID and Date headers; if you passed these\n headers when creating the message, they will be overwritten by the values that\n Amazon SES provides.
If you are using sending authorization to send on behalf of another user,\n SendRawEmail enables you to specify the cross-account identity\n for the email's Source, From, and Return-Path parameters in one of two ways: you\n can pass optional parameters SourceArn, FromArn,\n and/or ReturnPathArn to the API, or you can include the following\n X-headers in the header of your raw email:
\n X-SES-SOURCE-ARN\n
\n X-SES-FROM-ARN\n
\n X-SES-RETURN-PATH-ARN\n
Don't include these X-headers in the DKIM signature. Amazon SES removes these\n before it sends the email.
\nIf you only specify the SourceIdentityArn parameter, Amazon SES sets\n the From and Return-Path addresses to the same identity that you\n specified.
For more information about sending authorization, see the Using Sending\n Authorization with Amazon SES in the Amazon SES Developer\n Guide.\n
\nFor every message that you send, the total number of recipients (including\n each recipient in the To:, CC: and BCC: fields) is counted against the maximum\n number of emails you can send in a 24-hour period (your sending\n quota). For more information about sending quotas in Amazon SES, see\n Managing Your\n Amazon SES Sending Limits in the Amazon SES Developer\n Guide.\n
\nComposes an email message and immediately queues it for sending.
\nThis operation is more flexible than the SendEmail operation. When you\n use the SendRawEmail operation, you can specify the headers of the message\n as well as its content. This flexibility is useful, for example, when you need to send a\n multipart MIME email (such a message that contains both a text and an HTML version). You\n can also use this operation to send messages that include attachments.
The SendRawEmail operation has the following requirements:
You can only send email from verified email addresses or domains. If you try to send email from\n an address that isn't verified, the operation results in an \"Email address not\n verified\" error.
\nIf your account is still in the Amazon SES sandbox, you can only send email to other verified addresses\n in your account, or to addresses that are associated with the Amazon SES mailbox simulator.
\nThe maximum message size, including attachments, is 10 MB.
\nEach message has to include at least one recipient address. A recipient\n address includes any address on the To:, CC:, or BCC: lines.
\nIf you send a single message to more than one recipient address, and one of\n the recipient addresses isn't in a valid format (that is, it's not in the format\n UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES\n rejects the entire message, even if the other addresses are valid.
\nEach message can include up to 50 recipient addresses across the To:, CC:, or\n BCC: lines. If you need to send a single message to more than 50 recipients, you\n have to split the list of recipient addresses into groups of less than 50\n recipients, and send separate messages to each group.
\nAmazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message\n parts. However, if Amazon SES has to modify the contents of your message (for\n example, if you use open and click tracking), 8-bit content isn't preserved. For\n this reason, we highly recommend that you encode all content that isn't 7-bit\n ASCII. For more information, see MIME Encoding in the Amazon SES Developer\n Guide.
\nAdditionally, keep the following considerations in mind when using the\n SendRawEmail operation:
Although you can customize the message headers when using the\n SendRawEmail operation, Amazon SES automatically applies its own\n Message-ID and Date headers; if you passed these\n headers when creating the message, they are overwritten by the values that Amazon SES\n provides.
If you are using sending authorization to send on behalf of another user,\n SendRawEmail enables you to specify the cross-account identity\n for the email's Source, From, and Return-Path parameters in one of two ways: you\n can pass optional parameters SourceArn, FromArn,\n and/or ReturnPathArn, or you can include the following X-headers in\n the header of your raw email:
\n X-SES-SOURCE-ARN\n
\n X-SES-FROM-ARN\n
\n X-SES-RETURN-PATH-ARN\n
Don't include these X-headers in the DKIM signature. Amazon SES removes these\n before it sends the email.
\nIf you only specify the SourceIdentityArn parameter, Amazon SES sets\n the From and Return-Path addresses to the same identity that you\n specified.
For more information about sending authorization, see the Using\n Sending Authorization with Amazon SES in the Amazon SES Developer\n Guide.\n
\nFor every message that you send, the total number of recipients (including\n each recipient in the To:, CC: and BCC: fields) is counted against the maximum\n number of emails you can send in a 24-hour period (your sending\n quota). For more information about sending quotas in Amazon SES, see\n Managing Your Amazon SES Sending Limits in the Amazon SES Developer\n Guide.\n
\nThe identity's email address. If you do not provide a value for this parameter, you\n must specify a \"From\" address in the raw text of the message. (You can also specify\n both.)
\nAmazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the\n local part of a source email address (the part of the email\n address that precedes the @ sign) may only contain 7-bit ASCII\n characters. If the domain part of an address (the\n part after the @ sign) contains non-ASCII characters, they must be encoded using\n Punycode, as described in RFC3492. The sender name (also known as the friendly\n name) may contain non-ASCII characters. These characters must be\n encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word\n syntax uses the following form:\n =?charset?encoding?encoded-text?=.
If you specify the Source parameter and have feedback forwarding enabled,\n then bounces and complaints will be sent to this email address. This takes precedence\n over any Return-Path header that you might include in the raw text of the\n message.
The identity's email address. If you do not provide a value for this parameter, you\n must specify a \"From\" address in the raw text of the message. (You can also specify\n both.)
\nAmazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the\n email address string must be 7-bit ASCII. If you want to send to or from email\n addresses that contain Unicode characters in the domain part of an address, you must\n encode the domain using Punycode. Punycode is not permitted in the local part of the\n email address (the part before the @ sign) nor in the \"friendly from\" name. If you\n want to use Unicode characters in the \"friendly from\" name, you must encode the\n \"friendly from\" name using MIME encoded-word syntax, as described in Sending raw email\n using the Amazon SES API. For more information about Punycode, see RFC 3492.
\nIf you specify the Source parameter and have feedback forwarding enabled,\n then bounces and complaints are sent to this email address. This takes precedence over\n any Return-Path header that you might include in the raw text of the message.
The raw email message itself. The message has to meet the following criteria:
\nThe message has to contain a header and a body, separated by a blank\n line.
\nAll of the required header fields must be present in the message.
\nEach part of a multipart MIME message must be formatted properly.
\nAttachments must be of a content type that Amazon SES supports. For a list on\n unsupported content types, see Unsupported Attachment\n Types in the Amazon SES Developer Guide.
\nThe entire message must be base64-encoded.
\nIf any of the MIME parts in your message contain content that is outside of\n the 7-bit ASCII character range, we highly recommend that you encode that\n content. For more information, see Sending Raw Email in the Amazon SES Developer\n Guide.
\nPer RFC\n 5321, the maximum length of each line of text, including the\n
The raw email message itself. The message has to meet the following criteria:
\nThe message has to contain a header and a body, separated by a blank\n line.
\nAll of the required header fields must be present in the message.
\nEach part of a multipart MIME message must be formatted properly.
\nAttachments must be of a content type that Amazon SES supports. For a list on\n unsupported content types, see Unsupported Attachment Types in\n the Amazon SES Developer Guide.
\nThe entire message must be base64-encoded.
\nIf any of the MIME parts in your message contain content that is outside of\n the 7-bit ASCII character range, we highly recommend that you encode that\n content. For more information, see Sending Raw\n Email in the Amazon SES Developer Guide.
\nPer RFC\n 5321, the maximum length of each line of text, including the\n
This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to specify a\n particular \"From\" address in the header of the raw email.
\nInstead of using this parameter, you can use the X-header X-SES-FROM-ARN\n in the raw message of the email. If you use both the FromArn parameter and\n the corresponding X-header, Amazon SES uses the value of the FromArn\n parameter.
For information about when to use this parameter, see the description of\n SendRawEmail in this guide, or see the Amazon SES Developer Guide.
This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to specify a\n particular \"From\" address in the header of the raw email.
\nInstead of using this parameter, you can use the X-header X-SES-FROM-ARN\n in the raw message of the email. If you use both the FromArn parameter and\n the corresponding X-header, Amazon SES uses the value of the FromArn\n parameter.
For information about when to use this parameter, see the description of\n SendRawEmail in this guide, or see the Amazon SES\n Developer Guide.
This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to send for\n the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to send from user@example.com, then you\n would specify the SourceArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n Source to be user@example.com.
Instead of using this parameter, you can use the X-header\n X-SES-SOURCE-ARN in the raw message of the email. If you use both the\n SourceArn parameter and the corresponding X-header, Amazon SES uses the\n value of the SourceArn parameter.
For information about when to use this parameter, see the description of\n SendRawEmail in this guide, or see the Amazon SES Developer Guide.
This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to send for\n the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to send from user@example.com, then you\n would specify the SourceArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n Source to be user@example.com.
Instead of using this parameter, you can use the X-header\n X-SES-SOURCE-ARN in the raw message of the email. If you use both the\n SourceArn parameter and the corresponding X-header, Amazon SES uses the\n value of the SourceArn parameter.
For information about when to use this parameter, see the description of\n SendRawEmail in this guide, or see the Amazon SES\n Developer Guide.
This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to use feedback@example.com, then you\n would specify the ReturnPathArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n ReturnPath to be feedback@example.com.
Instead of using this parameter, you can use the X-header\n X-SES-RETURN-PATH-ARN in the raw message of the email. If you use both\n the ReturnPathArn parameter and the corresponding X-header, Amazon SES uses the\n value of the ReturnPathArn parameter.
For information about when to use this parameter, see the description of\n SendRawEmail in this guide, or see the Amazon SES Developer Guide.
This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to use feedback@example.com, then you\n would specify the ReturnPathArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n ReturnPath to be feedback@example.com.
Instead of using this parameter, you can use the X-header\n X-SES-RETURN-PATH-ARN in the raw message of the email. If you use both\n the ReturnPathArn parameter and the corresponding X-header, Amazon SES uses the\n value of the ReturnPathArn parameter.
For information about when to use this parameter, see the description of\n SendRawEmail in this guide, or see the Amazon SES\n Developer Guide.
Represents a request to send a single raw email using Amazon SES. For more information, see\n the Amazon SES Developer Guide.
" + "smithy.api#documentation": "Represents a request to send a single raw email using Amazon SES. For more information, see\n the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#SendRawEmailResponse": { @@ -4942,7 +5136,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a unique message ID.
" + "smithy.api#documentation": "Represents a unique message ID.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#SendTemplatedEmail": { @@ -4974,7 +5169,7 @@ } ], "traits": { - "smithy.api#documentation": "Composes an email message using an email template and immediately queues it for\n sending.
\nIn order to send email using the SendTemplatedEmail operation, your call\n to the API must meet the following requirements:
The call must refer to an existing email template. You can create email\n templates using the CreateTemplate operation.
\nThe message must be sent from a verified email address or domain.
\nIf your account is still in the Amazon SES sandbox, you may only send to verified\n addresses or domains, or to email addresses associated with the Amazon SES Mailbox\n Simulator. For more information, see Verifying\n Email Addresses and Domains in the Amazon SES Developer\n Guide.\n
\nThe maximum message size is 10 MB.
\nCalls to the SendTemplatedEmail operation may only include one\n Destination parameter. A destination is a set of recipients who\n will receive the same version of the email. The Destination\n parameter can include up to 50 recipients, across the To:, CC: and BCC:\n fields.
The Destination parameter must include at least one recipient\n email address. The recipient address can be a To: address, a CC: address, or a\n BCC: address. If a recipient email address is invalid (that is, it is not in the\n format UserName@[SubDomain.]Domain.TopLevelDomain), the\n entire message will be rejected, even if the message contains other recipients\n that are valid.
If your call to the SendTemplatedEmail operation includes all of the\n required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES\n can't render the email because the template contains errors, it doesn't send the\n email. Additionally, because it already accepted the message, Amazon SES doesn't return a\n message stating that it was unable to send the email.
For these reasons, we highly recommend that you set up Amazon SES to send you\n notifications when Rendering Failure events occur. For more information, see Sending\n Personalized Email Using the Amazon SES API in the Amazon Simple Email Service\n Developer Guide.
\nComposes an email message using an email template and immediately queues it for\n sending.
\nTo send email using this operation, your call must meet the following\n requirements:
\nThe call must refer to an existing email template. You can create email\n templates using the CreateTemplate operation.
\nThe message must be sent from a verified email address or domain.
\nIf your account is still in the Amazon SES sandbox, you may only send to verified\n addresses or domains, or to email addresses associated with the Amazon SES Mailbox\n Simulator. For more information, see Verifying Email\n Addresses and Domains in the Amazon SES Developer\n Guide.\n
\nThe maximum message size is 10 MB.
\nCalls to the SendTemplatedEmail operation may only include one\n Destination parameter. A destination is a set of recipients\n that receives the same version of the email. The Destination\n parameter can include up to 50 recipients, across the To:, CC: and BCC:\n fields.
The Destination parameter must include at least one recipient\n email address. The recipient address can be a To: address, a CC: address, or a\n BCC: address. If a recipient email address is invalid (that is, it is not in the\n format UserName@[SubDomain.]Domain.TopLevelDomain), the\n entire message is rejected, even if the message contains other recipients that\n are valid.
If your call to the SendTemplatedEmail operation includes all of the\n required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES\n can't render the email because the template contains errors, it doesn't send the\n email. Additionally, because it already accepted the message, Amazon SES doesn't return a\n message stating that it was unable to send the email.
For these reasons, we highly recommend that you set up Amazon SES to send you\n notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the\n Amazon Simple Email Service Developer Guide.
\nThe email address that is sending the email. This email address must be either\n individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.\n For information about verifying identities, see the Amazon SES Developer\n Guide.
\nIf you are sending on behalf of another user and have been permitted to do so by a\n sending authorization policy, then you must also specify the SourceArn\n parameter. For more information about sending authorization, see the Amazon SES Developer Guide.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the\n local part of a source email address (the part of the email\n address that precedes the @ sign) may only contain 7-bit ASCII\n characters. If the domain part of an address (the\n part after the @ sign) contains non-ASCII characters, they must be encoded using\n Punycode, as described in RFC3492. The sender name (also known as the friendly\n name) may contain non-ASCII characters. These characters must be\n encoded using MIME encoded-word syntax, as described inRFC 2047. MIME encoded-word\n syntax uses the following form:\n =?charset?encoding?encoded-text?=.
The email address that is sending the email. This email address must be either\n individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.\n For information about verifying identities, see the Amazon SES Developer Guide.
\nIf you are sending on behalf of another user and have been permitted to do so by a\n sending authorization policy, then you must also specify the SourceArn\n parameter. For more information about sending authorization, see the Amazon SES Developer\n Guide.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. for this reason, The\n email address string must be 7-bit ASCII. If you want to send to or from email\n addresses that contain Unicode characters in the domain part of an address, you must\n encode the domain using Punycode. Punycode is not permitted in the local part of the\n email address (the part before the @ sign) nor in the \"friendly from\" name. If you\n want to use Unicode characters in the \"friendly from\" name, you must encode the\n \"friendly from\" name using MIME encoded-word syntax, as described in Sending raw email\n using the Amazon SES API. For more information about Punycode, see RFC 3492.
\nThe reply-to email address(es) for the message. If the recipient replies to the\n message, each reply-to address will receive the reply.
" + "smithy.api#documentation": "The reply-to email address(es) for the message. If the recipient replies to the\n message, each reply-to address receives the reply.
" } }, "ReturnPath": { "target": "com.amazonaws.ses#Address", "traits": { - "smithy.api#documentation": "The email address that bounces and complaints will be forwarded to when feedback\n forwarding is enabled. If the message cannot be delivered to the recipient, then an\n error message will be returned from the recipient's ISP; this message will then be\n forwarded to the email address specified by the ReturnPath parameter. The\n ReturnPath parameter is never overwritten. This email address must be\n either individually verified with Amazon SES, or from a domain that has been verified with\n Amazon SES.
The email address that bounces and complaints are forwarded to when feedback\n forwarding is enabled. If the message cannot be delivered to the recipient, then an\n error message is returned from the recipient's ISP; this message is forwarded to the\n email address specified by the ReturnPath parameter. The\n ReturnPath parameter is never overwritten. This email address must be\n either individually verified with Amazon SES, or from a domain that has been verified with\n Amazon SES.
This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to send for\n the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to send from user@example.com, then you\n would specify the SourceArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n Source to be user@example.com.
For more information about sending authorization, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to send for\n the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to send from user@example.com, then you\n would specify the SourceArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n Source to be user@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
" } }, "ReturnPathArn": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to use feedback@example.com, then you\n would specify the ReturnPathArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n ReturnPath to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "This parameter is used only for sending authorization. It is the ARN of the identity\n that is associated with the sending authorization policy that permits you to use the\n email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN\n arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a\n policy to it that authorizes you to use feedback@example.com, then you\n would specify the ReturnPathArn to be\n arn:aws:ses:us-east-1:123456789012:identity/example.com, and the\n ReturnPath to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
" } }, "Tags": { @@ -5052,7 +5247,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to send a templated email using Amazon SES. For more information, see\n the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to send a templated email using Amazon SES. For more information, see\n the Amazon SES Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#SendTemplatedEmailResponse": { @@ -5065,6 +5261,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ses#SentLast24Hours": { @@ -5087,7 +5286,7 @@ } ], "traits": { - "smithy.api#documentation": "Sets the specified receipt rule set as the active receipt rule set.
\nTo disable your email-receiving through Amazon SES completely, you can call this API\n with RuleSetName set to null.
\nFor information about managing receipt rule sets, see the Amazon SES Developer Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Sets the specified receipt rule set as the active receipt rule set.
\nTo disable your email-receiving through Amazon SES completely, you can call this\n operation with RuleSetName set to null.
For information about managing receipt rule sets, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#SetActiveReceiptRuleSetRequest": { @@ -5101,14 +5300,16 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to set a receipt rule set as the active receipt rule set. You use\n receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" + "smithy.api#documentation": "Represents a request to set a receipt rule set as the active receipt rule set. You use\n receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES\n Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#SetActiveReceiptRuleSetResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#SetIdentityDkimEnabled": { @@ -5120,7 +5321,7 @@ "target": "com.amazonaws.ses#SetIdentityDkimEnabledResponse" }, "traits": { - "smithy.api#documentation": "Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM\n signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends\n from addresses on that domain. If Easy DKIM signing is enabled for an email address,\n then Amazon SES uses DKIM to sign all email it sends from that address.
\nFor email addresses (for example, user@example.com), you can only\n enable DKIM signing if the corresponding domain (in this case,\n example.com) has been set up to use Easy DKIM.
You can enable DKIM signing for an identity at any time after you start the\n verification process for the identity, even if the verification process isn't complete.
\nYou can execute this operation no more than once per second.
\nFor more information about Easy DKIM signing, go to the Amazon SES Developer Guide.
" + "smithy.api#documentation": "Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM\n signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends\n from addresses on that domain. If Easy DKIM signing is enabled for an email address,\n then Amazon SES uses DKIM to sign all email it sends from that address.
\nFor email addresses (for example, user@example.com), you can only\n enable DKIM signing if the corresponding domain (in this case,\n example.com) has been set up to use Easy DKIM.
You can enable DKIM signing for an identity at any time after you start the\n verification process for the identity, even if the verification process isn't complete.
\nYou can execute this operation no more than once per second.
\nFor more information about Easy DKIM signing, go to the Amazon SES Developer\n Guide.
" } }, "com.amazonaws.ses#SetIdentityDkimEnabledRequest": { @@ -5143,14 +5344,16 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to enable or disable Amazon SES Easy DKIM signing for an identity. For\n more information about setting up Easy DKIM, see the Amazon SES Developer Guide.
" + "smithy.api#documentation": "Represents a request to enable or disable Amazon SES Easy DKIM signing for an identity. For\n more information about setting up Easy DKIM, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#SetIdentityDkimEnabledResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#SetIdentityFeedbackForwardingEnabled": { @@ -5162,7 +5365,7 @@ "target": "com.amazonaws.ses#SetIdentityFeedbackForwardingEnabledResponse" }, "traits": { - "smithy.api#documentation": "Given an identity (an email address or a domain), enables or disables whether Amazon SES\n forwards bounce and complaint notifications as email. Feedback forwarding can only be\n disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and\n complaints.
\nFeedback forwarding does not apply to delivery notifications. Delivery\n notifications are only available through Amazon SNS.
\nYou can execute this operation no more than once per second.
\nFor more information about using notifications with Amazon SES, see the Amazon SES\n Developer Guide.
" + "smithy.api#documentation": "Given an identity (an email address or a domain), enables or disables whether Amazon SES\n forwards bounce and complaint notifications as email. Feedback forwarding can only be\n disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and\n complaints.
\nFeedback forwarding does not apply to delivery notifications. Delivery\n notifications are only available through Amazon SNS.
\nYou can execute this operation no more than once per second.
\nFor more information about using notifications with Amazon SES, see the Amazon SES\n Developer Guide.
" } }, "com.amazonaws.ses#SetIdentityFeedbackForwardingEnabledRequest": { @@ -5179,20 +5382,22 @@ "target": "com.amazonaws.ses#Enabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Sets whether Amazon SES will forward bounce and complaint notifications as email.\n true specifies that Amazon SES will forward bounce and complaint\n notifications as email, in addition to any Amazon SNS topic publishing otherwise specified.\n false specifies that Amazon SES will publish bounce and complaint\n notifications only through Amazon SNS. This value can only be set to false when\n Amazon SNS topics are set for both Bounce and Complaint\n notification types.
Sets whether Amazon SES forwards bounce and complaint notifications as email.\n true specifies that Amazon SES forwards bounce and complaint notifications\n as email, in addition to any Amazon SNS topic publishing otherwise specified.\n false specifies that Amazon SES publishes bounce and complaint notifications\n only through Amazon SNS. This value can only be set to false when Amazon SNS topics\n are set for both Bounce and Complaint notification\n types.
Represents a request to enable or disable whether Amazon SES forwards you bounce and\n complaint notifications through email. For information about email feedback forwarding,\n see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to enable or disable whether Amazon SES forwards you bounce and\n complaint notifications through email. For information about email feedback forwarding,\n see the Amazon SES\n Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#SetIdentityFeedbackForwardingEnabledResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#SetIdentityHeadersInNotificationsEnabled": { @@ -5204,7 +5409,7 @@ "target": "com.amazonaws.ses#SetIdentityHeadersInNotificationsEnabledResponse" }, "traits": { - "smithy.api#documentation": "Given an identity (an email address or a domain), sets whether Amazon SES includes the\n original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified\n type.
\nYou can execute this operation no more than once per second.
\nFor more information about using notifications with Amazon SES, see the Amazon SES\n Developer Guide.
" + "smithy.api#documentation": "Given an identity (an email address or a domain), sets whether Amazon SES includes the\n original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified\n type.
\nYou can execute this operation no more than once per second.
\nFor more information about using notifications with Amazon SES, see the Amazon SES\n Developer Guide.
" } }, "com.amazonaws.ses#SetIdentityHeadersInNotificationsEnabledRequest": { @@ -5228,20 +5433,22 @@ "target": "com.amazonaws.ses#Enabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the\n specified notification type. A value of true specifies that Amazon SES will\n include headers in notifications, and a value of false specifies that Amazon SES\n will not include headers in notifications.
This value can only be set when NotificationType is already set to use a\n particular Amazon SNS topic.
Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the\n specified notification type. A value of true specifies that Amazon SES includes\n headers in notifications, and a value of false specifies that Amazon SES does\n not include headers in notifications.
This value can only be set when NotificationType is already set to use a\n particular Amazon SNS topic.
Represents a request to set whether Amazon SES includes the original email headers in the\n Amazon SNS notifications of a specified type. For information about notifications, see the\n Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to set whether Amazon SES includes the original email headers in the\n Amazon SNS notifications of a specified type. For information about notifications, see the\n Amazon SES\n Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#SetIdentityHeadersInNotificationsEnabledResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#SetIdentityMailFromDomain": { @@ -5253,7 +5460,7 @@ "target": "com.amazonaws.ses#SetIdentityMailFromDomainResponse" }, "traits": { - "smithy.api#documentation": "Enables or disables the custom MAIL FROM domain setup for a verified identity (an\n email address or a domain).
\nTo send emails using the specified MAIL FROM domain, you must add an MX record to\n your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy\n Framework (SPF) checks, you must also add or update an SPF record. For more\n information, see the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Enables or disables the custom MAIL FROM domain setup for a verified identity (an\n email address or a domain).
\nTo send emails using the specified MAIL FROM domain, you must add an MX record to\n your MAIL FROM domain's DNS settings. To ensure that your emails pass Sender Policy\n Framework (SPF) checks, you must also add or update an SPF record. For more\n information, see the Amazon SES Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#SetIdentityMailFromDomainRequest": { @@ -5262,32 +5469,34 @@ "Identity": { "target": "com.amazonaws.ses#Identity", "traits": { - "smithy.api#documentation": "The verified identity for which you want to enable or disable the specified custom\n MAIL FROM domain.
", + "smithy.api#documentation": "The verified identity.
", "smithy.api#required": {} } }, "MailFromDomain": { "target": "com.amazonaws.ses#MailFromDomainName", "traits": { - "smithy.api#documentation": "The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM\n domain must 1) be a subdomain of the verified identity, 2) not be used in a \"From\"\n address if the MAIL FROM domain is the destination of email feedback forwarding (for\n more information, see the Amazon SES Developer Guide), and\n 3) not be used to receive emails. A value of null disables the custom MAIL\n FROM setting for the identity.
The custom MAIL FROM domain for the verified identity to use. The MAIL FROM domain\n must 1) be a subdomain of the verified identity, 2) not be used in a \"From\" address if\n the MAIL FROM domain is the destination of email feedback forwarding (for more\n information, see the Amazon SES Developer Guide), and 3) not be used to receive emails. A value of\n null disables the custom MAIL FROM setting for the identity.
The action that you want Amazon SES to take if it cannot successfully read the required MX\n record when you send an email. If you choose UseDefaultValue, Amazon SES will\n use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose\n RejectMessage, Amazon SES will return a\n MailFromDomainNotVerified error and not send the email.
The action specified in BehaviorOnMXFailure is taken when the custom MAIL\n FROM domain setup is in the Pending, Failed, and\n TemporaryFailure states.
The action for Amazon SES to take if it cannot successfully read the required MX record\n when you send an email. If you choose UseDefaultValue, Amazon SES uses\n amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose\n RejectMessage, Amazon SES returns a MailFromDomainNotVerified\n error and not send the email.
The action specified in BehaviorOnMXFailure is taken when the custom MAIL\n FROM domain setup is in the Pending, Failed, and\n TemporaryFailure states.
Represents a request to enable or disable the Amazon SES custom MAIL FROM domain setup for\n a verified identity. For information about using a custom MAIL FROM domain, see the\n Amazon SES\n Developer Guide.
" + "smithy.api#documentation": "Represents a request to enable or disable the Amazon SES custom MAIL FROM domain setup for\n a verified identity. For information about using a custom MAIL FROM domain, see the\n Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#SetIdentityMailFromDomainResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#SetIdentityNotificationTopic": { @@ -5299,7 +5508,7 @@ "target": "com.amazonaws.ses#SetIdentityNotificationTopicResponse" }, "traits": { - "smithy.api#documentation": "Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use\n this operation, you specify a verified identity, such as an email address or domain.\n When you send an email that uses the chosen identity in the Source field, Amazon SES sends\n notifications to the topic you specified. You can send bounce, complaint, or delivery\n notifications (or any combination of the three) to the Amazon SNS topic that you\n specify.
\nYou can execute this operation no more than once per second.
\nFor more information about feedback notification, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use\n this operation, you specify a verified identity, such as an email address or domain.\n When you send an email that uses the chosen identity in the Source field, Amazon SES sends\n notifications to the topic you specified. You can send bounce, complaint, or delivery\n notifications (or any combination of the three) to the Amazon SNS topic that you\n specify.
\nYou can execute this operation no more than once per second.
\nFor more information about feedback notification, see the Amazon SES\n Developer Guide.
" } }, "com.amazonaws.ses#SetIdentityNotificationTopicRequest": { @@ -5308,14 +5517,14 @@ "Identity": { "target": "com.amazonaws.ses#Identity", "traits": { - "smithy.api#documentation": "The identity (email address or domain) that you want to set the Amazon SNS topic\n for.
\nYou can only specify a verified identity for this parameter.
\nYou can specify an identity by using its name or by using its Amazon Resource Name\n (ARN). The following examples are all valid identities: sender@example.com,\n example.com,\n arn:aws:ses:us-east-1:123456789012:identity/example.com.
The identity (email address or domain) for the Amazon SNS topic.
\nYou can only specify a verified identity for this parameter.
\nYou can specify an identity by using its name or by using its Amazon Resource Name\n (ARN). The following examples are all valid identities: sender@example.com,\n example.com,\n arn:aws:ses:us-east-1:123456789012:identity/example.com.
The type of notifications that will be published to the specified Amazon SNS topic.
", + "smithy.api#documentation": "The type of notifications that are published to the specified Amazon SNS topic.
", "smithy.api#required": {} } }, @@ -5327,14 +5536,16 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to specify the Amazon SNS topic to which Amazon SES will publish bounce,\n complaint, or delivery notifications for emails sent with that identity as the Source.\n For information about Amazon SES notifications, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to specify the Amazon SNS topic to which Amazon SES publishes bounce,\n complaint, or delivery notifications for emails sent with that identity as the source.\n For information about Amazon SES notifications, see the Amazon SES\n Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#SetIdentityNotificationTopicResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#SetReceiptRulePosition": { @@ -5354,7 +5565,7 @@ } ], "traits": { - "smithy.api#documentation": "Sets the position of the specified receipt rule in the receipt rule set.
\nFor information about managing receipt rules, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Sets the position of the specified receipt rule in the receipt rule set.
\nFor information about managing receipt rules, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#SetReceiptRulePositionRequest": { @@ -5382,14 +5593,16 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to set the position of a receipt rule in a receipt rule set. You\n use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" + "smithy.api#documentation": "Represents a request to set the position of a receipt rule in a receipt rule set. You\n use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES\n Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#SetReceiptRulePositionResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#SimpleEmailService": { @@ -5622,7 +5835,7 @@ "name": "ses" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version\n 2010-12-01. This document is best used in conjunction with the Amazon SES Developer\n Guide.
\nFor a list of Amazon SES endpoints to use in service requests, see Regions and\n Amazon SES in the Amazon SES Developer\n Guide.
\nThis document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version\n 2010-12-01. This document is best used in conjunction with the Amazon SES Developer\n Guide.
\nFor a list of Amazon SES endpoints to use in service requests, see Regions and\n Amazon SES in the Amazon SES Developer\n Guide.
\nThis documentation contains reference information related to the following:
\n\n Common\n Parameters\n
\n\n Common Errors\n
\nThe Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is\n taken. An example of an Amazon SNS topic ARN is\n arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about\n Amazon SNS topics, see the Amazon SNS Developer Guide.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is\n taken. You can find the ARN of a topic by using the ListTopics Amazon SNS operation.
\nFor more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
" } } }, "traits": { - "smithy.api#documentation": "When included in a receipt rule, this action terminates the evaluation of the receipt\n rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
\nFor information about setting a stop action in a receipt rule, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "When included in a receipt rule, this action terminates the evaluation of the receipt\n rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
\nFor information about setting a stop action in a receipt rule, see the Amazon SES\n Developer Guide.
" } }, "com.amazonaws.ses#StopScope": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RuleSet", - "name": "RULE_SET" + "type": "enum", + "members": { + "RULE_SET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RuleSet" } - ] + } } }, "com.amazonaws.ses#Subject": { @@ -6626,7 +6839,7 @@ "TemplateName": { "target": "com.amazonaws.ses#TemplateName", "traits": { - "smithy.api#documentation": "The name of the template. You will refer to this name when you send email using the\n SendTemplatedEmail or SendBulkTemplatedEmail\n operations.
The name of the template. You use this name when you send email using the\n SendTemplatedEmail or SendBulkTemplatedEmail\n operations.
The email body that will be visible to recipients whose email clients do not display\n HTML.
" + "smithy.api#documentation": "The email body that is visible to recipients whose email clients do not display HTML\n content.
" } }, "HtmlPart": { @@ -6650,7 +6863,7 @@ } }, "traits": { - "smithy.api#documentation": "The content of the email, composed of a subject line, an HTML part, and a text-only\n part.
" + "smithy.api#documentation": "The content of the email, composed of a subject line and either an HTML part or a\n text-only part.
" } }, "com.amazonaws.ses#TemplateContent": { @@ -6734,7 +6947,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a preview of the MIME content of an email when provided with a template and a\n set of replacement data.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Creates a preview of the MIME content of an email when provided with a template and a\n set of replacement data.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#TestRenderTemplateRequest": { @@ -6743,7 +6956,7 @@ "TemplateName": { "target": "com.amazonaws.ses#TemplateName", "traits": { - "smithy.api#documentation": "The name of the template that you want to render.
", + "smithy.api#documentation": "The name of the template to render.
", "smithy.api#required": {} } }, @@ -6754,6 +6967,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.ses#TestRenderTemplateResponse": { @@ -6765,6 +6981,9 @@ "smithy.api#documentation": "The complete MIME message rendered by applying the data in the TemplateData parameter\n to the template specified in the TemplateName parameter.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ses#TextPart": { @@ -6774,18 +6993,20 @@ "type": "timestamp" }, "com.amazonaws.ses#TlsPolicy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Require", - "name": "Require" - }, - { - "value": "Optional", - "name": "Optional" + "type": "enum", + "members": { + "Require": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Require" } - ] + }, + "Optional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Optional" + } + } } }, "com.amazonaws.ses#TrackingOptions": { @@ -6794,12 +7015,12 @@ "CustomRedirectDomain": { "target": "com.amazonaws.ses#CustomRedirectDomain", "traits": { - "smithy.api#documentation": "The custom subdomain that will be used to redirect email recipients to the Amazon SES\n event tracking domain.
" + "smithy.api#documentation": "The custom subdomain that is used to redirect email recipients to the Amazon SES event\n tracking domain.
" } } }, "traits": { - "smithy.api#documentation": "A domain that is used to redirect email recipients to an Amazon SES-operated domain. This\n domain captures open and click events generated by Amazon SES emails.
\nFor more information, see Configuring\n Custom Domains to Handle Open and Click Tracking in the Amazon SES\n Developer Guide.
" + "smithy.api#documentation": "A domain that is used to redirect email recipients to an Amazon SES-operated domain. This\n domain captures open and click events generated by Amazon SES emails.
\nFor more information, see Configuring Custom\n Domains to Handle Open and Click Tracking in the Amazon SES Developer\n Guide.
" } }, "com.amazonaws.ses#TrackingOptionsAlreadyExistsException": { @@ -6857,7 +7078,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Enables or disables email sending across your entire Amazon SES account in the current\n AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to\n temporarily pause email sending across your Amazon SES account in a given AWS Region when\n reputation metrics (such as your bounce or complaint rates) reach certain\n thresholds.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Enables or disables email sending across your entire Amazon SES account in the current\n Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms to\n temporarily pause email sending across your Amazon SES account in a given Amazon Web Services Region when\n reputation metrics (such as your bounce or complaint rates) reach certain\n thresholds.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#UpdateAccountSendingEnabledRequest": { @@ -6867,12 +7088,13 @@ "target": "com.amazonaws.ses#Enabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Describes whether email sending is enabled or disabled for your Amazon SES account in the\n current AWS Region.
" + "smithy.api#documentation": "Describes whether email sending is enabled or disabled for your Amazon SES account in the\n current Amazon Web Services Region.
" } } }, "traits": { - "smithy.api#documentation": "Represents a request to enable or disable the email sending capabilities for your\n entire Amazon SES account.
" + "smithy.api#documentation": "Represents a request to enable or disable the email sending capabilities for your\n entire Amazon SES account.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#UpdateConfigurationSetEventDestination": { @@ -6901,7 +7123,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the event destination of a configuration set. Event destinations are\n associated with configuration sets, which enable you to publish email sending events to\n Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets,\n see Monitoring Your Amazon SES\n Sending Activity in the Amazon SES Developer Guide.\n
\nWhen you create or update an event destination, you must provide one, and only\n one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service\n (Amazon SNS).
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Updates the event destination of a configuration set. Event destinations are\n associated with configuration sets, which enable you to publish email sending events to\n Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets,\n see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer\n Guide.\n
\nWhen you create or update an event destination, you must provide one, and only\n one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service\n (Amazon SNS).
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#UpdateConfigurationSetEventDestinationRequest": { @@ -6910,27 +7132,29 @@ "ConfigurationSetName": { "target": "com.amazonaws.ses#ConfigurationSetName", "traits": { - "smithy.api#documentation": "The name of the configuration set that contains the event destination that you want to\n update.
", + "smithy.api#documentation": "The name of the configuration set that contains the event destination.
", "smithy.api#required": {} } }, "EventDestination": { "target": "com.amazonaws.ses#EventDestination", "traits": { - "smithy.api#documentation": "The event destination object that you want to apply to the specified configuration\n set.
", + "smithy.api#documentation": "The event destination object.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents a request to update the event destination of a configuration set.\n Configuration sets enable you to publish email sending events. For information about\n using configuration sets, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to update the event destination of a configuration set.\n Configuration sets enable you to publish email sending events. For information about\n using configuration sets, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#UpdateConfigurationSetEventDestinationResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#UpdateConfigurationSetReputationMetricsEnabled": { @@ -6947,7 +7171,7 @@ } ], "traits": { - "smithy.api#documentation": "Enables or disables the publishing of reputation metrics for emails sent using a\n specific configuration set in a given AWS Region. Reputation metrics include bounce\n and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can\n create alarms when bounce or complaint rates exceed certain thresholds.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Enables or disables the publishing of reputation metrics for emails sent using a\n specific configuration set in a given Amazon Web Services Region. Reputation metrics include bounce\n and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can\n create alarms when bounce or complaint rates exceed certain thresholds.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#UpdateConfigurationSetReputationMetricsEnabledRequest": { @@ -6956,7 +7180,7 @@ "ConfigurationSetName": { "target": "com.amazonaws.ses#ConfigurationSetName", "traits": { - "smithy.api#documentation": "The name of the configuration set that you want to update.
", + "smithy.api#documentation": "The name of the configuration set to update.
", "smithy.api#required": {} } }, @@ -6964,13 +7188,14 @@ "target": "com.amazonaws.ses#Enabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Describes whether or not Amazon SES will publish reputation metrics for the configuration\n set, such as bounce and complaint rates, to Amazon CloudWatch.
", + "smithy.api#documentation": "Describes whether or not Amazon SES publishes reputation metrics for the configuration set,\n such as bounce and complaint rates, to Amazon CloudWatch.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents a request to modify the reputation metric publishing settings for a\n configuration set.
" + "smithy.api#documentation": "Represents a request to modify the reputation metric publishing settings for a\n configuration set.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#UpdateConfigurationSetSendingEnabled": { @@ -6987,7 +7212,7 @@ } ], "traits": { - "smithy.api#documentation": "Enables or disables email sending for messages sent using a specific configuration set\n in a given AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms\n to temporarily pause email sending for a configuration set when the reputation metrics\n for that configuration set (such as your bounce on complaint rate) exceed certain\n thresholds.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Enables or disables email sending for messages sent using a specific configuration set\n in a given Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms\n to temporarily pause email sending for a configuration set when the reputation metrics\n for that configuration set (such as your bounce on complaint rate) exceed certain\n thresholds.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#UpdateConfigurationSetSendingEnabledRequest": { @@ -6996,7 +7221,7 @@ "ConfigurationSetName": { "target": "com.amazonaws.ses#ConfigurationSetName", "traits": { - "smithy.api#documentation": "The name of the configuration set that you want to update.
", + "smithy.api#documentation": "The name of the configuration set to update.
", "smithy.api#required": {} } }, @@ -7010,7 +7235,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to enable or disable the email sending capabilities for a\n specific configuration set.
" + "smithy.api#documentation": "Represents a request to enable or disable the email sending capabilities for a\n specific configuration set.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#UpdateConfigurationSetTrackingOptions": { @@ -7033,7 +7259,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies an association between a configuration set and a custom domain for open and\n click event tracking.
\nBy default, images and links used for tracking open and click events are hosted on\n domains operated by Amazon SES. You can configure a subdomain of your own to handle these\n events. For information about using custom domains, see the Amazon SES Developer Guide.
" + "smithy.api#documentation": "Modifies an association between a configuration set and a custom domain for open and\n click event tracking.
\nBy default, images and links used for tracking open and click events are hosted on\n domains operated by Amazon SES. You can configure a subdomain of your own to handle these\n events. For information about using custom domains, see the Amazon SES Developer Guide.
" } }, "com.amazonaws.ses#UpdateConfigurationSetTrackingOptionsRequest": { @@ -7042,7 +7268,7 @@ "ConfigurationSetName": { "target": "com.amazonaws.ses#ConfigurationSetName", "traits": { - "smithy.api#documentation": "The name of the configuration set for which you want to update the custom tracking\n domain.
", + "smithy.api#documentation": "The name of the configuration set.
", "smithy.api#required": {} } }, @@ -7054,14 +7280,16 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to update the tracking options for a configuration set.
" + "smithy.api#documentation": "Represents a request to update the tracking options for a configuration set.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#UpdateConfigurationSetTrackingOptionsResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#UpdateCustomVerificationEmailTemplate": { @@ -7084,7 +7312,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an existing custom verification email template.
\nFor more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Updates an existing custom verification email template.
\nFor more information about custom verification email templates, see Using\n Custom Verification Email Templates in the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#UpdateCustomVerificationEmailTemplateRequest": { @@ -7093,7 +7321,7 @@ "TemplateName": { "target": "com.amazonaws.ses#TemplateName", "traits": { - "smithy.api#documentation": "The name of the custom verification email template that you want to update.
", + "smithy.api#documentation": "The name of the custom verification email template to update.
", "smithy.api#required": {} } }, @@ -7112,7 +7340,7 @@ "TemplateContent": { "target": "com.amazonaws.ses#TemplateContent", "traits": { - "smithy.api#documentation": "The content of the custom verification email. The total size of the email must be less\n than 10 MB. The message body may contain HTML, with some limitations. For more\n information, see Custom Verification Email Frequently Asked Questions in the Amazon SES\n Developer Guide.
" + "smithy.api#documentation": "The content of the custom verification email. The total size of the email must be less\n than 10 MB. The message body may contain HTML, with some limitations. For more\n information, see Custom\n Verification Email Frequently Asked Questions in the Amazon SES\n Developer Guide.
" } }, "SuccessRedirectionURL": { @@ -7129,7 +7357,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to update an existing custom verification email template.
" + "smithy.api#documentation": "Represents a request to update an existing custom verification email template.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#UpdateReceiptRule": { @@ -7161,7 +7390,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a receipt rule.
\nFor information about managing receipt rules, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Updates a receipt rule.
\nFor information about managing receipt rules, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#UpdateReceiptRuleRequest": { @@ -7183,14 +7412,16 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to update a receipt rule. You use receipt rules to receive email\n with Amazon SES. For more information, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to update a receipt rule. You use receipt rules to receive email\n with Amazon SES. For more information, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#UpdateReceiptRuleResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#UpdateTemplate": { @@ -7210,7 +7441,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an email template. Email templates enable you to send personalized email to\n one or more destinations in a single API operation. For more information, see the Amazon SES Developer\n Guide.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Updates an email template. Email templates enable you to send personalized email to\n one or more destinations in a single operation. For more information, see the Amazon SES\n Developer Guide.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#UpdateTemplateRequest": { @@ -7222,11 +7453,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.ses#UpdateTemplateResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.ses#VerificationAttributes": { "type": "map", @@ -7238,30 +7475,38 @@ } }, "com.amazonaws.ses#VerificationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Pending", - "name": "Pending" - }, - { - "value": "Success", - "name": "Success" - }, - { - "value": "Failed", - "name": "Failed" - }, - { - "value": "TemporaryFailure", - "name": "TemporaryFailure" - }, - { - "value": "NotStarted", - "name": "NotStarted" + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" } - ] + }, + "Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "TemporaryFailure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TemporaryFailure" + } + }, + "NotStarted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotStarted" + } + } } }, "com.amazonaws.ses#VerificationToken": { @@ -7282,7 +7527,7 @@ "target": "com.amazonaws.ses#VerifyDomainDkimResponse" }, "traits": { - "smithy.api#documentation": "Returns a set of DKIM tokens for a domain identity.
\nWhen you execute the VerifyDomainDkim operation, the domain that you\n specify is added to the list of identities that are associated with your account.\n This is true even if you haven't already associated the domain with your account by\n using the VerifyDomainIdentity operation. However, you can't send email\n from the domain until you either successfully verify it or you\n successfully set up DKIM for\n it.
You use the tokens that are generated by this operation to create CNAME records. When\n Amazon SES detects that you've added these records to the DNS configuration for a domain, you\n can start sending email from that domain. You can start sending email even if you\n haven't added the TXT record provided by the VerifyDomainIdentity operation to the DNS\n configuration for your domain. All email that you send from the domain is authenticated\n using DKIM.
\nTo create the CNAME records for DKIM authentication, use the following values:
\n\n Name:\n token._domainkey.example.com\n
\n\n Type: CNAME
\n\n Value:\n token.dkim.amazonses.com
\nIn the preceding example, replace token with one of the tokens\n that are generated when you execute this operation. Replace\n example.com with your domain. Repeat this process for each\n token that's generated by this operation.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Returns a set of DKIM tokens for a domain identity.
\nWhen you execute the VerifyDomainDkim operation, the domain that you\n specify is added to the list of identities that are associated with your account.\n This is true even if you haven't already associated the domain with your account by\n using the VerifyDomainIdentity operation. However, you can't send email\n from the domain until you either successfully verify\n it or you successfully set up DKIM for\n it.
You use the tokens that are generated by this operation to create CNAME records. When\n Amazon SES detects that you've added these records to the DNS configuration for a domain, you\n can start sending email from that domain. You can start sending email even if you\n haven't added the TXT record provided by the VerifyDomainIdentity operation to the DNS\n configuration for your domain. All email that you send from the domain is authenticated\n using DKIM.
\nTo create the CNAME records for DKIM authentication, use the following values:
\n\n Name:\n token._domainkey.example.com\n
\n\n Type: CNAME
\n\n Value:\n token.dkim.amazonses.com
\nIn the preceding example, replace token with one of the tokens\n that are generated when you execute this operation. Replace\n example.com with your domain. Repeat this process for each\n token that's generated by this operation.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#VerifyDomainDkimRequest": { @@ -7297,7 +7542,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to generate the CNAME records needed to set up Easy DKIM with\n Amazon SES. For more information about setting up Easy DKIM, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to generate the CNAME records needed to set up Easy DKIM with\n Amazon SES. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#VerifyDomainDkimResponse": { @@ -7306,13 +7552,14 @@ "DkimTokens": { "target": "com.amazonaws.ses#VerificationTokenList", "traits": { - "smithy.api#documentation": "A set of character strings that represent the domain's identity. If the identity is an\n email address, the tokens represent the domain of that address.
\nUsing these tokens, you need to create DNS CNAME records that point to DKIM public\n keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS\n records. This detection process might take up to 72 hours. After successful detection,\n Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to\n domain identities, not email address identities.)
\nFor more information about creating DNS records using DKIM tokens, see the Amazon SES Developer\n Guide.
", + "smithy.api#documentation": "A set of character strings that represent the domain's identity. If the identity is an\n email address, the tokens represent the domain of that address.
\nUsing these tokens, you need to create DNS CNAME records that point to DKIM public\n keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS\n records. This detection process might take up to 72 hours. After successful detection,\n Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to\n domain identities, not email address identities.)
\nFor more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Returns CNAME records that you must publish to the DNS server of your domain to set up\n Easy DKIM with Amazon SES.
" + "smithy.api#documentation": "Returns CNAME records that you must publish to the DNS server of your domain to set up\n Easy DKIM with Amazon SES.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#VerifyDomainIdentity": { @@ -7324,7 +7571,7 @@ "target": "com.amazonaws.ses#VerifyDomainIdentityResponse" }, "traits": { - "smithy.api#documentation": "Adds a domain to the list of identities for your Amazon SES account in the current AWS\n Region and attempts to verify it. For more information about verifying domains, see\n Verifying Email\n Addresses and Domains in the Amazon SES Developer\n Guide.\n
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Adds a domain to the list of identities for your Amazon SES account in the current\n Amazon Web Services Region and attempts to verify it. For more information about verifying domains,\n see Verifying Email Addresses and Domains in the Amazon SES Developer\n Guide.\n
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#VerifyDomainIdentityRequest": { @@ -7339,7 +7586,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to begin Amazon SES domain verification and to generate the TXT\n records that you must publish to the DNS server of your domain to complete the\n verification. For information about domain verification, see the Amazon SES\n Developer Guide.
" + "smithy.api#documentation": "Represents a request to begin Amazon SES domain verification and to generate the TXT\n records that you must publish to the DNS server of your domain to complete the\n verification. For information about domain verification, see the Amazon SES Developer\n Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#VerifyDomainIdentityResponse": { @@ -7348,13 +7596,14 @@ "VerificationToken": { "target": "com.amazonaws.ses#VerificationToken", "traits": { - "smithy.api#documentation": "A TXT record that you must place in the DNS settings of the domain to complete domain\n verification with Amazon SES.
\nAs Amazon SES searches for the TXT record, the domain's verification status is \"Pending\".\n When Amazon SES detects the record, the domain's verification status changes to \"Success\". If\n Amazon SES is unable to detect the record within 72 hours, the domain's verification status\n changes to \"Failed.\" In that case, if you still want to verify the domain, you must\n restart the verification process from the beginning.
", + "smithy.api#documentation": "A TXT record that you must place in the DNS settings of the domain to complete domain\n verification with Amazon SES.
\nAs Amazon SES searches for the TXT record, the domain's verification status is \"Pending\".\n When Amazon SES detects the record, the domain's verification status changes to \"Success\". If\n Amazon SES is unable to detect the record within 72 hours, the domain's verification status\n changes to \"Failed.\" In that case, to verify the domain, you must restart the\n verification process from the beginning. The domain's verification status also changes\n to \"Success\" when it is DKIM verified.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Returns a TXT record that you must publish to the DNS server of your domain to\n complete domain verification with Amazon SES.
" + "smithy.api#documentation": "Returns a TXT record that you must publish to the DNS server of your domain to\n complete domain verification with Amazon SES.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#VerifyEmailAddress": { @@ -7381,7 +7630,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to begin email address verification with Amazon SES. For information\n about email address verification, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to begin email address verification with Amazon SES. For information\n about email address verification, see the Amazon SES\n Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#VerifyEmailIdentity": { @@ -7393,7 +7643,7 @@ "target": "com.amazonaws.ses#VerifyEmailIdentityResponse" }, "traits": { - "smithy.api#documentation": "Adds an email address to the list of identities for your Amazon SES account in the current\n AWS region and attempts to verify it. As a result of executing this operation, a\n verification email is sent to the specified address.
\nYou can execute this operation no more than once per second.
" + "smithy.api#documentation": "Adds an email address to the list of identities for your Amazon SES account in the current\n Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a\n verification email is sent to the specified address.
\nYou can execute this operation no more than once per second.
" } }, "com.amazonaws.ses#VerifyEmailIdentityRequest": { @@ -7408,14 +7658,16 @@ } }, "traits": { - "smithy.api#documentation": "Represents a request to begin email address verification with Amazon SES. For information\n about email address verification, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "Represents a request to begin email address verification with Amazon SES. For information\n about email address verification, see the Amazon SES\n Developer Guide.
", + "smithy.api#input": {} } }, "com.amazonaws.ses#VerifyEmailIdentityResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "An empty element returned on a successful request.
" + "smithy.api#documentation": "An empty element returned on a successful request.
", + "smithy.api#output": {} } }, "com.amazonaws.ses#WorkmailAction": { @@ -7424,19 +7676,19 @@ "TopicArn": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action\n is called. An example of an Amazon SNS topic ARN is\n arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about\n Amazon SNS topics, see the Amazon SNS Developer Guide.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action\n is called. You can find the ARN of a topic by using the ListTopics operation in\n Amazon SNS.
\nFor more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
" } }, "OrganizationArn": { "target": "com.amazonaws.ses#AmazonResourceName", "traits": { - "smithy.api#documentation": "The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail\n organization ARN is\n arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7.\n For information about Amazon WorkMail organizations, see the Amazon WorkMail\n Administrator Guide.
The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail\n ARNs use the following format:
\n\n arn:aws:workmail:\n
You can find the ID of your organization by using the ListOrganizations operation in Amazon WorkMail. Amazon WorkMail\n organization IDs begin with \"m-\", followed by a string of alphanumeric\n characters.
For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "When included in a receipt rule, this action calls Amazon WorkMail and, optionally,\n publishes a notification to Amazon Simple Notification Service (Amazon SNS). You will typically not use this action\n directly because Amazon WorkMail adds the rule automatically during its setup\n procedure.
\nFor information using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer\n Guide.
" + "smithy.api#documentation": "When included in a receipt rule, this action calls Amazon WorkMail and, optionally,\n publishes a notification to Amazon Simple Notification Service (Amazon SNS). It usually isn't necessary to set this up\n manually, because Amazon WorkMail adds the rule automatically during its setup\n procedure.
\nFor information using a receipt rule to call Amazon WorkMail, see the Amazon SES\n Developer Guide.
" } } } diff --git a/codegen/sdk-codegen/aws-models/swf.2012-01-25.json b/codegen/sdk-codegen/aws-models/swf.2012-01-25.json index 7f5afa6eb15..a5cf27b1f99 100644 --- a/codegen/sdk-codegen/aws-models/swf.2012-01-25.json +++ b/codegen/sdk-codegen/aws-models/swf.2012-01-25.json @@ -1634,6 +1634,15 @@ "smithy.api#documentation": "The ID of the DecisionTaskStarted event recorded when this decision task was started.\n This information can be useful for diagnosing problems by tracing back the chain of\n events leading up to this event.
The maximum amount of time the decision task can wait to be assigned to a worker.
" + } } }, "traits": { @@ -1661,6 +1670,12 @@ "traits": { "smithy.api#documentation": "The maximum duration for this decision task. The task is considered timed out if it doesn't completed within this duration.
\nThe duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
The maximum amount of time the decision task can wait to be assigned to a worker.
" + } } }, "traits": { @@ -1728,6 +1743,12 @@ "traits": { "smithy.api#enumValue": "START_TO_CLOSE" } + }, + "SCHEDULE_TO_START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULE_TO_START" + } } } }, @@ -4989,6 +5010,18 @@ "traits": { "smithy.api#documentation": "User defined context to add to workflow execution.
" } + }, + "taskList": { + "target": "com.amazonaws.swf#TaskList", + "traits": { + "smithy.api#documentation": "The task list to use for the future decision tasks of this workflow execution. This list overrides the original task list you specified while starting the workflow execution.
" + } + }, + "taskListScheduleToStartTimeout": { + "target": "com.amazonaws.swf#DurationInSecondsOptional", + "traits": { + "smithy.api#documentation": "Specifies a timeout (in seconds) for the task list override. When this parameter is missing, the task list override is permanent. This parameter makes it possible to temporarily override the task list. If a decision task scheduled on the override task list is not started within the timeout, the decision task will time out. Amazon SWF will revert the override and schedule a new decision task to the original task list.
\nIf a decision task scheduled on the override task list is started within the timeout, but not completed within the start-to-close timeout, Amazon SWF will also revert the override and schedule a new decision task to the original task list.
" + } } }, "traits": { @@ -5724,52 +5757,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -5777,13 +5814,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -5793,92 +5839,83 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://swf-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://swf-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] } ], @@ -5887,155 +5924,115 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, + "aws-us-gov", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] } ] } ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws-us-gov", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://swf.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://swf-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] + "endpoint": { + "url": "https://swf.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://swf-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://swf.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://swf.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://swf.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://swf.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, diff --git a/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json b/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json index 1ae42f12bb5..c44c4658a47 100644 --- a/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json +++ b/codegen/sdk-codegen/aws-models/transfer.2018-11-05.json @@ -577,7 +577,7 @@ "AccessRole": { "target": "com.amazonaws.transfer#Role", "traits": { - "smithy.api#documentation": "With AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt permission for that key.
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,\n provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
\n\n For AS2 connectors\n
\nWith AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt permission for that key.
\n For SFTP connectors\n
\nMake sure that the access role provides\n read and write access to the parent directory of the file location\n that's used in the StartFileTransfer request.\n Additionally, make sure that the role provides\n secretsmanager:GetSecretValue permission to Secrets Manager.
Creates the connector, which captures the parameters for an outbound connection for the\n AS2 or SFTP protocol. The connector is required for sending files to an externally hosted AS2 or SFTP server.\n For more details about AS2 connectors, see Create AS2 connectors.
\nYou must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).
Creates the connector, which captures the parameters for a connection for the\n AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server.\n For more details about connectors, see Create AS2 connectors and Create SFTP connectors.
\nYou must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).
With AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt permission for that key.
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,\n provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
\n\n For AS2 connectors\n
\nWith AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt permission for that key.
\n For SFTP connectors\n
\nMake sure that the access role provides\n read and write access to the parent directory of the file location\n that's used in the StartFileTransfer request.\n Additionally, make sure that the role provides\n secretsmanager:GetSecretValue permission to Secrets Manager.
With AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt permission for that key.
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,\n provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
\n\n For AS2 connectors\n
\nWith AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt permission for that key.
\n For SFTP connectors\n
\nMake sure that the access role provides\n read and write access to the parent directory of the file location\n that's used in the StartFileTransfer request.\n Additionally, make sure that the role provides\n secretsmanager:GetSecretValue permission to Secrets Manager.
With AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt permission for that key.
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,\n provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
\n\n For AS2 connectors\n
\nWith AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt permission for that key.
\n For SFTP connectors\n
\nMake sure that the access role provides\n read and write access to the parent directory of the file location\n that's used in the StartFileTransfer request.\n Additionally, make sure that the role provides\n secretsmanager:GetSecretValue permission to Secrets Manager.
The identifiers for the secrets (in Amazon Web Services Secrets Manager) that contain the SFTP user's private keys or passwords.
" + "smithy.api#documentation": "The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.
" } }, "TrustedHostKeys": { @@ -6558,7 +6558,7 @@ } ], "traits": { - "smithy.api#documentation": "Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
\nFor an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files\n you want to transfer.
For an SFTP connector, the file transfer can be either outbound or inbound. In both\n cases, you specify the ConnectorId. Depending on the direction of the transfer,\n you also specify the following items:
If you are transferring file from a partner's SFTP server to a Transfer Family\n server, you specify one or more RetreiveFilePaths to identify the files\n you want to transfer, and a LocalDirectoryPath to specify the destination\n folder.
If you are transferring file to a partner's SFTP server from Amazon Web Services\n storage, you specify one or more SendFilePaths to identify the files you\n want to transfer, and a RemoteDirectoryPath to specify the destination\n folder.
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
\nFor an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files\n you want to transfer.
For an SFTP connector, the file transfer can be either outbound or inbound. In both\n cases, you specify the ConnectorId. Depending on the direction of the transfer,\n you also specify the following items:
If you are transferring file from a partner's SFTP server to Amazon Web Services\n storage, you specify one or more RetreiveFilePaths to identify the files\n you want to transfer, and a LocalDirectoryPath to specify the destination\n folder.
If you are transferring file to a partner's SFTP server from Amazon Web Services\n storage, you specify one or more SendFilePaths to identify the files you\n want to transfer, and a RemoteDirectoryPath to specify the destination\n folder.
One or more source paths for the Transfer Family server. Each string represents a source file path for one outbound file transfer. For example,\n \n DOC-EXAMPLE-BUCKET/myfile.txt\n .
One or more source paths for the Amazon S3 storage. Each string represents a source\n file path for one outbound file transfer. For example,\n \n DOC-EXAMPLE-BUCKET/myfile.txt\n .
Replace \n DOC-EXAMPLE-BUCKET\n with one of your actual buckets.
With AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt permission for that key.
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,\n provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
\n\n For AS2 connectors\n
\nWith AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt permission for that key.
\n For SFTP connectors\n
\nMake sure that the access role provides\n read and write access to the parent directory of the file location\n that's used in the StartFileTransfer request.\n Additionally, make sure that the role provides\n secretsmanager:GetSecretValue permission to Secrets Manager.
With AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt permission for that key.
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,\n provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
\n\n For AS2 connectors\n
\nWith AS2, you can send files by calling StartFileTransfer and specifying the\n file paths in the request parameter, SendFilePaths. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt, parent\n directory is /bucket/dir/) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt permission for that key.
\n For SFTP connectors\n
\nMake sure that the access role provides\n read and write access to the parent directory of the file location\n that's used in the StartFileTransfer request.\n Additionally, make sure that the role provides\n secretsmanager:GetSecretValue permission to Secrets Manager.