From 0cb66450b4644762b09a75280eca2ea5e54b7146 Mon Sep 17 00:00:00 2001 From: Ian Botsford <83236726+ianbotsf@users.noreply.github.com> Date: Fri, 11 Aug 2023 07:16:17 -0700 Subject: [PATCH] chore: sync model and smithy-kotlin versions (#1013) --- .../0e534d26-9baf-4bea-a9a8-032c024493fd.json | 5 + codegen/sdk/aws-models/acm-pca.json | 8 +- codegen/sdk/aws-models/amplifyuibuilder.json | 439 +- .../sdk/aws-models/application-insights.json | 1575 +++- codegen/sdk/aws-models/auto-scaling.json | 1558 +++- codegen/sdk/aws-models/backup.json | 312 +- codegen/sdk/aws-models/batch.json | 24 +- codegen/sdk/aws-models/budgets.json | 1338 +-- codegen/sdk/aws-models/chime-sdk-voice.json | 121 +- codegen/sdk/aws-models/cleanrooms.json | 1980 +++- codegen/sdk/aws-models/cloud9.json | 90 +- codegen/sdk/aws-models/cloudformation.json | 616 +- codegen/sdk/aws-models/cloudfront.json | 308 +- codegen/sdk/aws-models/cloudtrail.json | 402 +- .../sdk/aws-models/codestar-connections.json | 199 +- .../aws-models/cognito-identity-provider.json | 596 +- codegen/sdk/aws-models/connect.json | 894 +- .../database-migration-service.json | 7951 ++++++++++++----- codegen/sdk/aws-models/datasync.json | 388 +- codegen/sdk/aws-models/detective.json | 346 +- codegen/sdk/aws-models/drs.json | 4 + codegen/sdk/aws-models/ebs.json | 437 +- codegen/sdk/aws-models/ec2.json | 2760 +++++- codegen/sdk/aws-models/ecs.json | 1142 ++- codegen/sdk/aws-models/eks.json | 302 +- .../aws-models/elastic-load-balancing-v2.json | 58 +- codegen/sdk/aws-models/elasticache.json | 1110 ++- codegen/sdk/aws-models/fsx.json | 656 +- .../sdk/aws-models/global-accelerator.json | 742 +- codegen/sdk/aws-models/glue.json | 400 +- codegen/sdk/aws-models/guardduty.json | 400 +- codegen/sdk/aws-models/inspector2.json | 689 +- codegen/sdk/aws-models/internetmonitor.json | 359 +- codegen/sdk/aws-models/ivs-realtime.json | 135 +- codegen/sdk/aws-models/kafka.json | 403 + .../kinesis-video-archived-media.json | 515 +- codegen/sdk/aws-models/kinesis-video.json | 354 +- codegen/sdk/aws-models/lookoutequipment.json | 2112 ++++- codegen/sdk/aws-models/medialive.json | 28 + codegen/sdk/aws-models/omics.json | 242 +- codegen/sdk/aws-models/pinpoint.json | 118 +- codegen/sdk/aws-models/polly.json | 12 + codegen/sdk/aws-models/rds.json | 5075 ++++++++++- codegen/sdk/aws-models/rekognition.json | 745 +- codegen/sdk/aws-models/resiliencehub.json | 1388 ++- codegen/sdk/aws-models/route-53.json | 24 +- codegen/sdk/aws-models/sagemaker.json | 880 +- codegen/sdk/aws-models/scheduler.json | 87 +- codegen/sdk/aws-models/secrets-manager.json | 3 + codegen/sdk/aws-models/service-catalog.json | 382 +- codegen/sdk/aws-models/sqs.json | 12 +- codegen/sdk/aws-models/transfer.json | 362 +- gradle.properties | 2 +- 53 files changed, 30873 insertions(+), 10215 deletions(-) create mode 100644 .changes/0e534d26-9baf-4bea-a9a8-032c024493fd.json diff --git a/.changes/0e534d26-9baf-4bea-a9a8-032c024493fd.json b/.changes/0e534d26-9baf-4bea-a9a8-032c024493fd.json new file mode 100644 index 000000000000..54b049ecd181 --- /dev/null +++ b/.changes/0e534d26-9baf-4bea-a9a8-032c024493fd.json @@ -0,0 +1,5 @@ +{ + "id": "0e534d26-9baf-4bea-a9a8-032c024493fd", + "type": "misc", + "description": "Sync AWS service models and **smithy-kotlin** to latest versions" +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/acm-pca.json b/codegen/sdk/aws-models/acm-pca.json index d4fc149e2744..5fce384663bf 100644 --- a/codegen/sdk/aws-models/acm-pca.json +++ b/codegen/sdk/aws-models/acm-pca.json @@ -115,7 +115,7 @@ "name": "acm-pca" }, "aws.protocols#awsJson1_1": {}, - "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.

\n

The 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.

\n

Each 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.

\n

To 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.

\n

The 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.

\n

Each 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.

\n

To 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.

\n

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

\n \n

Some 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.\"

\n

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.

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

Specifies a cryptographic key management compliance standard used for handling CA\n\t\t\tkeys.

\n

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

\n \n

Some 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.\"

\n

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.

\n " } }, "Tags": { @@ -3235,7 +3235,7 @@ "SigningAlgorithm": { "target": "com.amazonaws.acmpca#SigningAlgorithm", "traits": { - "smithy.api#documentation": "

The name of the algorithm that will be used to sign the certificate to be issued.

\n

This parameter should not be confused with the SigningAlgorithm parameter\n\t\t\tused to sign a CSR in the CreateCertificateAuthority action.

\n \n

The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of\n\t\t\t\tthe CA's secret key.

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

The name of the algorithm that will be used to sign the certificate to be issued.

\n

This parameter should not be confused with the SigningAlgorithm parameter\n\t\t\tused to sign a CSR in the CreateCertificateAuthority action.

\n \n

The specified signing algorithm family (RSA or ECDSA) must match the algorithm\n\t\t\t\tfamily of the CA's secret key.

\n ", "smithy.api#required": {} } }, @@ -3261,7 +3261,7 @@ "IdempotencyToken": { "target": "com.amazonaws.acmpca#IdempotencyToken", "traits": { - "smithy.api#documentation": "

Alphanumeric 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/aws-models/amplifyuibuilder.json b/codegen/sdk/aws-models/amplifyuibuilder.json index 73dd9a650134..4fd9dc128873 100644 --- a/codegen/sdk/aws-models/amplifyuibuilder.json +++ b/codegen/sdk/aws-models/amplifyuibuilder.json @@ -191,52 +191,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", @@ -244,13 +248,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -260,224 +273,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://amplifyuibuilder-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://amplifyuibuilder-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://amplifyuibuilder-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://amplifyuibuilder-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://amplifyuibuilder.{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://amplifyuibuilder.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://amplifyuibuilder.{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://amplifyuibuilder.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -1005,6 +969,32 @@ } } }, + "com.amazonaws.amplifyuibuilder#ApiConfiguration": { + "type": "union", + "members": { + "graphQLConfig": { + "target": "com.amazonaws.amplifyuibuilder#GraphQLRenderConfig", + "traits": { + "smithy.api#documentation": "

The configuration for an application using GraphQL APIs.

" + } + }, + "dataStoreConfig": { + "target": "com.amazonaws.amplifyuibuilder#DataStoreRenderConfig", + "traits": { + "smithy.api#documentation": "

The configuration for an application using DataStore APIs.

" + } + }, + "noApiConfig": { + "target": "com.amazonaws.amplifyuibuilder#NoApiRenderConfig", + "traits": { + "smithy.api#documentation": "

The configuration for an application with no API being used.

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

Describes the API configuration for a code generation job.

" + } + }, "com.amazonaws.amplifyuibuilder#AppId": { "type": "string", "traits": { @@ -1545,7 +1535,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the configuration information for rendering the UI component associated the code generation job.

" + "smithy.api#documentation": "

Describes the configuration information for rendering the UI component associated with the code generation job.

" } }, "com.amazonaws.amplifyuibuilder#CodegenJobResource": { @@ -2579,7 +2569,7 @@ "aws.iam#requiredActions": [ "amplify:GetApp" ], - "smithy.api#documentation": "

Creates a new form for an Amplify.

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

Creates a new form for an Amplify app.

", "smithy.api#http": { "uri": "/app/{appId}/environment/{environmentName}/forms", "method": "POST" @@ -2836,6 +2826,13 @@ } } }, + "com.amazonaws.amplifyuibuilder#DataStoreRenderConfig": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Describes the DataStore configuration for an API for a code generation job.

" + } + }, "com.amazonaws.amplifyuibuilder#DeleteComponent": { "type": "operation", "input": { @@ -4524,6 +4521,49 @@ } } }, + "com.amazonaws.amplifyuibuilder#GraphQLRenderConfig": { + "type": "structure", + "members": { + "typesFilePath": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The path to the GraphQL types file, relative to the component output directory.

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

The path to the GraphQL queries file, relative to the component output directory.

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

The path to the GraphQL mutations file, relative to the component output directory.

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

The path to the GraphQL subscriptions file, relative to the component output directory.

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

The path to the GraphQL fragments file, relative to the component output directory.

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

Describes the GraphQL configuration for an API for a code generation job.

" + } + }, "com.amazonaws.amplifyuibuilder#IdentifierList": { "type": "list", "member": { @@ -5061,6 +5101,13 @@ "smithy.api#documentation": "

Represents the state configuration when an action modifies a property of another element\n within the same component.

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

Describes the configuration for an application with no API being used.

" + } + }, "com.amazonaws.amplifyuibuilder#NumValues": { "type": "list", "member": { @@ -5233,6 +5280,12 @@ "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether the code generation job should render inline source maps.

" } + }, + "apiConfiguration": { + "target": "com.amazonaws.amplifyuibuilder#ApiConfiguration", + "traits": { + "smithy.api#documentation": "

The API configuration for the code generation job.

" + } } }, "traits": { @@ -5490,7 +5543,7 @@ "aws.iam#requiredActions": [ "amplify:GetApp" ], - "smithy.api#documentation": "

Starts a code generation job for for a specified Amplify app and backend environment.

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

Starts a code generation job for a specified Amplify app and backend environment.

", "smithy.api#http": { "uri": "/app/{appId}/environment/{environmentName}/codegen-jobs", "method": "POST" diff --git a/codegen/sdk/aws-models/application-insights.json b/codegen/sdk/aws-models/application-insights.json index fa3edcb14c2b..34dba829948f 100644 --- a/codegen/sdk/aws-models/application-insights.json +++ b/codegen/sdk/aws-models/application-insights.json @@ -46,6 +46,91 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.applicationinsights#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d{12}$" + } + }, + "com.amazonaws.applicationinsights#AddWorkload": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationinsights#AddWorkloadRequest" + }, + "output": { + "target": "com.amazonaws.applicationinsights#AddWorkloadResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationinsights#InternalServerException" + }, + { + "target": "com.amazonaws.applicationinsights#ResourceInUseException" + }, + { + "target": "com.amazonaws.applicationinsights#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.applicationinsights#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a workload to a component. Each component can have at most five workloads.

" + } + }, + "com.amazonaws.applicationinsights#AddWorkloadRequest": { + "type": "structure", + "members": { + "ResourceGroupName": { + "target": "com.amazonaws.applicationinsights#ResourceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the resource group.

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

The name of the component.

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

The configuration settings of the workload. The value is the escaped JSON of the configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationinsights#AddWorkloadResponse": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.applicationinsights#WorkloadId", + "traits": { + "smithy.api#documentation": "

The ID of the workload.

" + } + }, + "WorkloadConfiguration": { + "target": "com.amazonaws.applicationinsights#WorkloadConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the workload. The value is the escaped JSON of the configuration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.applicationinsights#AffectedResource": { "type": "string" }, @@ -118,6 +203,12 @@ "com.amazonaws.applicationinsights#ApplicationInfo": { "type": "structure", "members": { + "AccountId": { + "target": "com.amazonaws.applicationinsights#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID for the owner of the application.

" + } + }, "ResourceGroupName": { "target": "com.amazonaws.applicationinsights#ResourceGroupName", "traits": { @@ -163,7 +254,7 @@ "DiscoveryType": { "target": "com.amazonaws.applicationinsights#DiscoveryType", "traits": { - "smithy.api#documentation": "

\n The method used by Application Insights to onboard your resources.\n

" + "smithy.api#documentation": "

The method used by Application Insights to onboard your resources.

" } } }, @@ -210,26 +301,32 @@ "type": "string" }, "com.amazonaws.applicationinsights#CloudWatchEventSource": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EC2", - "name": "EC2" - }, - { - "value": "CODE_DEPLOY", - "name": "CODE_DEPLOY" - }, - { - "value": "HEALTH", - "name": "HEALTH" - }, - { - "value": "RDS", - "name": "RDS" + "type": "enum", + "members": { + "EC2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2" + } + }, + "CODE_DEPLOY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CODE_DEPLOY" + } + }, + "HEALTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEALTH" } - ] + }, + "RDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS" + } + } } }, "com.amazonaws.applicationinsights#CodeDeployApplication": { @@ -270,6 +367,18 @@ "com.amazonaws.applicationinsights#ConfigurationEvent": { "type": "structure", "members": { + "ResourceGroupName": { + "target": "com.amazonaws.applicationinsights#ResourceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the resource group of the application to which the configuration event belongs.

" + } + }, + "AccountId": { + "target": "com.amazonaws.applicationinsights#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID for the owner of the application to which the configuration event belongs.

" + } + }, "MonitoredResourceARN": { "target": "com.amazonaws.applicationinsights#ConfigurationEventMonitoredResourceARN", "traits": { @@ -327,45 +436,55 @@ "type": "string" }, "com.amazonaws.applicationinsights#ConfigurationEventResourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CLOUDWATCH_ALARM", - "name": "CLOUDWATCH_ALARM" - }, - { - "value": "CLOUDWATCH_LOG", - "name": "CLOUDWATCH_LOG" - }, - { - "value": "CLOUDFORMATION", - "name": "CLOUDFORMATION" - }, - { - "value": "SSM_ASSOCIATION", - "name": "SSM_ASSOCIATION" + "type": "enum", + "members": { + "CLOUDWATCH_ALARM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDWATCH_ALARM" + } + }, + "CLOUDWATCH_LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDWATCH_LOG" + } + }, + "CLOUDFORMATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDFORMATION" + } + }, + "SSM_ASSOCIATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSM_ASSOCIATION" } - ] + } } }, "com.amazonaws.applicationinsights#ConfigurationEventStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "INFO", - "name": "INFO" - }, - { - "value": "WARN", - "name": "WARN" - }, - { - "value": "ERROR", - "name": "ERROR" + "type": "enum", + "members": { + "INFO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFO" + } + }, + "WARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARN" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" } - ] + } } }, "com.amazonaws.applicationinsights#ConfigurationEventTime": { @@ -451,9 +570,12 @@ "GroupingType": { "target": "com.amazonaws.applicationinsights#GroupingType", "traits": { - "smithy.api#documentation": "

Application Insights can create applications based on a resource group or on an account.\n To create an account-based application using all of the resources in the account, set this parameter to ACCOUNT_BASED.\n

" + "smithy.api#documentation": "

Application Insights can create applications based on a resource group or on an account.\n To create an account-based application using all of the resources in the account, set this\n parameter to ACCOUNT_BASED.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#CreateApplicationResponse": { @@ -465,6 +587,9 @@ "smithy.api#documentation": "

Information about the application.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.applicationinsights#CreateComponent": { @@ -517,11 +642,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#CreateComponentResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.applicationinsights#CreateLogPattern": { "type": "operation", @@ -588,6 +719,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#CreateLogPatternResponse": { @@ -605,6 +739,9 @@ "smithy.api#documentation": "

The name of the resource group.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.applicationinsights#CustomComponentName": { @@ -653,11 +790,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#DeleteApplicationResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.applicationinsights#DeleteComponent": { "type": "operation", @@ -699,11 +842,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#DeleteComponentResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.applicationinsights#DeleteLogPattern": { "type": "operation", @@ -755,11 +904,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#DeleteLogPatternResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.applicationinsights#DescribeApplication": { "type": "operation", @@ -793,7 +948,16 @@ "smithy.api#documentation": "

The name of the resource group.

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

The AWS account ID for the resource group owner.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#DescribeApplicationResponse": { @@ -805,6 +969,9 @@ "smithy.api#documentation": "

Information about the application.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.applicationinsights#DescribeComponent": { @@ -899,7 +1066,16 @@ "smithy.api#documentation": "

The tier of the application component.

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

The recommended configuration type.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#DescribeComponentConfigurationRecommendationResponse": { @@ -911,6 +1087,9 @@ "smithy.api#documentation": "

The recommended configuration settings of the component. The value is the escaped JSON\n of the configuration.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.applicationinsights#DescribeComponentConfigurationRequest": { @@ -929,7 +1108,16 @@ "smithy.api#documentation": "

The name of the component.

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

The AWS account ID for the resource group owner.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#DescribeComponentConfigurationResponse": { @@ -953,6 +1141,9 @@ "smithy.api#documentation": "

The configuration settings of the component. The value is the escaped JSON of the\n configuration.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.applicationinsights#DescribeComponentRequest": { @@ -971,7 +1162,16 @@ "smithy.api#documentation": "

The name of the component.

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

The AWS account ID for the resource group owner.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#DescribeComponentResponse": { @@ -986,6 +1186,9 @@ "smithy.api#documentation": "

The list of resource ARNs that belong to the component.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.applicationinsights#DescribeLogPattern": { @@ -1034,7 +1237,16 @@ "smithy.api#documentation": "

The name of the log pattern.

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

The AWS account ID for the resource group owner.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#DescribeLogPatternResponse": { @@ -1046,12 +1258,21 @@ "smithy.api#documentation": "

The name of the resource group.

" } }, + "AccountId": { + "target": "com.amazonaws.applicationinsights#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + } + }, "LogPattern": { "target": "com.amazonaws.applicationinsights#LogPattern", "traits": { "smithy.api#documentation": "

The successfully created log pattern.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.applicationinsights#DescribeObservation": { @@ -1086,7 +1307,16 @@ "smithy.api#documentation": "

The ID of the observation.

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

The AWS account ID for the resource group owner.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#DescribeObservationResponse": { @@ -1098,6 +1328,9 @@ "smithy.api#documentation": "

Information about the observation.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.applicationinsights#DescribeProblem": { @@ -1155,7 +1388,16 @@ "smithy.api#documentation": "

The ID of the problem.

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

The AWS account ID for the resource group owner.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#DescribeProblemObservationsResponse": { @@ -1167,6 +1409,9 @@ "smithy.api#documentation": "

Observations related to the problem.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.applicationinsights#DescribeProblemRequest": { @@ -1178,7 +1423,16 @@ "smithy.api#documentation": "

The ID of the problem.

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

The AWS account ID for the owner of the resource group affected by the problem.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#DescribeProblemResponse": { @@ -1190,50 +1444,142 @@ "smithy.api#documentation": "

Information about the problem.

" } } - } - }, - "com.amazonaws.applicationinsights#DetectedWorkload": { - "type": "map", - "key": { - "target": "com.amazonaws.applicationinsights#Tier" }, - "value": { - "target": "com.amazonaws.applicationinsights#WorkloadMetaData" - } - }, - "com.amazonaws.applicationinsights#DiscoveryType": { - "type": "string", "traits": { - "smithy.api#enum": [ - { - "value": "RESOURCE_GROUP_BASED", - "name": "RESOURCE_GROUP_BASED" - }, - { - "value": "ACCOUNT_BASED", - "name": "ACCOUNT_BASED" - } - ] + "smithy.api#output": {} } }, - "com.amazonaws.applicationinsights#EC2WindowsBarleyService": { - "type": "service", - "version": "2018-11-25", - "operations": [ + "com.amazonaws.applicationinsights#DescribeWorkload": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationinsights#DescribeWorkloadRequest" + }, + "output": { + "target": "com.amazonaws.applicationinsights#DescribeWorkloadResponse" + }, + "errors": [ { - "target": "com.amazonaws.applicationinsights#CreateApplication" + "target": "com.amazonaws.applicationinsights#InternalServerException" }, { - "target": "com.amazonaws.applicationinsights#CreateComponent" + "target": "com.amazonaws.applicationinsights#ResourceNotFoundException" }, { - "target": "com.amazonaws.applicationinsights#CreateLogPattern" + "target": "com.amazonaws.applicationinsights#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a workload and its configuration.

" + } + }, + "com.amazonaws.applicationinsights#DescribeWorkloadRequest": { + "type": "structure", + "members": { + "ResourceGroupName": { + "target": "com.amazonaws.applicationinsights#ResourceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the resource group.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.applicationinsights#DeleteApplication" + "ComponentName": { + "target": "com.amazonaws.applicationinsights#ComponentName", + "traits": { + "smithy.api#documentation": "

The name of the component.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.applicationinsights#DeleteComponent" + "WorkloadId": { + "target": "com.amazonaws.applicationinsights#WorkloadId", + "traits": { + "smithy.api#documentation": "

The ID of the workload.

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

The AWS account ID for the workload owner.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationinsights#DescribeWorkloadResponse": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.applicationinsights#WorkloadId", + "traits": { + "smithy.api#documentation": "

The ID of the workload.

" + } + }, + "WorkloadRemarks": { + "target": "com.amazonaws.applicationinsights#Remarks", + "traits": { + "smithy.api#documentation": "

If logging is supported for the resource type, shows whether the component has configured logs to be monitored.

" + } + }, + "WorkloadConfiguration": { + "target": "com.amazonaws.applicationinsights#WorkloadConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the workload. The value is the escaped JSON of the configuration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationinsights#DetectedWorkload": { + "type": "map", + "key": { + "target": "com.amazonaws.applicationinsights#Tier" + }, + "value": { + "target": "com.amazonaws.applicationinsights#WorkloadMetaData" + } + }, + "com.amazonaws.applicationinsights#DiscoveryType": { + "type": "enum", + "members": { + "RESOURCE_GROUP_BASED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_GROUP_BASED" + } + }, + "ACCOUNT_BASED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_BASED" + } + } + } + }, + "com.amazonaws.applicationinsights#EC2WindowsBarleyService": { + "type": "service", + "version": "2018-11-25", + "operations": [ + { + "target": "com.amazonaws.applicationinsights#AddWorkload" + }, + { + "target": "com.amazonaws.applicationinsights#CreateApplication" + }, + { + "target": "com.amazonaws.applicationinsights#CreateComponent" + }, + { + "target": "com.amazonaws.applicationinsights#CreateLogPattern" + }, + { + "target": "com.amazonaws.applicationinsights#DeleteApplication" + }, + { + "target": "com.amazonaws.applicationinsights#DeleteComponent" }, { "target": "com.amazonaws.applicationinsights#DeleteLogPattern" @@ -1262,6 +1608,9 @@ { "target": "com.amazonaws.applicationinsights#DescribeProblemObservations" }, + { + "target": "com.amazonaws.applicationinsights#DescribeWorkload" + }, { "target": "com.amazonaws.applicationinsights#ListApplications" }, @@ -1283,6 +1632,12 @@ { "target": "com.amazonaws.applicationinsights#ListTagsForResource" }, + { + "target": "com.amazonaws.applicationinsights#ListWorkloads" + }, + { + "target": "com.amazonaws.applicationinsights#RemoveWorkload" + }, { "target": "com.amazonaws.applicationinsights#TagResource" }, @@ -1300,6 +1655,12 @@ }, { "target": "com.amazonaws.applicationinsights#UpdateLogPattern" + }, + { + "target": "com.amazonaws.applicationinsights#UpdateProblem" + }, + { + "target": "com.amazonaws.applicationinsights#UpdateWorkload" } ], "traits": { @@ -2308,44 +2669,48 @@ } }, "com.amazonaws.applicationinsights#FeedbackKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "INSIGHTS_FEEDBACK", - "name": "INSIGHTS_FEEDBACK" + "type": "enum", + "members": { + "INSIGHTS_FEEDBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSIGHTS_FEEDBACK" } - ] + } } }, "com.amazonaws.applicationinsights#FeedbackValue": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NOT_SPECIFIED", - "name": "NOT_SPECIFIED" - }, - { - "value": "USEFUL", - "name": "USEFUL" - }, - { - "value": "NOT_USEFUL", - "name": "NOT_USEFUL" + "type": "enum", + "members": { + "NOT_SPECIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_SPECIFIED" + } + }, + "USEFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USEFUL" + } + }, + "NOT_USEFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_USEFUL" } - ] + } } }, "com.amazonaws.applicationinsights#GroupingType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACCOUNT_BASED", - "name": "ACCOUNT_BASED" + "type": "enum", + "members": { + "ACCOUNT_BASED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_BASED" } - ] + } } }, "com.amazonaws.applicationinsights#HealthEventArn": { @@ -2431,7 +2796,16 @@ "traits": { "smithy.api#documentation": "

The token to request the next page of results.

" } + }, + "AccountId": { + "target": "com.amazonaws.applicationinsights#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#ListApplicationsResponse": { @@ -2449,6 +2823,9 @@ "smithy.api#documentation": "

The token used to retrieve the next page of results. This value is null\n when there are no more results to return.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.applicationinsights#ListComponents": { @@ -2500,7 +2877,16 @@ "traits": { "smithy.api#documentation": "

The token to request the next page of results.

" } + }, + "AccountId": { + "target": "com.amazonaws.applicationinsights#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#ListComponentsResponse": { @@ -2518,6 +2904,9 @@ "smithy.api#documentation": "

The token to request the next page of results.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.applicationinsights#ListConfigurationHistory": { @@ -2586,7 +2975,16 @@ "traits": { "smithy.api#documentation": "

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

" } + }, + "AccountId": { + "target": "com.amazonaws.applicationinsights#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#ListConfigurationHistoryResponse": { @@ -2604,6 +3002,9 @@ "smithy.api#documentation": "

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

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.applicationinsights#ListLogPatternSets": { @@ -2655,7 +3056,16 @@ "traits": { "smithy.api#documentation": "

The token to request the next page of results.

" } + }, + "AccountId": { + "target": "com.amazonaws.applicationinsights#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#ListLogPatternSetsResponse": { @@ -2667,6 +3077,12 @@ "smithy.api#documentation": "

The name of the resource group.

" } }, + "AccountId": { + "target": "com.amazonaws.applicationinsights#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + } + }, "LogPatternSets": { "target": "com.amazonaws.applicationinsights#LogPatternSetList", "traits": { @@ -2679,6 +3095,9 @@ "smithy.api#documentation": "

The token used to retrieve the next page of results. This value is null\n when there are no more results to return.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.applicationinsights#ListLogPatterns": { @@ -2736,7 +3155,16 @@ "traits": { "smithy.api#documentation": "

The token to request the next page of results.

" } + }, + "AccountId": { + "target": "com.amazonaws.applicationinsights#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#ListLogPatternsResponse": { @@ -2748,6 +3176,12 @@ "smithy.api#documentation": "

The name of the resource group.

" } }, + "AccountId": { + "target": "com.amazonaws.applicationinsights#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + } + }, "LogPatterns": { "target": "com.amazonaws.applicationinsights#LogPatternList", "traits": { @@ -2760,6 +3194,9 @@ "smithy.api#documentation": "

The token used to retrieve the next page of results. This value is null\n when there are no more results to return.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.applicationinsights#ListProblems": { @@ -2793,6 +3230,12 @@ "com.amazonaws.applicationinsights#ListProblemsRequest": { "type": "structure", "members": { + "AccountId": { + "target": "com.amazonaws.applicationinsights#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + } + }, "ResourceGroupName": { "target": "com.amazonaws.applicationinsights#ResourceGroupName", "traits": { @@ -2828,7 +3271,16 @@ "traits": { "smithy.api#documentation": "

The name of the component.

" } + }, + "Visibility": { + "target": "com.amazonaws.applicationinsights#Visibility", + "traits": { + "smithy.api#documentation": "

Specifies whether or not you can view the problem. If not specified, visible and\n ignored problems are returned.

" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#ListProblemsResponse": { @@ -2851,7 +3303,16 @@ "traits": { "smithy.api#documentation": "

The name of the resource group.

" } + }, + "AccountId": { + "target": "com.amazonaws.applicationinsights#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.applicationinsights#ListTagsForResource": { @@ -2884,6 +3345,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#ListTagsForResourceResponse": { @@ -2895,25 +3359,120 @@ "smithy.api#documentation": "

An array that lists all the tags that are associated with the application. Each tag\n consists of a required tag key (Key) and an associated tag value\n (Value).

" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.applicationinsights#LogFilter": { - "type": "string", + "com.amazonaws.applicationinsights#ListWorkloads": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationinsights#ListWorkloadsRequest" + }, + "output": { + "target": "com.amazonaws.applicationinsights#ListWorkloadsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationinsights#InternalServerException" + }, + { + "target": "com.amazonaws.applicationinsights#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.applicationinsights#ValidationException" + } + ], "traits": { - "smithy.api#enum": [ - { - "value": "ERROR", - "name": "ERROR" - }, - { - "value": "WARN", - "name": "WARN" - }, - { - "value": "INFO", - "name": "INFO" + "smithy.api#documentation": "

Lists the workloads that are configured on a given component.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.applicationinsights#ListWorkloadsRequest": { + "type": "structure", + "members": { + "ResourceGroupName": { + "target": "com.amazonaws.applicationinsights#ResourceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the resource group.

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

The name of the component.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.applicationinsights#MaxEntities", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned NextToken value.

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

The token to request the next page of results.

" + } + }, + "AccountId": { + "target": "com.amazonaws.applicationinsights#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID of the owner of the workload.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationinsights#ListWorkloadsResponse": { + "type": "structure", + "members": { + "WorkloadList": { + "target": "com.amazonaws.applicationinsights#WorkloadList", + "traits": { + "smithy.api#documentation": "

The list of workloads.

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

The token to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationinsights#LogFilter": { + "type": "enum", + "members": { + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "WARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARN" + } + }, + "INFO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFO" } - ] + } } }, "com.amazonaws.applicationinsights#LogGroup": { @@ -3335,18 +3894,20 @@ } }, "com.amazonaws.applicationinsights#OsType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "WINDOWS", - "name": "WINDOWS" - }, - { - "value": "LINUX", - "name": "LINUX" + "type": "enum", + "members": { + "WINDOWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS" } - ] + }, + "LINUX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINUX" + } + } } }, "com.amazonaws.applicationinsights#PaginationToken": { @@ -3410,6 +3971,12 @@ "smithy.api#documentation": "

A measure of the level of impact of the problem.

" } }, + "AccountId": { + "target": "com.amazonaws.applicationinsights#AccountId", + "traits": { + "smithy.api#documentation": "

The AWS account ID for the owner of the resource group affected by the problem.

" + } + }, "ResourceGroupName": { "target": "com.amazonaws.applicationinsights#ResourceGroupName", "traits": { @@ -3433,7 +4000,19 @@ "traits": { "smithy.api#documentation": "

The last time that the problem reoccurred after its last resolution.

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

Specifies whether or not you can view the problem. Updates to ignored problems do not\n generate notifications.

" + } + }, + "ResolutionMethod": { + "target": "com.amazonaws.applicationinsights#ResolutionMethod", + "traits": { + "smithy.api#documentation": "

Specifies how the problem was resolved. If the value is AUTOMATIC, the\n system resolved the problem. If the value is MANUAL, the user resolved the\n problem. If the value is UNRESOLVED, then the problem is not resolved.

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

Describes a problem that is detected by correlating observations.

" @@ -3461,6 +4040,29 @@ "com.amazonaws.applicationinsights#RdsEventMessage": { "type": "string" }, + "com.amazonaws.applicationinsights#RecommendationType": { + "type": "enum", + "members": { + "INFRA_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFRA_ONLY" + } + }, + "WORKLOAD_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORKLOAD_ONLY" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, "com.amazonaws.applicationinsights#RecurringCount": { "type": "long" }, @@ -3484,6 +4086,88 @@ "com.amazonaws.applicationinsights#RemoveSNSTopic": { "type": "boolean" }, + "com.amazonaws.applicationinsights#RemoveWorkload": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationinsights#RemoveWorkloadRequest" + }, + "output": { + "target": "com.amazonaws.applicationinsights#RemoveWorkloadResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationinsights#InternalServerException" + }, + { + "target": "com.amazonaws.applicationinsights#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.applicationinsights#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Remove workload from a component.

" + } + }, + "com.amazonaws.applicationinsights#RemoveWorkloadRequest": { + "type": "structure", + "members": { + "ResourceGroupName": { + "target": "com.amazonaws.applicationinsights#ResourceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the resource group.

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

The name of the component.

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

The ID of the workload.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationinsights#RemoveWorkloadResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationinsights#ResolutionMethod": { + "type": "enum", + "members": { + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + }, + "AUTOMATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMATIC" + } + }, + "UNRESOLVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNRESOLVED" + } + } + } + }, "com.amazonaws.applicationinsights#ResourceARN": { "type": "string", "traits": { @@ -3558,26 +4242,32 @@ "type": "string" }, "com.amazonaws.applicationinsights#SeverityLevel": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Informative", - "name": "Informative" - }, - { - "value": "Low", - "name": "Low" - }, - { - "value": "Medium", - "name": "Medium" - }, - { - "value": "High", - "name": "High" + "type": "enum", + "members": { + "Informative": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Informative" + } + }, + "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.applicationinsights#SourceARN": { @@ -3602,26 +4292,38 @@ "type": "string" }, "com.amazonaws.applicationinsights#Status": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IGNORE", - "name": "IGNORE" - }, - { - "value": "RESOLVED", - "name": "RESOLVED" - }, - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "RECURRING", - "name": "RECURRING" + "type": "enum", + "members": { + "IGNORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IGNORE" + } + }, + "RESOLVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOLVED" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "RECURRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECURRING" + } + }, + "RECOVERING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECOVERING" } - ] + } } }, "com.amazonaws.applicationinsights#Tag": { @@ -3720,11 +4422,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#TagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.applicationinsights#TagValue": { "type": "string", @@ -3750,82 +4458,136 @@ } }, "com.amazonaws.applicationinsights#Tier": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CUSTOM", - "name": "CUSTOM" - }, - { - "value": "DEFAULT", - "name": "DEFAULT" - }, - { - "value": "DOT_NET_CORE", - "name": "DOT_NET_CORE" - }, - { - "value": "DOT_NET_WORKER", - "name": "DOT_NET_WORKER" - }, - { - "value": "DOT_NET_WEB_TIER", - "name": "DOT_NET_WEB_TIER" - }, - { - "value": "DOT_NET_WEB", - "name": "DOT_NET_WEB" - }, - { - "value": "SQL_SERVER", - "name": "SQL_SERVER" - }, - { - "value": "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP", - "name": "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP" - }, - { - "value": "MYSQL", - "name": "MYSQL" - }, - { - "value": "POSTGRESQL", - "name": "POSTGRESQL" - }, - { - "value": "JAVA_JMX", - "name": "JAVA_JMX" - }, - { - "value": "ORACLE", - "name": "ORACLE" - }, - { - "value": "SAP_HANA_MULTI_NODE", - "name": "SAP_HANA_MULTI_NODE" - }, - { - "value": "SAP_HANA_SINGLE_NODE", - "name": "SAP_HANA_SINGLE_NODE" - }, - { - "value": "SAP_HANA_HIGH_AVAILABILITY", - "name": "SAP_HANA_HIGH_AVAILABILITY" - }, - { - "value": "SQL_SERVER_FAILOVER_CLUSTER_INSTANCE", - "name": "SQL_SERVER_FAILOVER_CLUSTER_INSTANCE" - }, - { - "value": "SHAREPOINT", - "name": "SHAREPOINT" - }, - { - "value": "ACTIVE_DIRECTORY", - "name": "ACTIVE_DIRECTORY" + "type": "enum", + "members": { + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "DOT_NET_CORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOT_NET_CORE" + } + }, + "DOT_NET_WORKER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOT_NET_WORKER" + } + }, + "DOT_NET_WEB_TIER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOT_NET_WEB_TIER" + } + }, + "DOT_NET_WEB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOT_NET_WEB" + } + }, + "SQL_SERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_SERVER" + } + }, + "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP" + } + }, + "MYSQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MYSQL" + } + }, + "POSTGRESQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRESQL" + } + }, + "JAVA_JMX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JAVA_JMX" + } + }, + "ORACLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORACLE" + } + }, + "SAP_HANA_MULTI_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAP_HANA_MULTI_NODE" } - ], + }, + "SAP_HANA_SINGLE_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAP_HANA_SINGLE_NODE" + } + }, + "SAP_HANA_HIGH_AVAILABILITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAP_HANA_HIGH_AVAILABILITY" + } + }, + "SQL_SERVER_FAILOVER_CLUSTER_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_SERVER_FAILOVER_CLUSTER_INSTANCE" + } + }, + "SHAREPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHAREPOINT" + } + }, + "ACTIVE_DIRECTORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE_DIRECTORY" + } + }, + "SAP_NETWEAVER_STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAP_NETWEAVER_STANDARD" + } + }, + "SAP_NETWEAVER_DISTRIBUTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAP_NETWEAVER_DISTRIBUTED" + } + }, + "SAP_NETWEAVER_HIGH_AVAILABILITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAP_NETWEAVER_HIGH_AVAILABILITY" + } + } + }, + "traits": { "smithy.api#length": { "min": 1, "max": 50 @@ -3894,11 +4656,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#UntagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.applicationinsights#UpdateApplication": { "type": "operation", @@ -3963,6 +4731,9 @@ "smithy.api#documentation": "

Turns auto-configuration on or off.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#UpdateApplicationResponse": { @@ -3974,6 +4745,9 @@ "smithy.api#documentation": "

Information about the application.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.applicationinsights#UpdateComponent": { @@ -4066,11 +4840,17 @@ "smithy.api#documentation": "

Automatically configures the component by applying the recommended configurations.\n

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#UpdateComponentConfigurationResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.applicationinsights#UpdateComponentRequest": { "type": "structure", @@ -4101,11 +4881,17 @@ "smithy.api#documentation": "

The list of resource ARNs that belong to the component.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#UpdateComponentResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.applicationinsights#UpdateLogPattern": { "type": "operation", @@ -4170,6 +4956,9 @@ "smithy.api#documentation": "

Rank of the log pattern. Must be a value between 1 and\n 1,000,000. The patterns are sorted by rank, so we recommend that you set\n your highest priority patterns with the lowest rank. A pattern of rank 1 will\n be the first to get matched to a log line. A pattern of rank 1,000,000 will be\n last to get matched. When you configure custom log patterns from the console, a\n Low severity pattern translates to a 750,000 rank. A\n Medium severity pattern translates to a 500,000 rank. And a\n High severity pattern translates to a 250,000 rank. Rank\n values less than 1 or greater than 1,000,000 are reserved for\n AWS-provided patterns.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.applicationinsights#UpdateLogPatternResponse": { @@ -4187,6 +4976,155 @@ "smithy.api#documentation": "

The successfully created log pattern.

" } } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationinsights#UpdateProblem": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationinsights#UpdateProblemRequest" + }, + "output": { + "target": "com.amazonaws.applicationinsights#UpdateProblemResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationinsights#InternalServerException" + }, + { + "target": "com.amazonaws.applicationinsights#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.applicationinsights#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the visibility of the problem or specifies the problem as\n RESOLVED.

" + } + }, + "com.amazonaws.applicationinsights#UpdateProblemRequest": { + "type": "structure", + "members": { + "ProblemId": { + "target": "com.amazonaws.applicationinsights#ProblemId", + "traits": { + "smithy.api#documentation": "

The ID of the problem.

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

The status of the problem. Arguments can be passed for only problems that show a status\n of RECOVERING.

" + } + }, + "Visibility": { + "target": "com.amazonaws.applicationinsights#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of a problem. When you pass a value of IGNORED, the problem\n is removed from the default view, and all notifications for the problem are suspended. When\n VISIBLE is passed, the IGNORED action is reversed.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationinsights#UpdateProblemResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationinsights#UpdateStatus": { + "type": "enum", + "members": { + "RESOLVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOLVED" + } + } + } + }, + "com.amazonaws.applicationinsights#UpdateWorkload": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationinsights#UpdateWorkloadRequest" + }, + "output": { + "target": "com.amazonaws.applicationinsights#UpdateWorkloadResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationinsights#InternalServerException" + }, + { + "target": "com.amazonaws.applicationinsights#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.applicationinsights#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a workload to a component. Each component can have at most five workloads.

" + } + }, + "com.amazonaws.applicationinsights#UpdateWorkloadRequest": { + "type": "structure", + "members": { + "ResourceGroupName": { + "target": "com.amazonaws.applicationinsights#ResourceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the resource group.

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

The name of the component.

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

The ID of the workload.

" + } + }, + "WorkloadConfiguration": { + "target": "com.amazonaws.applicationinsights#WorkloadConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the workload. The value is the escaped JSON of the configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationinsights#UpdateWorkloadResponse": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.applicationinsights#WorkloadId", + "traits": { + "smithy.api#documentation": "

The ID of the workload.

" + } + }, + "WorkloadConfiguration": { + "target": "com.amazonaws.applicationinsights#WorkloadConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the workload. The value is the escaped JSON of the configuration.

" + } + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.applicationinsights#ValidationException": { @@ -4209,6 +5147,103 @@ "com.amazonaws.applicationinsights#Value": { "type": "double" }, + "com.amazonaws.applicationinsights#Visibility": { + "type": "enum", + "members": { + "IGNORED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IGNORED" + } + }, + "VISIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VISIBLE" + } + } + } + }, + "com.amazonaws.applicationinsights#Workload": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.applicationinsights#WorkloadId", + "traits": { + "smithy.api#documentation": "

The ID of the workload.

" + } + }, + "ComponentName": { + "target": "com.amazonaws.applicationinsights#ComponentName", + "traits": { + "smithy.api#documentation": "

The name of the component.

" + } + }, + "WorkloadName": { + "target": "com.amazonaws.applicationinsights#WorkloadName", + "traits": { + "smithy.api#documentation": "

The name of the workload.

" + } + }, + "Tier": { + "target": "com.amazonaws.applicationinsights#Tier", + "traits": { + "smithy.api#documentation": "

The tier of the workload.

" + } + }, + "WorkloadRemarks": { + "target": "com.amazonaws.applicationinsights#Remarks", + "traits": { + "smithy.api#documentation": "

If logging is supported for the resource type, shows whether the component has configured logs to be monitored.

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

Describes the workloads on a component.

" + } + }, + "com.amazonaws.applicationinsights#WorkloadConfiguration": { + "type": "structure", + "members": { + "WorkloadName": { + "target": "com.amazonaws.applicationinsights#WorkloadName", + "traits": { + "smithy.api#documentation": "

The name of the workload.

" + } + }, + "Tier": { + "target": "com.amazonaws.applicationinsights#Tier", + "traits": { + "smithy.api#documentation": "

The configuration of the workload tier.

" + } + }, + "Configuration": { + "target": "com.amazonaws.applicationinsights#ComponentConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the workload.

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

The configuration of the workload.

" + } + }, + "com.amazonaws.applicationinsights#WorkloadId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 38, + "max": 38 + }, + "smithy.api#pattern": "^w-[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" + } + }, + "com.amazonaws.applicationinsights#WorkloadList": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationinsights#Workload" + } + }, "com.amazonaws.applicationinsights#WorkloadMetaData": { "type": "map", "key": { @@ -4218,6 +5253,16 @@ "target": "com.amazonaws.applicationinsights#MetaDataValue" } }, + "com.amazonaws.applicationinsights#WorkloadName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\.\\-_]*$" + } + }, "com.amazonaws.applicationinsights#XRayErrorPercent": { "type": "integer" }, diff --git a/codegen/sdk/aws-models/auto-scaling.json b/codegen/sdk/aws-models/auto-scaling.json index 10d9f16c9791..014424840bc3 100644 --- a/codegen/sdk/aws-models/auto-scaling.json +++ b/codegen/sdk/aws-models/auto-scaling.json @@ -370,6 +370,26 @@ "smithy.api#documentation": "

Describes an alarm.

" } }, + "com.amazonaws.autoscaling#AlarmList": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" + } + }, + "com.amazonaws.autoscaling#AlarmSpecification": { + "type": "structure", + "members": { + "Alarms": { + "target": "com.amazonaws.autoscaling#AlarmList", + "traits": { + "smithy.api#documentation": "

The names of one or more CloudWatch alarms to monitor for the instance refresh. You can specify up to 10 alarms.

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

Specifies the CloudWatch alarm specification to use in an instance refresh.

" + } + }, "com.amazonaws.autoscaling#Alarms": { "type": "list", "member": { @@ -383,7 +403,7 @@ "min": 1, "max": 30 }, - "smithy.api#pattern": "^[a-zA-Z0-9\\.\\*]+$" + "smithy.api#pattern": "^[a-zA-Z0-9\\.\\*\\-]+$" } }, "com.amazonaws.autoscaling#AllowedInstanceTypes": { @@ -448,7 +468,19 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches one or more EC2 instances to the specified Auto Scaling group.

\n

When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the\n number of instances being attached. If the number of instances being attached plus the\n desired capacity of the group exceeds the maximum size of the group, the operation\n fails.

\n

If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are\n also registered with the load balancer. If there are target groups attached to your Auto Scaling\n group, the instances are also registered with the target groups.

\n

For more information, see Attach EC2 instances to\n your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Attaches one or more EC2 instances to the specified Auto Scaling group.

\n

When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the\n number of instances being attached. If the number of instances being attached plus the\n desired capacity of the group exceeds the maximum size of the group, the operation\n fails.

\n

If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are\n also registered with the load balancer. If there are target groups attached to your Auto Scaling\n group, the instances are also registered with the target groups.

\n

For more information, see Attach EC2 instances to\n your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To attach an instance to an Auto Scaling group", + "documentation": "This example attaches the specified instance to the specified Auto Scaling group.", + "input": { + "InstanceIds": [ + "i-93633f9b" + ], + "AutoScalingGroupName": "my-auto-scaling-group" + } + } + ] } }, "com.amazonaws.autoscaling#AttachInstancesQuery": { @@ -486,7 +518,19 @@ } ], "traits": { - "smithy.api#documentation": "\n

This API operation is superseded by AttachTrafficSources, which\n can attach multiple traffic sources types. We recommend using\n AttachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support AttachLoadBalancerTargetGroups. You can\n use both the original AttachLoadBalancerTargetGroups API operation and\n AttachTrafficSources on the same Auto Scaling group.

\n \n

Attaches one or more target groups to the specified Auto Scaling group.

\n

This operation is used with the following load balancer types:

\n \n

To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from\n the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.

\n

This operation is additive and does not detach existing target groups or Classic Load\n Balancers from the Auto Scaling group.

\n

For more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

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

This API operation is superseded by AttachTrafficSources, which\n can attach multiple traffic sources types. We recommend using\n AttachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support AttachLoadBalancerTargetGroups. You can\n use both the original AttachLoadBalancerTargetGroups API operation and\n AttachTrafficSources on the same Auto Scaling group.

\n \n

Attaches one or more target groups to the specified Auto Scaling group.

\n

This operation is used with the following load balancer types:

\n \n

To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from\n the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.

\n

This operation is additive and does not detach existing target groups or Classic Load\n Balancers from the Auto Scaling group.

\n

For more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To attach a target group to an Auto Scaling group", + "documentation": "This example attaches the specified target group to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TargetGroupARNs": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + ] + } + } + ] } }, "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsResultType": { @@ -529,7 +573,19 @@ } ], "traits": { - "smithy.api#documentation": "\n

This API operation is superseded by AttachTrafficSources, which\n can attach multiple traffic sources types. We recommend using\n AttachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support AttachLoadBalancers. You can use both\n the original AttachLoadBalancers API operation and\n AttachTrafficSources on the same Auto Scaling group.

\n \n

Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the\n running instances with these Classic Load Balancers.

\n

To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling\n group, call the DetachLoadBalancers API.

\n

This operation is additive and does not detach existing Classic Load Balancers or\n target groups from the Auto Scaling group.

\n

For more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

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

This API operation is superseded by AttachTrafficSources, which\n can attach multiple traffic sources types. We recommend using\n AttachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support AttachLoadBalancers. You can use both\n the original AttachLoadBalancers API operation and\n AttachTrafficSources on the same Auto Scaling group.

\n \n

Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the\n running instances with these Classic Load Balancers.

\n

To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling\n group, call the DetachLoadBalancers API.

\n

This operation is additive and does not detach existing Classic Load Balancers or\n target groups from the Auto Scaling group.

\n

For more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To attach a load balancer to an Auto Scaling group", + "documentation": "This example attaches the specified load balancer to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LoadBalancerNames": [ + "my-load-balancer" + ] + } + } + ] } }, "com.amazonaws.autoscaling#AttachLoadBalancersResultType": { @@ -572,7 +628,22 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches one or more traffic sources to the specified Auto Scaling group.

\n

You can use any of the following as traffic sources for an Auto Scaling group:

\n \n

This operation is additive and does not detach existing traffic sources from the Auto Scaling\n group.

\n

After the operation completes, use the DescribeTrafficSources API to\n return details about the state of the attachments between traffic sources and your Auto Scaling\n group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.

" + "smithy.api#documentation": "

Attaches one or more traffic sources to the specified Auto Scaling group.

\n

You can use any of the following as traffic sources for an Auto Scaling group:

\n \n

This operation is additive and does not detach existing traffic sources from the Auto Scaling\n group.

\n

After the operation completes, use the DescribeTrafficSources API to\n return details about the state of the attachments between traffic sources and your Auto Scaling\n group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.

", + "smithy.api#examples": [ + { + "title": "To attach a target group to an Auto Scaling group", + "documentation": "This example attaches the specified target group to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TrafficSources": [ + { + "Identifier": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + } + ] + }, + "output": {} + } + ] } }, "com.amazonaws.autoscaling#AttachTrafficSourcesResultType": { @@ -1281,52 +1352,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", @@ -1334,13 +1409,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -1350,92 +1434,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://autoscaling-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://autoscaling-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" + ] + } ] } ], @@ -1444,155 +1519,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://autoscaling.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://autoscaling-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] + "endpoint": { + "url": "https://autoscaling.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://autoscaling-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://autoscaling.{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://autoscaling.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://autoscaling.{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://autoscaling.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -2497,7 +2532,19 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels an instance refresh or rollback that is in progress. If an instance refresh or\n rollback is not in progress, an ActiveInstanceRefreshNotFound error\n occurs.

\n

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

\n

When you cancel an instance refresh, this does not roll back any changes that it made.\n Use the RollbackInstanceRefresh API to roll back instead.

" + "smithy.api#documentation": "

Cancels an instance refresh or rollback that is in progress. If an instance refresh or\n rollback is not in progress, an ActiveInstanceRefreshNotFound error\n occurs.

\n

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

\n

When you cancel an instance refresh, this does not roll back any changes that it made.\n Use the RollbackInstanceRefresh API to roll back instead.

", + "smithy.api#examples": [ + { + "title": "To cancel an instance refresh", + "documentation": "This example cancels an instance refresh operation in progress.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b" + } + } + ] } }, "com.amazonaws.autoscaling#CancelInstanceRefreshAnswer": { @@ -2583,7 +2630,19 @@ } ], "traits": { - "smithy.api#documentation": "

Completes the lifecycle action for the specified token or instance with the specified\n result.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    Create the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.

    \n
    5. \n
  5. \n

    If you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state.

    \n
    6. \n
  6. \n

    \n If you finish before the timeout period ends, send a\n callback by using the CompleteLifecycleAction API\n call.\n

    \n
    7. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Completes the lifecycle action for the specified token or instance with the specified\n result.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    Create the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.

    \n
    5. \n
  5. \n

    If you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state.

    \n
    6. \n
  6. \n

    \n If you finish before the timeout period ends, send a\n callback by using the CompleteLifecycleAction API\n call.\n

    \n
    7. \n
\n

For more information, see Complete a lifecycle\n action in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To complete the lifecycle action", + "documentation": "This example notifies Auto Scaling that the specified lifecycle action is complete so that it can finish launching or terminating the instance.", + "input": { + "LifecycleHookName": "my-lifecycle-hook", + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635", + "LifecycleActionResult": "CONTINUE" + } + } + ] } }, "com.amazonaws.autoscaling#CompleteLifecycleActionAnswer": { @@ -2686,7 +2745,25 @@ } ], "traits": { - "smithy.api#documentation": "

\n We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n

\n

Creates an Auto Scaling group with the specified name and attributes.

\n

If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

For introductory exercises for creating an Auto Scaling group, see Getting started with\n Amazon EC2 Auto Scaling and Tutorial: Set up a\n scaled and load-balanced application in the\n Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling\n groups in the Amazon EC2 Auto Scaling User Guide.

\n

Every Auto Scaling group has three size properties (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.

" + "smithy.api#documentation": "

\n We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n

\n

Creates an Auto Scaling group with the specified name and attributes.

\n

If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

For introductory exercises for creating an Auto Scaling group, see Getting started with\n Amazon EC2 Auto Scaling and Tutorial: Set up a\n scaled and load-balanced application in the\n Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling\n groups in the Amazon EC2 Auto Scaling User Guide.

\n

Every Auto Scaling group has three size properties (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.

", + "smithy.api#examples": [ + { + "title": "To create an Auto Scaling group", + "documentation": "This example creates an Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LaunchTemplate": { + "LaunchTemplateName": "my-template-for-auto-scaling", + "Version": "$Default" + }, + "MinSize": 1, + "MaxSize": 3, + "MaxInstanceLifetime": 2592000, + "DefaultInstanceWarmup": 120, + "VPCZoneIdentifier": "subnet-057fa0918fEXAMPLE" + } + } + ] } }, "com.amazonaws.autoscaling#CreateAutoScalingGroupType": { @@ -2879,7 +2956,22 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a launch configuration.

\n

If you exceed your maximum limit of launch configurations, the call fails. To query\n this limit, call the DescribeAccountLimits API. For information about\n updating this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

For more information, see Launch\n configurations in the Amazon EC2 Auto Scaling User Guide.

\n \n

Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a\n launch template or a launch configuration. We strongly recommend that you do not use\n launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2.\n For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.

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

Creates a launch configuration.

\n

If you exceed your maximum limit of launch configurations, the call fails. To query\n this limit, call the DescribeAccountLimits API. For information about\n updating this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

For more information, see Launch\n configurations in the Amazon EC2 Auto Scaling User Guide.

\n \n

Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a\n launch template or a launch configuration. We strongly recommend that you do not use\n launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2.\n For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To create a launch configuration", + "documentation": "This example creates a launch configuration.", + "input": { + "LaunchConfigurationName": "my-launch-config", + "ImageId": "ami-12345678", + "SecurityGroups": [ + "sg-eb2af88e" + ], + "InstanceType": "m3.medium", + "IamInstanceProfile": "my-iam-role" + } + } + ] } }, "com.amazonaws.autoscaling#CreateLaunchConfigurationType": { @@ -3025,7 +3117,31 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates tags for the specified Auto Scaling group.

\n

When you specify a tag with a key that already exists, the operation overwrites the\n previous tag definition, and you do not get an error message.

\n

For more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Creates or updates tags for the specified Auto Scaling group.

\n

When you specify a tag with a key that already exists, the operation overwrites the\n previous tag definition, and you do not get an error message.

\n

For more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To create or update tags for an Auto Scaling group", + "documentation": "This example adds two tags to the specified Auto Scaling group.", + "input": { + "Tags": [ + { + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Key": "Role", + "Value": "WebServer", + "PropagateAtLaunch": true + }, + { + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Key": "Dept", + "Value": "Research", + "PropagateAtLaunch": true + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#CreateOrUpdateTagsType": { @@ -3107,7 +3223,16 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified Auto Scaling group.

\n

If the group has instances or scaling activities in progress, you must specify the\n option to force the deletion in order for it to succeed. The force delete operation will\n also terminate the EC2 instances. If the group has a warm pool, the force delete option\n also deletes the warm pool.

\n

To remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to\n decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement\n instances.

\n

To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity\n of the Auto Scaling group to\n zero.

\n

If the group has scaling policies, deleting the group deletes the policies, the\n underlying alarm actions, and any alarm that no longer has an associated action.

\n

For more information, see Delete your Auto Scaling\n infrastructure in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Deletes the specified Auto Scaling group.

\n

If the group has instances or scaling activities in progress, you must specify the\n option to force the deletion in order for it to succeed. The force delete operation will\n also terminate the EC2 instances. If the group has a warm pool, the force delete option\n also deletes the warm pool.

\n

To remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to\n decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement\n instances.

\n

To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity\n of the Auto Scaling group to\n zero.

\n

If the group has scaling policies, deleting the group deletes the policies, the\n underlying alarm actions, and any alarm that no longer has an associated action.

\n

For more information, see Delete your Auto Scaling\n infrastructure in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To delete an Auto Scaling group", + "documentation": "This example deletes the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + } + } + ] } }, "com.amazonaws.autoscaling#DeleteAutoScalingGroupType": { @@ -3145,7 +3270,16 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified launch configuration.

\n

The launch configuration must not be attached to an Auto Scaling group. When this call\n completes, the launch configuration is no longer available for use.

" + "smithy.api#documentation": "

Deletes the specified launch configuration.

\n

The launch configuration must not be attached to an Auto Scaling group. When this call\n completes, the launch configuration is no longer available for use.

", + "smithy.api#examples": [ + { + "title": "To delete a launch configuration", + "documentation": "This example deletes the specified launch configuration.", + "input": { + "LaunchConfigurationName": "my-launch-config" + } + } + ] } }, "com.amazonaws.autoscaling#DeleteLifecycleHook": { @@ -3162,7 +3296,17 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified lifecycle hook.

\n

If there are any outstanding lifecycle actions, they are completed first\n (ABANDON for launching instances, CONTINUE for terminating\n instances).

" + "smithy.api#documentation": "

Deletes the specified lifecycle hook.

\n

If there are any outstanding lifecycle actions, they are completed first\n (ABANDON for launching instances, CONTINUE for terminating\n instances).

", + "smithy.api#examples": [ + { + "title": "To delete a lifecycle hook", + "documentation": "This example deletes the specified lifecycle hook.", + "input": { + "LifecycleHookName": "my-lifecycle-hook", + "AutoScalingGroupName": "my-auto-scaling-group" + } + } + ] } }, "com.amazonaws.autoscaling#DeleteLifecycleHookAnswer": { @@ -3202,7 +3346,17 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified notification.

" + "smithy.api#documentation": "

Deletes the specified notification.

", + "smithy.api#examples": [ + { + "title": "To delete an Auto Scaling notification", + "documentation": "This example deletes the specified notification from the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" + } + } + ] } }, "com.amazonaws.autoscaling#DeleteNotificationConfigurationType": { @@ -3241,7 +3395,17 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified scaling policy.

\n

Deleting either a step scaling policy or a simple scaling policy deletes the\n underlying alarm action, but does not delete the alarm, even if it no longer has an\n associated action.

\n

For more information, see Deleting a scaling\n policy in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Deletes the specified scaling policy.

\n

Deleting either a step scaling policy or a simple scaling policy deletes the\n underlying alarm action, but does not delete the alarm, even if it no longer has an\n associated action.

\n

For more information, see Deleting a scaling\n policy in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To delete an Auto Scaling policy", + "documentation": "This example deletes the specified Auto Scaling policy.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyName": "my-step-scale-out-policy" + } + } + ] } }, "com.amazonaws.autoscaling#DeletePolicyType": { @@ -3276,7 +3440,17 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified scheduled action.

" + "smithy.api#documentation": "

Deletes the specified scheduled action.

", + "smithy.api#examples": [ + { + "title": "To delete a scheduled action from an Auto Scaling group", + "documentation": "This example deletes the specified scheduled action from the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ScheduledActionName": "my-scheduled-action" + } + } + ] } }, "com.amazonaws.autoscaling#DeleteScheduledActionType": { @@ -3315,7 +3489,23 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified tags.

" + "smithy.api#documentation": "

Deletes the specified tags.

", + "smithy.api#examples": [ + { + "title": "To delete a tag from an Auto Scaling group", + "documentation": "This example deletes the specified tag from the specified Auto Scaling group.", + "input": { + "Tags": [ + { + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Key": "Dept", + "Value": "Research" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#DeleteTagsType": { @@ -3392,7 +3582,19 @@ } ], "traits": { - "smithy.api#documentation": "

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

\n

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

" + "smithy.api#documentation": "

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

\n

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

", + "smithy.api#examples": [ + { + "title": "To describe your Auto Scaling account limits", + "documentation": "This example describes the Amazon EC2 Auto Scaling service quotas for your account.", + "output": { + "MaxNumberOfAutoScalingGroups": 20, + "MaxNumberOfLaunchConfigurations": 100, + "NumberOfAutoScalingGroups": 3, + "NumberOfLaunchConfigurations": 5 + } + } + ] } }, "com.amazonaws.autoscaling#DescribeAccountLimitsAnswer": { @@ -3438,7 +3640,26 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the available adjustment types for step scaling and simple scaling\n policies.

\n

The following adjustment types are supported:

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

Describes the available adjustment types for step scaling and simple scaling\n policies.

\n

The following adjustment types are supported:

\n ", + "smithy.api#examples": [ + { + "title": "To describe the Amazon EC2 Auto Scaling adjustment types", + "documentation": "This example describes the available adjustment types.", + "output": { + "AdjustmentTypes": [ + { + "AdjustmentType": "ChangeInCapacity" + }, + { + "AdjustmentType": "ExactCapcity" + }, + { + "AdjustmentType": "PercentChangeInCapacity" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#DescribeAdjustmentTypesAnswer": { @@ -3470,6 +3691,70 @@ ], "traits": { "smithy.api#documentation": "

Gets information about the Auto Scaling groups in the account and Region.

\n

If you specify Auto Scaling group names, the output includes information for only the\n specified Auto Scaling groups. If you specify filters, the output includes information for only\n those Auto Scaling groups that meet the filter criteria. If you do not specify group names or\n filters, the output includes information for all Auto Scaling groups.

\n

This operation also returns information about instances in Auto Scaling groups. To retrieve\n information about the instances in a warm pool, you must call the DescribeWarmPool API.

", + "smithy.api#examples": [ + { + "title": "To describe an Auto Scaling group", + "documentation": "This example describes the specified Auto Scaling group.", + "input": { + "AutoScalingGroupNames": [ + "my-auto-scaling-group" + ] + }, + "output": { + "AutoScalingGroups": [ + { + "AutoScalingGroupName": "my-auto-scaling-group", + "AutoScalingGroupARN": "arn:aws:autoscaling:us-west-1:123456789012:autoScalingGroup:12345678-1234-1234-1234-123456789012:autoScalingGroupName/my-auto-scaling-group", + "LaunchConfigurationName": "my-launch-config", + "MinSize": 1, + "MaxSize": 5, + "DesiredCapacity": 2, + "DefaultCooldown": 300, + "AvailabilityZones": [ + "us-west-2a", + "us-west-2b", + "us-west-2c" + ], + "LoadBalancerNames": [], + "TargetGroupARNs": [], + "HealthCheckType": "EC2", + "HealthCheckGracePeriod": 300, + "Instances": [ + { + "ProtectedFromScaleIn": false, + "AvailabilityZone": "us-west-2c", + "LaunchConfigurationName": "my-launch-config", + "InstanceId": "i-05b4f7d5be44822a6", + "InstanceType": "t3.micro", + "HealthStatus": "Healthy", + "LifecycleState": "InService" + }, + { + "ProtectedFromScaleIn": false, + "AvailabilityZone": "us-west-2b", + "LaunchConfigurationName": "my-launch-config", + "InstanceId": "i-0c20ac468fa3049e8", + "InstanceType": "t3.micro", + "HealthStatus": "Healthy", + "LifecycleState": "InService" + } + ], + "CreatedTime": "2023-03-09T22:15:11.611Z", + "SuspendedProcesses": [], + "VPCZoneIdentifier": "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782", + "EnabledMetrics": [], + "Tags": [], + "TerminationPolicies": [ + "Default" + ], + "NewInstancesProtectedFromScaleIn": false, + "ServiceLinkedRoleARN": "arn:aws:iam::123456789012:role/aws-service-role/autoscaling.amazonaws.com/AWSServiceRoleForAutoScaling", + "TrafficSources": [] + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3573,6 +3858,31 @@ ], "traits": { "smithy.api#documentation": "

Gets information about the Auto Scaling instances in the account and Region.

", + "smithy.api#examples": [ + { + "title": "To describe one or more Auto Scaling instances", + "documentation": "This example describes the specified Auto Scaling instance.", + "input": { + "InstanceIds": [ + "i-05b4f7d5be44822a6" + ] + }, + "output": { + "AutoScalingInstances": [ + { + "ProtectedFromScaleIn": false, + "AvailabilityZone": "us-west-2c", + "LaunchConfigurationName": "my-launch-config", + "InstanceId": "i-05b4f7d5be44822a6", + "InstanceType": "t3.micro", + "AutoScalingGroupName": "my-auto-scaling-group", + "HealthStatus": "HEALTHY", + "LifecycleState": "InService" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3618,7 +3928,22 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the notification types that are supported by Amazon EC2 Auto Scaling.

" + "smithy.api#documentation": "

Describes the notification types that are supported by Amazon EC2 Auto Scaling.

", + "smithy.api#examples": [ + { + "title": "To describe the Auto Scaling notification types", + "documentation": "This example describes the available notification types.", + "output": { + "AutoScalingNotificationTypes": [ + "autoscaling:EC2_INSTANCE_LAUNCH", + "autoscaling:EC2_INSTANCE_LAUNCH_ERROR", + "autoscaling:EC2_INSTANCE_TERMINATE", + "autoscaling:EC2_INSTANCE_TERMINATE_ERROR", + "autoscaling:TEST_NOTIFICATION" + ] + } + } + ] } }, "com.amazonaws.autoscaling#DescribeAutoScalingNotificationTypesAnswer": { @@ -3717,6 +4042,37 @@ ], "traits": { "smithy.api#documentation": "

Gets information about the launch configurations in the account and Region.

", + "smithy.api#examples": [ + { + "title": "To describe Auto Scaling launch configurations", + "documentation": "This example describes the specified launch configuration.", + "input": { + "LaunchConfigurationNames": [ + "my-launch-config" + ] + }, + "output": { + "LaunchConfigurations": [ + { + "EbsOptimized": false, + "LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config", + "InstanceMonitoring": { + "Enabled": true + }, + "ImageId": "ami-043a5034", + "CreatedTime": "2014-05-07T17:39:28.599Z", + "BlockDeviceMappings": [], + "SecurityGroups": [ + "sg-67ef0308" + ], + "LaunchConfigurationName": "my-launch-config", + "InstanceType": "t1.micro", + "AssociatePublicIpAddress": true + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3739,7 +4095,19 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the available types of lifecycle hooks.

\n

The following hook types are supported:

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

Describes the available types of lifecycle hooks.

\n

The following hook types are supported:

\n ", + "smithy.api#examples": [ + { + "title": "To describe the available types of lifecycle hooks", + "documentation": "This example describes the available lifecycle hook types.", + "output": { + "LifecycleHookTypes": [ + "autoscaling:EC2_INSTANCE_LAUNCHING", + "autoscaling:EC2_INSTANCE_TERMINATING" + ] + } + } + ] } }, "com.amazonaws.autoscaling#DescribeLifecycleHookTypesAnswer": { @@ -3767,7 +4135,30 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the lifecycle hooks for the specified Auto Scaling group.

" + "smithy.api#documentation": "

Gets information about the lifecycle hooks for the specified Auto Scaling group.

", + "smithy.api#examples": [ + { + "title": "To describe your lifecycle hooks", + "documentation": "This example describes the lifecycle hooks for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "LifecycleHooks": [ + { + "GlobalTimeout": 172800, + "HeartbeatTimeout": 3600, + "RoleARN": "arn:aws:iam::123456789012:role/my-auto-scaling-role", + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleHookName": "my-lifecycle-hook", + "DefaultResult": "ABANDON", + "NotificationTargetARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic", + "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#DescribeLifecycleHooksAnswer": { @@ -3816,7 +4207,24 @@ } ], "traits": { - "smithy.api#documentation": "\n

This API operation is superseded by DescribeTrafficSources,\n which can describe multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DescribeLoadBalancerTargetGroups. You\n can use both the original DescribeLoadBalancerTargetGroups API\n operation and DescribeTrafficSources on the same Auto Scaling group.

\n \n

Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.

\n

To determine the attachment status of the target group, use the State\n element in the response. When you attach a target group to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the target group. If\n Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and\n replace any instances that are reported as unhealthy. If no registered instances pass\n the health checks, the target group doesn't enter the InService state.

\n

Target groups also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your target group state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.

\n

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

You can use this operation to describe target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.

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

This API operation is superseded by DescribeTrafficSources,\n which can describe multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DescribeLoadBalancerTargetGroups. You\n can use both the original DescribeLoadBalancerTargetGroups API\n operation and DescribeTrafficSources on the same Auto Scaling group.

\n \n

Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.

\n

To determine the attachment status of the target group, use the State\n element in the response. When you attach a target group to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the target group. If\n Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and\n replace any instances that are reported as unhealthy. If no registered instances pass\n the health checks, the target group doesn't enter the InService state.

\n

Target groups also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your target group state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.

\n

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

You can use this operation to describe target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.

\n ", + "smithy.api#examples": [ + { + "title": "To describe the target groups for an Auto Scaling group", + "documentation": "This example describes the target groups attached to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "LoadBalancerTargetGroups": [ + { + "LoadBalancerTargetGroupARN": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "State": "Added" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroupsRequest": { @@ -3883,7 +4291,24 @@ } ], "traits": { - "smithy.api#documentation": "\n

This API operation is superseded by DescribeTrafficSources,\n which can describe multiple traffic sources types. We recommend using\n DescribeTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DescribeLoadBalancers. You can use both\n the original DescribeLoadBalancers API operation and\n DescribeTrafficSources on the same Auto Scaling group.

\n \n

Gets information about the load balancers for the specified Auto Scaling group.

\n

This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the\n DescribeLoadBalancerTargetGroups API instead.

\n

To determine the attachment status of the load balancer, use the State\n element in the response. When you attach a load balancer to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the load balancer.\n If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate\n and replace any instances that are reported as unhealthy. If no registered instances\n pass the health checks, the load balancer doesn't enter the InService\n state.

\n

Load balancers also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your load balancer state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.

\n

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

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

This API operation is superseded by DescribeTrafficSources,\n which can describe multiple traffic sources types. We recommend using\n DescribeTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DescribeLoadBalancers. You can use both\n the original DescribeLoadBalancers API operation and\n DescribeTrafficSources on the same Auto Scaling group.

\n \n

Gets information about the load balancers for the specified Auto Scaling group.

\n

This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the\n DescribeLoadBalancerTargetGroups API instead.

\n

To determine the attachment status of the load balancer, use the State\n element in the response. When you attach a load balancer to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the load balancer.\n If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate\n and replace any instances that are reported as unhealthy. If no registered instances\n pass the health checks, the load balancer doesn't enter the InService\n state.

\n

Load balancers also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your load balancer state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.

\n

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe the load balancers for an Auto Scaling group", + "documentation": "This example describes the load balancers attached to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "LoadBalancers": [ + { + "State": "Added", + "LoadBalancerName": "my-load-balancer" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#DescribeLoadBalancersRequest": { @@ -3947,7 +4372,46 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

" + "smithy.api#documentation": "

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

", + "smithy.api#examples": [ + { + "title": "To describe the Auto Scaling metric collection types", + "documentation": "This example describes the available metric collection types.", + "output": { + "Metrics": [ + { + "Metric": "GroupMinSize" + }, + { + "Metric": "GroupMaxSize" + }, + { + "Metric": "GroupDesiredCapacity" + }, + { + "Metric": "GroupInServiceInstances" + }, + { + "Metric": "GroupPendingInstances" + }, + { + "Metric": "GroupTerminatingInstances" + }, + { + "Metric": "GroupStandbyInstances" + }, + { + "Metric": "GroupTotalInstances" + } + ], + "Granularities": [ + { + "Granularity": "1Minute" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#DescribeMetricCollectionTypesAnswer": { @@ -3985,6 +4449,31 @@ ], "traits": { "smithy.api#documentation": "

Gets information about the Amazon SNS notifications that are configured for one or more\n Auto Scaling groups.

", + "smithy.api#examples": [ + { + "title": "To describe Auto Scaling notification configurations", + "documentation": "This example describes the notification configurations for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupNames": [ + "my-auto-scaling-group" + ] + }, + "output": { + "NotificationConfigurations": [ + { + "AutoScalingGroupName": "my-auto-scaling-group", + "NotificationType": "autoscaling:TEST_NOTIFICATION", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2" + }, + { + "AutoScalingGroupName": "my-auto-scaling-group", + "NotificationType": "autoscaling:TEST_NOTIFICATION", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4055,6 +4544,37 @@ ], "traits": { "smithy.api#documentation": "

Gets information about the scaling policies in the account and Region.

", + "smithy.api#examples": [ + { + "title": "To describe scaling policies", + "documentation": "This example describes the policies for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "ScalingPolicies": [ + { + "PolicyName": "ScaleIn", + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn", + "AdjustmentType": "ChangeInCapacity", + "Alarms": [], + "ScalingAdjustment": -1 + }, + { + "PolicyName": "ScalePercentChange", + "MinAdjustmentStep": 2, + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2b435159-cf77-4e89-8c0e-d63b497baad7:autoScalingGroupName/my-auto-scaling-group:policyName/ScalePercentChange", + "Cooldown": 60, + "AdjustmentType": "PercentChangeInCapacity", + "Alarms": [], + "ScalingAdjustment": 25 + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4116,6 +4636,31 @@ ], "traits": { "smithy.api#documentation": "

Gets information about the scaling activities in the account and Region.

\n

When scaling events occur, you see a record of the scaling activity in the scaling\n activities. For more information, see Verifying a scaling\n activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

\n

If the scaling event succeeds, the value of the StatusCode element in the\n response is Successful. If an attempt to launch instances failed, the\n StatusCode value is Failed or Cancelled and\n the StatusMessage element in the response indicates the cause of the\n failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe the scaling activities for an Auto Scaling group", + "documentation": "This example describes the scaling activities for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "Activities": [ + { + "Description": "Launching a new EC2 instance: i-4ba0837f", + "AutoScalingGroupName": "my-auto-scaling-group", + "ActivityId": "f9f2d65b-f1f2-43e7-b46d-d86756459699", + "Details": "details", + "StartTime": "2013-08-19T20:53:29.930Z", + "Progress": 100, + "EndTime": "2013-08-19T20:54:02Z", + "Cause": "At 2013-08-19T20:53:25Z a user request created an AutoScalingGroup changing the desired capacity from 0 to 1. At 2013-08-19T20:53:29Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 1.", + "StatusCode": "Successful", + "AutoScalingGroupARN": "arn:aws:autoscaling:us-east-1:123456789012:autoScalingGroup:12345678-1234-1234-1234-123456789012:autoScalingGroupName/my-auto-scaling-group" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4173,7 +4718,41 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the scaling process types for use with the ResumeProcesses\n and SuspendProcesses APIs.

" + "smithy.api#documentation": "

Describes the scaling process types for use with the ResumeProcesses\n and SuspendProcesses APIs.

", + "smithy.api#examples": [ + { + "title": "To describe the Auto Scaling process types", + "documentation": "This example describes the Auto Scaling process types.", + "output": { + "Processes": [ + { + "ProcessName": "AZRebalance" + }, + { + "ProcessName": "AddToLoadBalancer" + }, + { + "ProcessName": "AlarmNotification" + }, + { + "ProcessName": "HealthCheck" + }, + { + "ProcessName": "Launch" + }, + { + "ProcessName": "ReplaceUnhealthy" + }, + { + "ProcessName": "ScheduledActions" + }, + { + "ProcessName": "Terminate" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#DescribeScheduledActions": { @@ -4194,6 +4773,30 @@ ], "traits": { "smithy.api#documentation": "

Gets information about the scheduled actions that haven't run or that have not reached\n their end time.

\n

To describe the scaling activities for scheduled actions that have already run, call\n the DescribeScalingActivities API.

", + "smithy.api#examples": [ + { + "title": "To describe scheduled actions", + "documentation": "This example describes the scheduled actions for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "ScheduledUpdateGroupActions": [ + { + "MinSize": 2, + "DesiredCapacity": 4, + "AutoScalingGroupName": "my-auto-scaling-group", + "MaxSize": 6, + "Recurrence": "30 0 1 12 0", + "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action", + "ScheduledActionName": "my-scheduled-action", + "StartTime": "2016-12-01T00:30:00Z", + "Time": "2016-12-01T00:30:00Z" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4261,6 +4864,40 @@ ], "traits": { "smithy.api#documentation": "

Describes the specified tags.

\n

You can use filters to limit the results. For example, you can query for the tags for\n a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at\n least one of the specified values for it to be included in the results.

\n

You can also specify multiple filters. The result includes information for a\n particular tag only if it matches all the filters. If there's no match, no special\n message is returned.

\n

For more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe tags", + "documentation": "This example describes the tags for the specified Auto Scaling group.", + "input": { + "Filters": [ + { + "Values": [ + "my-auto-scaling-group" + ], + "Name": "auto-scaling-group" + } + ] + }, + "output": { + "Tags": [ + { + "ResourceType": "auto-scaling-group", + "ResourceId": "my-auto-scaling-group", + "PropagateAtLaunch": true, + "Value": "Research", + "Key": "Dept" + }, + { + "ResourceType": "auto-scaling-group", + "ResourceId": "my-auto-scaling-group", + "PropagateAtLaunch": true, + "Value": "WebServer", + "Key": "Role" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4306,7 +4943,22 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the termination policies supported by Amazon EC2 Auto Scaling.

\n

For more information, see Work with\n Amazon EC2 Auto Scaling termination policies in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Describes the termination policies supported by Amazon EC2 Auto Scaling.

\n

For more information, see Work with\n Amazon EC2 Auto Scaling termination policies in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe termination policy types", + "documentation": "This example describes the available termination policy types.", + "output": { + "TerminationPolicyTypes": [ + "ClosestToNextInstanceHour", + "Default", + "NewestInstance", + "OldestInstance", + "OldestLaunchConfiguration" + ] + } + } + ] } }, "com.amazonaws.autoscaling#DescribeTerminationPolicyTypesAnswer": { @@ -4338,6 +4990,25 @@ ], "traits": { "smithy.api#documentation": "

Gets information about the traffic sources for the specified Auto Scaling group.

\n

You can optionally provide a traffic source type. If you provide a traffic source\n type, then the results only include that traffic source type.

\n

If you do not provide a traffic source type, then the results include all the traffic\n sources for the specified Auto Scaling group.

", + "smithy.api#examples": [ + { + "title": "To describe the target groups for an Auto Scaling group", + "documentation": "This example describes the target groups attached to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "TrafficSources": [ + { + "Identifier": "arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-0e2f2665eEXAMPLE", + "State": "InService", + "Type": "vpc-lattice" + } + ], + "NextToken": "" + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4418,7 +5089,13 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a warm pool and its instances.

\n

For more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Gets information about a warm pool and its instances.

\n

For more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Instances", + "pageSize": "MaxRecords" + } } }, "com.amazonaws.autoscaling#DescribeWarmPoolAnswer": { @@ -4502,7 +5179,34 @@ } ], "traits": { - "smithy.api#documentation": "

Removes one or more instances from the specified Auto Scaling group.

\n

After the instances are detached, you can manage them independent of the Auto Scaling\n group.

\n

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are detached.

\n

If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are\n deregistered from the load balancer. If there are target groups attached to the Auto Scaling\n group, the instances are deregistered from the target groups.

\n

For more information, see Detach EC2 instances from\n your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Removes one or more instances from the specified Auto Scaling group.

\n

After the instances are detached, you can manage them independent of the Auto Scaling\n group.

\n

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are detached.

\n

If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are\n deregistered from the load balancer. If there are target groups attached to the Auto Scaling\n group, the instances are deregistered from the target groups.

\n

For more information, see Detach EC2 instances from\n your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To detach an instance from an Auto Scaling group", + "documentation": "This example detaches the specified instance from the specified Auto Scaling group.", + "input": { + "InstanceIds": [ + "i-93633f9b" + ], + "AutoScalingGroupName": "my-auto-scaling-group", + "ShouldDecrementDesiredCapacity": true + }, + "output": { + "Activities": [ + { + "Description": "Detaching EC2 instance: i-93633f9b", + "AutoScalingGroupName": "my-auto-scaling-group", + "ActivityId": "5091cb52-547a-47ce-a236-c9ccbc2cb2c9", + "Details": "details", + "StartTime": "2015-04-12T15:02:16.179Z", + "Progress": 50, + "Cause": "At 2015-04-12T15:02:16Z instance i-93633f9b was detached in response to a user request, shrinking the capacity from 2 to 1.", + "StatusCode": "InProgress" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#DetachInstancesAnswer": { @@ -4555,7 +5259,19 @@ } ], "traits": { - "smithy.api#documentation": "\n

This API operation is superseded by DetachTrafficSources, which\n can detach multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DetachLoadBalancerTargetGroups. You can\n use both the original DetachLoadBalancerTargetGroups API operation and\n DetachTrafficSources on the same Auto Scaling group.

\n \n

Detaches one or more target groups from the specified Auto Scaling group.

\n

When you detach a target group, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain\n running.

\n \n

You can use this operation to detach target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.

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

This API operation is superseded by DetachTrafficSources, which\n can detach multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DetachLoadBalancerTargetGroups. You can\n use both the original DetachLoadBalancerTargetGroups API operation and\n DetachTrafficSources on the same Auto Scaling group.

\n \n

Detaches one or more target groups from the specified Auto Scaling group.

\n

When you detach a target group, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain\n running.

\n \n

You can use this operation to detach target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.

\n ", + "smithy.api#examples": [ + { + "title": "To detach a target group from an Auto Scaling group", + "documentation": "This example detaches the specified target group from the specified Auto Scaling group", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TargetGroupARNs": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + ] + } + } + ] } }, "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroupsResultType": { @@ -4595,7 +5311,19 @@ } ], "traits": { - "smithy.api#documentation": "\n

This API operation is superseded by DetachTrafficSources, which\n can detach multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DetachLoadBalancers. You can use both\n the original DetachLoadBalancers API operation and\n DetachTrafficSources on the same Auto Scaling group.

\n \n

Detaches one or more Classic Load Balancers from the specified Auto Scaling group.

\n

This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or\n Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.

\n

When you detach a load balancer, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.

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

This API operation is superseded by DetachTrafficSources, which\n can detach multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DetachLoadBalancers. You can use both\n the original DetachLoadBalancers API operation and\n DetachTrafficSources on the same Auto Scaling group.

\n \n

Detaches one or more Classic Load Balancers from the specified Auto Scaling group.

\n

This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or\n Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.

\n

When you detach a load balancer, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.

", + "smithy.api#examples": [ + { + "title": "To detach a load balancer from an Auto Scaling group", + "documentation": "This example detaches the specified load balancer from the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LoadBalancerNames": [ + "my-load-balancer" + ] + } + } + ] } }, "com.amazonaws.autoscaling#DetachLoadBalancersResultType": { @@ -4635,7 +5363,22 @@ } ], "traits": { - "smithy.api#documentation": "

Detaches one or more traffic sources from the specified Auto Scaling group.

\n

When you detach a taffic, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the traffic source using the DescribeTrafficSources API call. The instances continue to run.

" + "smithy.api#documentation": "

Detaches one or more traffic sources from the specified Auto Scaling group.

\n

When you detach a traffic source, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the traffic source using the DescribeTrafficSources API call. The instances continue to run.

", + "smithy.api#examples": [ + { + "title": "To detach a target group from an Auto Scaling group", + "documentation": "This example detaches the specified target group from the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TrafficSources": [ + { + "Identifier": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + } + ] + }, + "output": {} + } + ] } }, "com.amazonaws.autoscaling#DetachTrafficSourcesResultType": { @@ -4675,7 +5418,19 @@ } ], "traits": { - "smithy.api#documentation": "

Disables group metrics collection for the specified Auto Scaling group.

" + "smithy.api#documentation": "

Disables group metrics collection for the specified Auto Scaling group.

", + "smithy.api#examples": [ + { + "title": "To disable metrics collection for an Auto Scaling group", + "documentation": "This example disables collecting data for the GroupDesiredCapacity metric for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "Metrics": [ + "GroupDesiredCapacity" + ] + } + } + ] } }, "com.amazonaws.autoscaling#DisableMetricsCollectionQuery": { @@ -4766,7 +5521,17 @@ } ], "traits": { - "smithy.api#documentation": "

Enables group metrics collection for the specified Auto Scaling group.

\n

You can use these metrics to track changes in an Auto Scaling group and to set alarms on\n threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch\n console. For more information, see Monitor\n CloudWatch metrics for your Auto Scaling groups and instances in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Enables group metrics collection for the specified Auto Scaling group.

\n

You can use these metrics to track changes in an Auto Scaling group and to set alarms on\n threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch\n console. For more information, see Monitor\n CloudWatch metrics for your Auto Scaling groups and instances in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To enable metrics collection for an Auto Scaling group", + "documentation": "This example enables data collection for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "Granularity": "1Minute" + } + } + ] } }, "com.amazonaws.autoscaling#EnableMetricsCollectionQuery": { @@ -4834,7 +5599,34 @@ } ], "traits": { - "smithy.api#documentation": "

Moves the specified instances into the standby state.

\n

If you choose to decrement the desired capacity of the Auto Scaling group, the instances can\n enter standby as long as the desired capacity of the Auto Scaling group after the instances are\n placed into standby is equal to or greater than the minimum capacity of the\n group.

\n

If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group\n launches new instances to replace the instances on standby.

\n

For more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Moves the specified instances into the standby state.

\n

If you choose to decrement the desired capacity of the Auto Scaling group, the instances can\n enter standby as long as the desired capacity of the Auto Scaling group after the instances are\n placed into standby is equal to or greater than the minimum capacity of the\n group.

\n

If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group\n launches new instances to replace the instances on standby.

\n

For more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To move instances into standby mode", + "documentation": "This example puts the specified instance into standby mode.", + "input": { + "InstanceIds": [ + "i-93633f9b" + ], + "AutoScalingGroupName": "my-auto-scaling-group", + "ShouldDecrementDesiredCapacity": true + }, + "output": { + "Activities": [ + { + "Description": "Moving EC2 instance to Standby: i-93633f9b", + "AutoScalingGroupName": "my-auto-scaling-group", + "ActivityId": "ffa056b4-6ed3-41ba-ae7c-249dfae6eba1", + "Details": "details", + "StartTime": "2015-04-12T15:10:23.640Z", + "Progress": 50, + "Cause": "At 2015-04-12T15:10:23Z instance i-93633f9b was moved to standby in response to a user request, shrinking the capacity from 2 to 1.", + "StatusCode": "InProgress" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#EnterStandbyAnswer": { @@ -4883,7 +5675,7 @@ "min": 1, "max": 30 }, - "smithy.api#pattern": "^[a-zA-Z0-9\\.\\*]+$" + "smithy.api#pattern": "^[a-zA-Z0-9\\.\\*\\-]+$" } }, "com.amazonaws.autoscaling#ExcludedInstanceTypes": { @@ -4915,7 +5707,19 @@ } ], "traits": { - "smithy.api#documentation": "

Executes the specified policy. This can be useful for testing the design of your\n scaling policy.

" + "smithy.api#documentation": "

Executes the specified policy. This can be useful for testing the design of your\n scaling policy.

", + "smithy.api#examples": [ + { + "title": "To execute a scaling policy", + "documentation": "This example executes the specified policy.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyName": "my-step-scale-out-policy", + "BreachThreshold": 50.0, + "MetricValue": 59.0 + } + } + ] } }, "com.amazonaws.autoscaling#ExecutePolicyType": { @@ -4968,7 +5772,33 @@ } ], "traits": { - "smithy.api#documentation": "

Moves the specified instances out of the standby state.

\n

After you put the instances back in service, the desired capacity is\n incremented.

\n

For more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Moves the specified instances out of the standby state.

\n

After you put the instances back in service, the desired capacity is\n incremented.

\n

For more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To move instances out of standby mode", + "documentation": "This example moves the specified instance out of standby mode.", + "input": { + "InstanceIds": [ + "i-93633f9b" + ], + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "Activities": [ + { + "Description": "Moving EC2 instance out of Standby: i-93633f9b", + "AutoScalingGroupName": "my-auto-scaling-group", + "ActivityId": "142928e1-a2dc-453a-9b24-b85ad6735928", + "Details": "details", + "StartTime": "2015-04-12T15:14:29.886Z", + "Progress": 30, + "Cause": "At 2015-04-12T15:14:29Z instance i-93633f9b was moved out of standby in response to a user request, increasing the capacity from 1 to 2.", + "StatusCode": "PreInService" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#ExitStandbyAnswer": { @@ -7553,7 +8383,20 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a lifecycle hook for the specified Auto Scaling group.

\n

Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance\n lifecycle, and then perform a custom action on instances when the corresponding\n lifecycle event occurs.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    \n Create the lifecycle hook. Specify whether the hook is\n used when the instances launch or terminate.\n

    \n
    5. \n
  5. \n

    If you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state using the RecordLifecycleActionHeartbeat API call.

    \n
    6. \n
  6. \n

    If you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.

    \n
    7. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling\n group, the call fails.

\n

You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle\n hook, you can delete it by calling the DeleteLifecycleHook API.

" + "smithy.api#documentation": "

Creates or updates a lifecycle hook for the specified Auto Scaling group.

\n

Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance\n lifecycle, and then perform a custom action on instances when the corresponding\n lifecycle event occurs.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    \n Create the lifecycle hook. Specify whether the hook is\n used when the instances launch or terminate.\n

    \n
    5. \n
  5. \n

    If you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state using the RecordLifecycleActionHeartbeat API call.

    \n
    6. \n
  6. \n

    If you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.

    \n
    7. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling\n group, the call fails.

\n

You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle\n hook, you can delete it by calling the DeleteLifecycleHook API.

", + "smithy.api#examples": [ + { + "title": "To create a launch lifecycle hook", + "documentation": "This example creates a lifecycle hook for instance launch.", + "input": { + "LifecycleHookName": "my-launch-lifecycle-hook", + "HeartbeatTimeout": 300, + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING", + "DefaultResult": "CONTINUE" + } + } + ] } }, "com.amazonaws.autoscaling#PutLifecycleHookAnswer": { @@ -7635,7 +8478,20 @@ } ], "traits": { - "smithy.api#documentation": "

Configures an Auto Scaling group to send notifications when specified events take place.\n Subscribers to the specified topic can have messages delivered to an endpoint such as a\n web server or an email address.

\n

This configuration overwrites any existing configuration.

\n

For more information, see Getting Amazon SNS\n notifications when your Auto Scaling group scales in the\n Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call\n fails.

" + "smithy.api#documentation": "

Configures an Auto Scaling group to send notifications when specified events take place.\n Subscribers to the specified topic can have messages delivered to an endpoint such as a\n web server or an email address.

\n

This configuration overwrites any existing configuration.

\n

For more information, see Getting Amazon SNS\n notifications when your Auto Scaling group scales in the\n Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call\n fails.

", + "smithy.api#examples": [ + { + "title": "To add an Auto Scaling notification", + "documentation": "This example adds the specified notification to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic", + "NotificationTypes": [ + "autoscaling:TEST_NOTIFICATION" + ] + } + } + ] } }, "com.amazonaws.autoscaling#PutNotificationConfigurationType": { @@ -7684,7 +8540,38 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to\n scale an Auto Scaling group based on configurable metrics. If no policies are defined, the\n dynamic scaling and predictive scaling features are not used.

\n

For more information about using dynamic scaling, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.

\n

For more information about using predictive scaling, see Predictive\n scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy,\n you can delete it by calling the DeletePolicy API.

" + "smithy.api#documentation": "

Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to\n scale an Auto Scaling group based on configurable metrics. If no policies are defined, the\n dynamic scaling and predictive scaling features are not used.

\n

For more information about using dynamic scaling, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.

\n

For more information about using predictive scaling, see Predictive\n scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy,\n you can delete it by calling the DeletePolicy API.

", + "smithy.api#examples": [ + { + "title": "To add a scaling policy to an Auto Scaling group", + "documentation": "This example adds the specified policy to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyName": "alb1000-target-tracking-scaling-policy", + "PolicyType": "TargetTrackingScaling", + "TargetTrackingConfiguration": { + "TargetValue": 1000.0, + "PredefinedMetricSpecification": { + "PredefinedMetricType": "ALBRequestCountPerTarget", + "ResourceLabel": "app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff" + } + } + }, + "output": { + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:228f02c2-c665-4bfd-aaac-8b04080bea3c:autoScalingGroupName/my-auto-scaling-group:policyName/alb1000-target-tracking-scaling-policy", + "Alarms": [ + { + "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e", + "AlarmName": "TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e" + }, + { + "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2", + "AlarmName": "TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2" + } + ] + } + } + ] } }, "com.amazonaws.autoscaling#PutScalingPolicyType": { @@ -7731,7 +8618,7 @@ "ScalingAdjustment": { "target": "com.amazonaws.autoscaling#PolicyIncrement", "traits": { - "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity.\n For exact capacity, you must specify a positive value.

\n

Required if the policy type is SimpleScaling. (Not used with any other\n policy type.)

" + "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity.\n For exact capacity, you must specify a non-negative value.

\n

Required if the policy type is SimpleScaling. (Not used with any other\n policy type.)

" } }, "Cooldown": { @@ -7798,7 +8685,22 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a scheduled scaling action for an Auto Scaling group.

\n

For more information, see Scheduled scaling in the\n Amazon EC2 Auto Scaling User Guide.

\n

You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a\n scheduled action, you can delete it by calling the DeleteScheduledAction API.

\n

If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error\n message.

" + "smithy.api#documentation": "

Creates or updates a scheduled scaling action for an Auto Scaling group.

\n

For more information, see Scheduled scaling in the\n Amazon EC2 Auto Scaling User Guide.

\n

You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a\n scheduled action, you can delete it by calling the DeleteScheduledAction API.

\n

If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error\n message.

", + "smithy.api#examples": [ + { + "title": "To add a scheduled action to an Auto Scaling group", + "documentation": "This example adds the specified scheduled action to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ScheduledActionName": "my-scheduled-action", + "StartTime": "2014-05-12T08:00:00Z", + "EndTime": "2014-05-12T08:00:00Z", + "MinSize": 2, + "MaxSize": 6, + "DesiredCapacity": 4 + } + } + ] } }, "com.amazonaws.autoscaling#PutScheduledUpdateGroupActionType": { @@ -7885,7 +8787,21 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of\n pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your\n application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new\n desired capacity. For more information and example configurations, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

This operation must be called from the Region in which the Auto Scaling group was created.\n This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a\n launch template or launch configuration that requests Spot Instances.

\n

You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the\n DeleteWarmPool API.

" + "smithy.api#documentation": "

Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of\n pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your\n application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new\n desired capacity. For more information and example configurations, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

This operation must be called from the Region in which the Auto Scaling group was created.\n This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a\n launch template or launch configuration that requests Spot Instances.

\n

You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the\n DeleteWarmPool API.

", + "smithy.api#examples": [ + { + "title": "To create a warm pool for an Auto Scaling group", + "documentation": "This example creates a warm pool for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "MinSize": 30, + "PoolState": "Hibernated", + "InstanceReusePolicy": { + "ReuseOnScaleIn": true + } + } + } + ] } }, "com.amazonaws.autoscaling#PutWarmPoolAnswer": { @@ -7942,7 +8858,18 @@ } ], "traits": { - "smithy.api#documentation": "

Records a heartbeat for the lifecycle action associated with the specified token or\n instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    Create the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.

    \n
    5. \n
  5. \n

    \n If you need more time, record the lifecycle action\n heartbeat to keep the instance in a wait state.\n

    \n
    6. \n
  6. \n

    If you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.

    \n
    7. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Records a heartbeat for the lifecycle action associated with the specified token or\n instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    Create the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.

    \n
    5. \n
  5. \n

    \n If you need more time, record the lifecycle action\n heartbeat to keep the instance in a wait state.\n

    \n
    6. \n
  6. \n

    If you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.

    \n
    7. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To record a lifecycle action heartbeat", + "documentation": "This example records a lifecycle action heartbeat to keep the instance in a pending state.", + "input": { + "LifecycleHookName": "my-lifecycle-hook", + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635" + } + } + ] } }, "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeatAnswer": { @@ -8024,7 +8951,7 @@ "AutoRollback": { "target": "com.amazonaws.autoscaling#AutoRollback", "traits": { - "smithy.api#documentation": "

(Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration\n if the instance refresh fails. The default is false.

\n

A rollback is not supported in the following situations:

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

(Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration\n if the instance refresh fails or a CloudWatch alarm threshold is met. The default is\n false.

\n

A rollback is not supported in the following situations:

\n \n

For more information, see Undo changes with a\n rollback in the Amazon EC2 Auto Scaling User Guide.

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

Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in Standby\n state are found.

\n

The following lists the valid values:

\n
\n
Terminate
\n
\n

Amazon EC2 Auto Scaling terminates instances that are in Standby.

\n
\n
Ignore
\n
\n

Amazon EC2 Auto Scaling ignores instances that are in Standby and continues\n to replace instances that are in the InService state.

\n
\n
Wait (default)
\n
\n

Amazon EC2 Auto Scaling waits one hour for you to return the instances to service.\n Otherwise, the instance refresh will fail.

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

(Optional) The CloudWatch alarm specification. CloudWatch alarms can be used to identify any\n issues and fail the operation if an alarm threshold is met.

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

Resumes the specified suspended auto scaling processes, or all suspended process, for\n the specified Auto Scaling group.

\n

For more information, see Suspending and\n resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Resumes the specified suspended auto scaling processes, or all suspended process, for\n the specified Auto Scaling group.

\n

For more information, see Suspending and\n resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To resume Auto Scaling processes", + "documentation": "This example resumes the specified suspended scaling process for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ScalingProcesses": [ + "AlarmNotification" + ] + } + } + ] } }, "com.amazonaws.autoscaling#ReturnData": { @@ -8212,7 +9157,8 @@ "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

" + "smithy.api#documentation": "

The name of the Auto Scaling group.

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

Sets the size of the specified Auto Scaling group.

\n

If a scale-in activity occurs as a result of a new DesiredCapacity value\n that is lower than the current size of the group, the Auto Scaling group uses its termination\n policy to determine which instances to terminate.

\n

For more information, see Manual scaling in the\n Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Sets the size of the specified Auto Scaling group.

\n

If a scale-in activity occurs as a result of a new DesiredCapacity value\n that is lower than the current size of the group, the Auto Scaling group uses its termination\n policy to determine which instances to terminate.

\n

For more information, see Manual scaling in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To set the desired capacity for an Auto Scaling group", + "documentation": "This example sets the desired capacity for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "DesiredCapacity": 2, + "HonorCooldown": true + } + } + ] } }, "com.amazonaws.autoscaling#SetDesiredCapacityType": { @@ -8722,7 +9679,17 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the health status of the specified instance.

\n

For more information, see Health checks for Auto Scaling\n instances in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Sets the health status of the specified instance.

\n

For more information, see Health checks for Auto Scaling\n instances in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To set the health status of an instance", + "documentation": "This example sets the health status of the specified instance to Unhealthy.", + "input": { + "InstanceId": "i-93633f9b", + "HealthStatus": "Unhealthy" + } + } + ] } }, "com.amazonaws.autoscaling#SetInstanceHealthQuery": { @@ -8767,7 +9734,20 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the instance protection settings of the specified instances. This operation\n cannot be called on instances in a warm pool.

\n

For more information about preventing instances that are part of an Auto Scaling group from\n terminating on scale in, see Using\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call\n fails.

" + "smithy.api#documentation": "

Updates the instance protection settings of the specified instances. This operation\n cannot be called on instances in a warm pool.

\n

For more information about preventing instances that are part of an Auto Scaling group from\n terminating on scale in, see Using\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call\n fails.

", + "smithy.api#examples": [ + { + "title": "To enable instance protection for an instance", + "documentation": "This example enables instance protection for the specified instance.", + "input": { + "InstanceIds": [ + "i-93633f9b" + ], + "AutoScalingGroupName": "my-auto-scaling-group", + "ProtectedFromScaleIn": true + } + } + ] } }, "com.amazonaws.autoscaling#SetInstanceProtectionAnswer": { @@ -8864,7 +9844,35 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an instance refresh. During an instance refresh, Amazon EC2 Auto Scaling performs a rolling\n update of instances in an Auto Scaling group. Instances are terminated first and then replaced,\n which temporarily reduces the capacity available within your Auto Scaling group.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group.\n This feature is helpful, for example, when you have a new AMI or a new user data script.\n You just need to create a new launch template that specifies the new AMI or user data\n script. Then start an instance refresh to immediately begin the process of updating\n instances in the group.

\n

If successful, the request's response contains a unique ID that you can use to track\n the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that\n have already run, call the DescribeInstanceRefreshes API. To cancel an\n instance refresh that is in progress, use the CancelInstanceRefresh\n API.

\n

An instance refresh might fail for several reasons, such as EC2 launch failures,\n misconfigured health checks, or not ignoring or allowing the termination of instances\n that are in Standby state or protected from scale in. You can monitor for\n failed EC2 launches using the scaling activities. To find the scaling activities, call\n the DescribeScalingActivities API.

\n

If you enable auto rollback, your Auto Scaling group will be rolled back automatically when\n the instance refresh fails. You can enable this feature before starting an instance\n refresh by specifying the AutoRollback property in the instance refresh\n preferences. Otherwise, to roll back an instance refresh before it finishes, use the\n RollbackInstanceRefresh API.

" + "smithy.api#documentation": "

Starts an instance refresh. During an instance refresh, Amazon EC2 Auto Scaling performs a rolling\n update of instances in an Auto Scaling group. Instances are terminated first and then replaced,\n which temporarily reduces the capacity available within your Auto Scaling group.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group.\n This feature is helpful, for example, when you have a new AMI or a new user data script.\n You just need to create a new launch template that specifies the new AMI or user data\n script. Then start an instance refresh to immediately begin the process of updating\n instances in the group.

\n

If successful, the request's response contains a unique ID that you can use to track\n the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that\n have already run, call the DescribeInstanceRefreshes API. To cancel an\n instance refresh that is in progress, use the CancelInstanceRefresh\n API.

\n

An instance refresh might fail for several reasons, such as EC2 launch failures,\n misconfigured health checks, or not ignoring or allowing the termination of instances\n that are in Standby state or protected from scale in. You can monitor for\n failed EC2 launches using the scaling activities. To find the scaling activities, call\n the DescribeScalingActivities API.

\n

If you enable auto rollback, your Auto Scaling group will be rolled back automatically when\n the instance refresh fails. You can enable this feature before starting an instance\n refresh by specifying the AutoRollback property in the instance refresh\n preferences. Otherwise, to roll back an instance refresh before it finishes, use the\n RollbackInstanceRefresh API.

", + "smithy.api#examples": [ + { + "title": "To start an instance refresh", + "documentation": "This example starts an instance refresh for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "DesiredConfiguration": { + "LaunchTemplate": { + "LaunchTemplateName": "my-template-for-auto-scaling", + "Version": "$Latest" + } + }, + "Preferences": { + "AutoRollback": true, + "AlarmSpecification": { + "Alarms": [ + "my-alarm" + ] + }, + "InstanceWarmup": 200, + "MinHealthyPercentage": 90 + } + }, + "output": { + "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b" + } + } + ] } }, "com.amazonaws.autoscaling#StartInstanceRefreshAnswer": { @@ -8903,7 +9911,7 @@ "Preferences": { "target": "com.amazonaws.autoscaling#RefreshPreferences", "traits": { - "smithy.api#documentation": "

Sets your preferences for the instance refresh so that it performs as expected when\n you start it. Includes the instance warmup time, the minimum healthy percentage, and the\n behaviors that you want Amazon EC2 Auto Scaling to use if instances that are in Standby\n state or protected from scale in are found. You can also choose to enable additional\n features, such as the following:

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

Sets your preferences for the instance refresh so that it performs as expected when\n you start it. Includes the instance warmup time, the minimum healthy percentage, and the\n behaviors that you want Amazon EC2 Auto Scaling to use if instances that are in Standby\n state or protected from scale in are found. You can also choose to enable additional\n features, such as the following:

\n " } } } @@ -8926,7 +9934,7 @@ "ScalingAdjustment": { "target": "com.amazonaws.autoscaling#PolicyIncrement", "traits": { - "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current\n capacity.

\n

The amount by which to scale. The adjustment is based on the value that you specified\n in the AdjustmentType property (either an absolute number or a percentage).\n A positive value adds to the current capacity and a negative number subtracts from the\n current capacity.

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

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity.\n For exact capacity, you must specify a non-negative value.

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

Suspends the specified auto scaling processes, or all processes, for the specified\n Auto Scaling group.

\n

If you suspend either the Launch or Terminate process types,\n it can prevent other process types from functioning properly. For more information, see\n Suspending and\n resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.

\n

To resume processes that have been suspended, call the ResumeProcesses API.

" + "smithy.api#documentation": "

Suspends the specified auto scaling processes, or all processes, for the specified\n Auto Scaling group.

\n

If you suspend either the Launch or Terminate process types,\n it can prevent other process types from functioning properly. For more information, see\n Suspending and\n resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.

\n

To resume processes that have been suspended, call the ResumeProcesses API.

", + "smithy.api#examples": [ + { + "title": "To suspend Auto Scaling processes", + "documentation": "This example suspends the specified scaling process for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ScalingProcesses": [ + "AlarmNotification" + ] + } + } + ] } }, "com.amazonaws.autoscaling#SuspendedProcess": { @@ -9242,7 +10262,17 @@ } ], "traits": { - "smithy.api#documentation": "

Terminates the specified instance and optionally adjusts the desired group size. This\n operation cannot be called on instances in a warm pool.

\n

This call simply makes a termination request. The instance is not terminated\n immediately. When an instance is terminated, the instance status changes to\n terminated. You can't connect to or start an instance after you've\n terminated it.

\n

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are terminated.

\n

By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you\n decrement the desired capacity, your Auto Scaling group can become unbalanced between\n Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might\n terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

Terminates the specified instance and optionally adjusts the desired group size. This\n operation cannot be called on instances in a warm pool.

\n

This call simply makes a termination request. The instance is not terminated\n immediately. When an instance is terminated, the instance status changes to\n terminated. You can't connect to or start an instance after you've\n terminated it.

\n

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are terminated.

\n

By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you\n decrement the desired capacity, your Auto Scaling group can become unbalanced between\n Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might\n terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To terminate an instance in an Auto Scaling group", + "documentation": "This example terminates the specified instance from the specified Auto Scaling group without updating the size of the group. Auto Scaling launches a replacement instance after the specified instance terminates.", + "input": { + "InstanceId": "i-93633f9b", + "ShouldDecrementDesiredCapacity": false + } + } + ] } }, "com.amazonaws.autoscaling#TerminateInstanceInAutoScalingGroupType": { @@ -9381,7 +10411,23 @@ } ], "traits": { - "smithy.api#documentation": "

\n We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n

\n

Updates the configuration for the specified Auto Scaling group.

\n

To update an Auto Scaling group, specify the name of the group and the property that you want\n to change. Any properties that you don't specify are not changed by this update request.\n The new settings take effect on any scaling activities after this call returns.\n

\n

If you associate a new launch configuration or template with an Auto Scaling group, all new\n instances will get the updated configuration. Existing instances continue to run with\n the configuration that they were originally launched with. When you update a group to\n specify a mixed instances policy instead of a launch configuration or template, existing\n instances may be replaced to match the new purchasing options that you specified in the\n policy. For example, if the group currently has 100% On-Demand capacity and the policy\n specifies 50% Spot capacity, this means that half of your instances will be gradually\n terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches\n new instances before terminating the old ones, so that updating your group does not\n compromise the performance or availability of your application.

\n

Note the following about changing DesiredCapacity, MaxSize,\n or MinSize:

\n \n

To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling\n group, call the DescribePolicies API. If the group has scaling\n policies, you can update them by calling the PutScalingPolicy\n API.

" + "smithy.api#documentation": "

\n We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n

\n

Updates the configuration for the specified Auto Scaling group.

\n

To update an Auto Scaling group, specify the name of the group and the property that you want\n to change. Any properties that you don't specify are not changed by this update request.\n The new settings take effect on any scaling activities after this call returns.\n

\n

If you associate a new launch configuration or template with an Auto Scaling group, all new\n instances will get the updated configuration. Existing instances continue to run with\n the configuration that they were originally launched with. When you update a group to\n specify a mixed instances policy instead of a launch configuration or template, existing\n instances may be replaced to match the new purchasing options that you specified in the\n policy. For example, if the group currently has 100% On-Demand capacity and the policy\n specifies 50% Spot capacity, this means that half of your instances will be gradually\n terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches\n new instances before terminating the old ones, so that updating your group does not\n compromise the performance or availability of your application.

\n

Note the following about changing DesiredCapacity, MaxSize,\n or MinSize:

\n \n

To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling\n group, call the DescribePolicies API. If the group has scaling\n policies, you can update them by calling the PutScalingPolicy\n API.

", + "smithy.api#examples": [ + { + "title": "To update an Auto Scaling group", + "documentation": "This example updates multiple properties at the same time.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LaunchTemplate": { + "LaunchTemplateName": "my-template-for-auto-scaling", + "Version": "2" + }, + "MinSize": 1, + "MaxSize": 5, + "NewInstancesProtectedFromScaleIn": true + } + } + ] } }, "com.amazonaws.autoscaling#UpdateAutoScalingGroupType": { diff --git a/codegen/sdk/aws-models/backup.json b/codegen/sdk/aws-models/backup.json index 4cb3041c689c..81f96384ced3 100644 --- a/codegen/sdk/aws-models/backup.json +++ b/codegen/sdk/aws-models/backup.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.

\n

During 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).

" + "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.

\n

This parameter has a maximum value of 100 years (52,560,000 minutes).

\n

During 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).

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

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

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “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.

\n

Resource 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.

\n

Backups 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.

\n

Resource 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.

\n

This 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.

\n

This request includes a name, optionally one or more resource tags, an encryption key, \n and a request ID.

\n \n

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

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/logically-air-gapped-backup-vaults/{BackupVaultName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#CreateLogicallyAirGappedBackupVaultInput": { + "type": "structure", + "members": { + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", + "traits": { + "smithy.api#documentation": "

This 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.

\n

If 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).

\n

If 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.

\n

This 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.

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

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.

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

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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.backup#ListProtectedResourcesInput": { "type": "structure", "members": { @@ -7194,6 +7445,13 @@ "smithy.api#required": {} } }, + "BackupVaultAccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "

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.

\n

During 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).

" + "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.

\n

This parameter has a maximum value of 100 years (52,560,000 minutes).

\n

During 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).

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

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.

" + "smithy.api#documentation": "

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.

\n

Like StartWindowMinutes, this parameter has a maximum value of \n 100 years (52,560,000 minutes).

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

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

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “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.

\n

Resource 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.

\n

Backups 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.

\n

Resource 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.

\n

This 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/aws-models/batch.json b/codegen/sdk/aws-models/batch.json index 614ca37b605c..bf3755b26af5 100644 --- a/codegen/sdk/aws-models/batch.json +++ b/codegen/sdk/aws-models/batch.json @@ -1473,6 +1473,12 @@ "traits": { "smithy.api#enumValue": "SPOT_CAPACITY_OPTIMIZED" } + }, + "SPOT_PRICE_CAPACITY_OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPOT_PRICE_CAPACITY_OPTIMIZED" + } } } }, @@ -1519,6 +1525,12 @@ "traits": { "smithy.api#enumValue": "SPOT_CAPACITY_OPTIMIZED" } + }, + "SPOT_PRICE_CAPACITY_OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPOT_PRICE_CAPACITY_OPTIMIZED" + } } } }, @@ -1737,7 +1749,7 @@ "allocationStrategy": { "target": "com.amazonaws.batch#CRAllocationStrategy", "traits": { - "smithy.api#documentation": "

The allocation strategy to use for the compute resource if not enough instances of the best\n fitting instance type can be allocated. This might be because of availability of the instance\n type in the Region or Amazon EC2 service limits. For more\n information, see Allocation strategies in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

\n \n
\n
BEST_FIT (default)
\n
\n

Batch selects an instance type that best fits the needs of the jobs with a preference\n for the lowest-cost instance type. If additional instances of the selected instance type\n aren't available, Batch waits for the additional instances to be available. If there aren't\n enough instances available or the user is reaching Amazon EC2 service limits,\n additional jobs aren't run until the currently running jobs are completed. This allocation\n strategy keeps costs lower but can limit scaling. If you're using Spot Fleets with\n BEST_FIT, the Spot Fleet IAM Role must be specified. Compute resources that use\n a BEST_FIT allocation strategy don't support infrastructure updates and can't\n update some parameters. For more information, see Updating compute environments in\n the Batch User Guide.

\n
\n
BEST_FIT_PROGRESSIVE
\n
\n

Batch selects additional instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If\n additional instances of the previously selected instance types aren't available, Batch\n selects new instance types.

\n
\n
SPOT_CAPACITY_OPTIMIZED
\n
\n

Batch selects one or more instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types that are less likely to be\n interrupted. This allocation strategy is only available for Spot Instance compute\n resources.

\n
\n
\n

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED\n strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot\n Instances, Batch might need to exceed maxvCpus to meet your capacity requirements.\n In this event, Batch never exceeds maxvCpus by more than a single instance.

" + "smithy.api#documentation": "

The allocation strategy to use for the compute resource if not enough instances of the best\n fitting instance type can be allocated. This might be because of availability of the instance\n type in the Region or Amazon EC2 service limits. For more\n information, see Allocation strategies in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

\n \n
\n
BEST_FIT (default)
\n
\n

Batch selects an instance type that best fits the needs of the jobs with a preference\n for the lowest-cost instance type. If additional instances of the selected instance type\n aren't available, Batch waits for the additional instances to be available. If there aren't\n enough instances available or the user is reaching Amazon EC2 service limits,\n additional jobs aren't run until the currently running jobs are completed. This allocation\n strategy keeps costs lower but can limit scaling. If you're using Spot Fleets with\n BEST_FIT, the Spot Fleet IAM Role must be specified. Compute resources that use\n a BEST_FIT allocation strategy don't support infrastructure updates and can't\n update some parameters. For more information, see Updating compute environments in\n the Batch User Guide.

\n
\n
BEST_FIT_PROGRESSIVE
\n
\n

Batch selects additional instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If\n additional instances of the previously selected instance types aren't available, Batch\n selects new instance types.

\n
\n
SPOT_CAPACITY_OPTIMIZED
\n
\n

Batch selects one or more instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types that are less likely to be\n interrupted. This allocation strategy is only available for Spot Instance compute\n resources.

\n
\n
SPOT_PRICE_CAPACITY_OPTIMIZED
\n
\n

The price and capacity optimized allocation strategy looks at both price and capacity to\n select the Spot Instance pools that are the least likely to be interrupted and have the lowest\n possible price. This allocation strategy is only available for Spot Instance compute\n resources.

\n
\n
\n

With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED\n strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot\n Instances, Batch might need to exceed maxvCpus to meet your capacity requirements.\n In this event, Batch never exceeds maxvCpus by more than a single instance.

" } }, "minvCpus": { @@ -1749,7 +1761,7 @@ "maxvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of\n vCPUs that a\n compute environment can\n support.

\n \n

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED\n allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy\n using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity\n requirements. In this event, Batch never exceeds maxvCpus by more than a single\n instance. For example, no more than a single instance from among those specified in your compute\n environment is allocated.

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

The maximum number of\n vCPUs that a\n compute environment can\n support.

\n \n

With BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED\n allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy\n using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity\n requirements. In this event, Batch never exceeds maxvCpus by more than a single\n instance. For example, no more than a single instance from among those specified in your compute\n environment is allocated.

\n ", "smithy.api#required": {} } }, @@ -1852,7 +1864,7 @@ "maxvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of Amazon EC2 vCPUs that an environment can reach.

\n \n

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED\n allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy\n using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity\n requirements. In this event, Batch never exceeds maxvCpus by more than a single\n instance. That is, no more than a single instance from among those specified in your compute\n environment.

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

The maximum number of Amazon EC2 vCPUs that an environment can reach.

\n \n

With BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED, and SPOT_PRICE_CAPACITY_OPTIMIZED\n allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy\n using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity\n requirements. In this event, Batch never exceeds maxvCpus by more than a single\n instance. That is, no more than a single instance from among those specified in your compute\n environment.

\n " } }, "desiredvCpus": { @@ -1876,7 +1888,7 @@ "allocationStrategy": { "target": "com.amazonaws.batch#CRUpdateAllocationStrategy", "traits": { - "smithy.api#documentation": "

The allocation strategy to use for the compute resource if there's not enough instances of\n the best fitting instance type that can be allocated. This might be because of availability of\n the instance type in the Region or Amazon EC2 service limits. For more\n information, see Allocation strategies in the Batch User Guide.

\n

When updating a compute environment, changing the allocation strategy requires an\n infrastructure update of the compute environment. For more information, see Updating compute\n environments in the Batch User Guide. BEST_FIT isn't\n supported when updating a compute environment.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

\n \n
\n
BEST_FIT_PROGRESSIVE
\n
\n

Batch selects additional instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If\n additional instances of the previously selected instance types aren't available, Batch\n selects new instance types.

\n
\n
SPOT_CAPACITY_OPTIMIZED
\n
\n

Batch selects one or more instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types that are less likely to be\n interrupted. This allocation strategy is only available for Spot Instance compute\n resources.

\n
\n
\n

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED\n strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot\n Instances, Batch might need to exceed maxvCpus to meet your capacity requirements.\n In this event, Batch never exceeds maxvCpus by more than a single instance.

" + "smithy.api#documentation": "

The allocation strategy to use for the compute resource if there's not enough instances of\n the best fitting instance type that can be allocated. This might be because of availability of\n the instance type in the Region or Amazon EC2 service limits. For more\n information, see Allocation strategies in the Batch User Guide.

\n

When updating a compute environment, changing the allocation strategy requires an\n infrastructure update of the compute environment. For more information, see Updating compute\n environments in the Batch User Guide. BEST_FIT isn't\n supported when updating a compute environment.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

\n \n
\n
BEST_FIT_PROGRESSIVE
\n
\n

Batch selects additional instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If\n additional instances of the previously selected instance types aren't available, Batch\n selects new instance types.

\n
\n
SPOT_CAPACITY_OPTIMIZED
\n
\n

Batch selects one or more instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types that are less likely to be\n interrupted. This allocation strategy is only available for Spot Instance compute\n resources.

\n
\n
SPOT_PRICE_CAPACITY_OPTIMIZED
\n
\n

The price and capacity optimized allocation strategy looks at both price and capacity to\n select the Spot Instance pools that are the least likely to be interrupted and have the lowest\n possible price. This allocation strategy is only available for Spot Instance compute\n resources.

\n
\n
\n

With both BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED, and SPOT_PRICE_CAPACITY_OPTIMIZED\n strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot\n Instances, Batch might need to exceed maxvCpus to meet your capacity requirements.\n In this event, Batch never exceeds maxvCpus by more than a single instance.

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

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

\n

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

\n \n

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

\n \n

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

\n \n

To create a compute environment that uses EKS resources, the caller must have permissions to call\n eks:DescribeCluster.

\n \n \n

Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it\n also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is\n available. You're responsible for the management of the guest operating system. This includes any updates and\n security patches. You're also responsible for any additional application software or utilities that you install on\n the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete\n these steps:

\n
    \n
  1. \n

    Create a new compute environment with the new AMI.

    \n
    2. \n
  2. \n

    Add the compute environment to an existing job queue.

    \n
    3. \n
  3. \n

    Remove the earlier compute environment from your job queue.

    \n
    4. \n
  4. \n

    Delete the earlier compute environment.

    \n
    5. \n
\n

In April 2022, Batch added enhanced support for updating compute environments. For more information, see\n Updating compute\n environments. To use the enhanced updating of compute environments to update AMIs, follow these\n rules:

\n \n

If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be\n re-selected. If the version setting in the launch template (launchTemplate) is set to\n $Latest or $Default, the latest or default version of the launch template is evaluated up\n at the time of the infrastructure update, even if the launchTemplate wasn't updated.

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

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

\n

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

\n \n

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

\n \n

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

\n \n

To create a compute environment that uses EKS resources, the caller must have permissions to call\n eks:DescribeCluster.

\n \n \n

Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it\n also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is\n available. You're responsible for the management of the guest operating system. This includes any updates and\n security patches. You're also responsible for any additional application software or utilities that you install on\n the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete\n these steps:

\n
    \n
  1. \n

    Create a new compute environment with the new AMI.

    \n
    2. \n
  2. \n

    Add the compute environment to an existing job queue.

    \n
    3. \n
  3. \n

    Remove the earlier compute environment from your job queue.

    \n
    4. \n
  4. \n

    Delete the earlier compute environment.

    \n
    5. \n
\n

In April 2022, Batch added enhanced support for updating compute environments. For more information, see\n Updating compute\n environments. To use the enhanced updating of compute environments to update AMIs, follow these\n rules:

\n \n

If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be\n re-selected. If the version setting in the launch template (launchTemplate) is set to\n $Latest or $Default, the latest or default version of the launch template is evaluated up\n at the time of the infrastructure update, even if the launchTemplate wasn't updated.

\n ", "smithy.api#http": { "method": "POST", "uri": "/v1/createcomputeenvironment", @@ -5784,7 +5796,7 @@ "cpuArchitecture": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The vCPU architecture. The default value is X86_64. Valid values are X86_64 and \n ARM64.

\n \n

This parameter must be set to\n X86_64\n for Windows containers.

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

The vCPU architecture. The default value is X86_64. Valid values are\n X86_64 and ARM64.

\n \n

This parameter must be set to\n X86_64\n for Windows containers.

\n " } } }, diff --git a/codegen/sdk/aws-models/budgets.json b/codegen/sdk/aws-models/budgets.json index 82bcb2a40631..495987c9b0a5 100644 --- a/codegen/sdk/aws-models/budgets.json +++ b/codegen/sdk/aws-models/budgets.json @@ -115,7 +115,7 @@ "name": "budgets" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature.

\n\t\t

Budgets provide you with a way to see the following information:

\n\t\t \n\t\t

Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:

\n\t\t \n\t\t

Service Endpoint

\n\t

The Amazon Web Services Budgets API provides the following endpoint:

\n\t\t \n\t

For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.

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

Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature.

\n

Budgets provide you with a way to see the following information:

\n \n

Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:

\n \n

Service Endpoint

\n

The Amazon Web Services Budgets API provides the following endpoint:

\n \n

For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.

", "smithy.api#title": "AWS Budgets", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -177,52 +177,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", @@ -230,342 +234,302 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "stringEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", + "fn": "getAttr", "argv": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] + "ref": "PartitionResult" }, - "aws" + "name" ] }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] + "ref": "UseFIPS" }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] - } - ], - "endpoint": { - "url": "https://budgets.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-east-1" - } - ] + "ref": "UseDualStack" }, - "headers": {} - }, - "type": "endpoint" + false + ] + } + ], + "endpoint": { + "url": "https://budgets.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "budgets", + "signingRegion": "us-east-1" + } + ] }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ { - "conditions": [ + "fn": "stringEquals", + "argv": [ { - "fn": "stringEquals", + "fn": "getAttr", "argv": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] + "ref": "PartitionResult" }, - "aws-cn" + "name" ] }, + "aws-cn" + ] + }, + { + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] + "ref": "UseFIPS" }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://budgets.amazonaws.com.cn", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "budgets", + "signingRegion": "cn-northwest-1" } - ], - "endpoint": { - "url": "https://budgets.amazonaws.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "cn-northwest-1" - } - ] + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" }, - "headers": {} - }, - "type": "endpoint" + true + ] }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "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://budgets-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://budgets-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://budgets-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://budgets-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://budgets.{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://budgets.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://budgets.{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://budgets.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -1099,91 +1063,111 @@ "Message": { "target": "com.amazonaws.budgets#GenericString", "traits": { - "smithy.api#required": {} + "smithy.api#required": {} + } + }, + "Action": { + "target": "com.amazonaws.budgets#Action", + "traits": { + "smithy.api#documentation": "

The budget action resource.

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

The description of the details for the event.

" + } + }, + "com.amazonaws.budgets#ActionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" + } + }, + "com.amazonaws.budgets#ActionStatus": { + "type": "enum", + "members": { + "Standby": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDBY" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "Execution_In_Progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXECUTION_IN_PROGRESS" + } + }, + "Execution_Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXECUTION_SUCCESS" + } + }, + "Execution_Failure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXECUTION_FAILURE" + } + }, + "Reverse_In_Progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVERSE_IN_PROGRESS" + } + }, + "Reverse_Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVERSE_SUCCESS" + } + }, + "Reverse_Failure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVERSE_FAILURE" } }, - "Action": { - "target": "com.amazonaws.budgets#Action", + "Reset_In_Progress": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The budget action resource.

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

The description of the details for the event.

" - } - }, - "com.amazonaws.budgets#ActionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36, - "max": 36 }, - "smithy.api#pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" - } - }, - "com.amazonaws.budgets#ActionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STANDBY", - "name": "Standby" - }, - { - "value": "PENDING", - "name": "Pending" - }, - { - "value": "EXECUTION_IN_PROGRESS", - "name": "Execution_In_Progress" - }, - { - "value": "EXECUTION_SUCCESS", - "name": "Execution_Success" - }, - { - "value": "EXECUTION_FAILURE", - "name": "Execution_Failure" - }, - { - "value": "REVERSE_IN_PROGRESS", - "name": "Reverse_In_Progress" - }, - { - "value": "REVERSE_SUCCESS", - "name": "Reverse_Success" - }, - { - "value": "REVERSE_FAILURE", - "name": "Reverse_Failure" - }, - { - "value": "RESET_IN_PROGRESS", - "name": "Reset_In_Progress" - }, - { - "value": "RESET_FAILURE", - "name": "Reset_Failure" + "Reset_Failure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESET_FAILURE" } - ] + } } }, "com.amazonaws.budgets#ActionSubType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STOP_EC2_INSTANCES", - "name": "STOP_EC2" - }, - { - "value": "STOP_RDS_INSTANCES", - "name": "STOP_RDS" + "type": "enum", + "members": { + "STOP_EC2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_EC2_INSTANCES" } - ] + }, + "STOP_RDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_RDS_INSTANCES" + } + } } }, "com.amazonaws.budgets#ActionThreshold": { @@ -1208,22 +1192,26 @@ } }, "com.amazonaws.budgets#ActionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "APPLY_IAM_POLICY", - "name": "IAM" - }, - { - "value": "APPLY_SCP_POLICY", - "name": "SCP" - }, - { - "value": "RUN_SSM_DOCUMENTS", - "name": "SSM" + "type": "enum", + "members": { + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLY_IAM_POLICY" + } + }, + "SCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLY_SCP_POLICY" + } + }, + "SSM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUN_SSM_DOCUMENTS" } - ] + } } }, "com.amazonaws.budgets#Actions": { @@ -1248,18 +1236,20 @@ } }, "com.amazonaws.budgets#ApprovalModel": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AUTOMATIC", - "name": "AUTO" - }, - { - "value": "MANUAL", - "name": "MANUAL" + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMATIC" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" } - ] + } } }, "com.amazonaws.budgets#AutoAdjustData": { @@ -1290,18 +1280,20 @@ } }, "com.amazonaws.budgets#AutoAdjustType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "HISTORICAL", - "name": "HISTORICAL" - }, - { - "value": "FORECAST", - "name": "FORECAST" + "type": "enum", + "members": { + "HISTORICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HISTORICAL" + } + }, + "FORECAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORECAST" } - ] + } } }, "com.amazonaws.budgets#Budget": { @@ -1310,32 +1302,32 @@ "BudgetName": { "target": "com.amazonaws.budgets#BudgetName", "traits": { - "smithy.api#documentation": "

The name of a budget. The name must be unique within an account. The : and \\ characters aren't allowed in BudgetName.

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

The name of a budget. The name must be unique within an account. The : and\n\t\t\t\t\\ characters, and the \"/action/\" substring, aren't allowed in\n\t\t\t\tBudgetName.

", "smithy.api#required": {} } }, "BudgetLimit": { "target": "com.amazonaws.budgets#Spend", "traits": { - "smithy.api#documentation": "

The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or\n\t\t\tSavings Plans coverage that you want to track with your budget.

\n\t\t

\n BudgetLimit is required for cost or usage budgets, but optional for RI or\n\t\t\tSavings Plans utilization or coverage budgets. RI and Savings Plans utilization or\n\t\t\tcoverage budgets default to 100. This is the only valid value for RI or\n\t\t\tSavings Plans utilization or coverage budgets. You can't use BudgetLimit\n\t\t\twith PlannedBudgetLimits for CreateBudget and\n\t\t\t\tUpdateBudget actions.

" + "smithy.api#documentation": "

The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or\n\t\t\tSavings Plans coverage that you want to track with your budget.

\n

\n BudgetLimit is required for cost or usage budgets, but optional for RI or\n\t\t\tSavings Plans utilization or coverage budgets. RI and Savings Plans utilization or\n\t\t\tcoverage budgets default to 100. This is the only valid value for RI or\n\t\t\tSavings Plans utilization or coverage budgets. You can't use BudgetLimit\n\t\t\twith PlannedBudgetLimits for CreateBudget and\n\t\t\t\tUpdateBudget actions.

" } }, "PlannedBudgetLimits": { "target": "com.amazonaws.budgets#PlannedBudgetLimits", "traits": { - "smithy.api#documentation": "

A map containing multiple BudgetLimit, including current or future limits.

\n\t\t

\n PlannedBudgetLimits is available for cost or usage budget and supports both\n\t\t\tmonthly and quarterly TimeUnit.

\n\t\t

For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds.

\n\t\t

For quarterly budgets, provide four quarters of PlannedBudgetLimits value\n\t\t\tentries in standard calendar quarter increments. This must start from the current\n\t\t\tquarter and include the next three quarters. The key is the start of the\n\t\t\tquarter, UTC in epoch seconds.

\n\t\t

If the planned budget expires before 12 months for monthly or four quarters for quarterly,\n\t\t\tprovide the PlannedBudgetLimits values only for the remaining\n\t\t\tperiods.

\n\t\t

If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget.

\n\t\t

After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit. At that point, the planned budget provides the same experience as a fixed budget.

\n\t\t

\n DescribeBudget and DescribeBudgets response along with\n\t\t\t\tPlannedBudgetLimits also contain BudgetLimit representing\n\t\t\tthe current month or quarter limit present in PlannedBudgetLimits. This\n\t\t\tonly applies to budgets that are created with PlannedBudgetLimits. Budgets\n\t\t\tthat are created without PlannedBudgetLimits only contain\n\t\t\t\tBudgetLimit. They don't contain\n\t\t\tPlannedBudgetLimits.

" + "smithy.api#documentation": "

A map containing multiple BudgetLimit, including current or future limits.

\n

\n PlannedBudgetLimits is available for cost or usage budget and supports both\n\t\t\tmonthly and quarterly TimeUnit.

\n

For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds.

\n

For quarterly budgets, provide four quarters of PlannedBudgetLimits value\n\t\t\tentries in standard calendar quarter increments. This must start from the current\n\t\t\tquarter and include the next three quarters. The key is the start of the\n\t\t\tquarter, UTC in epoch seconds.

\n

If the planned budget expires before 12 months for monthly or four quarters for quarterly,\n\t\t\tprovide the PlannedBudgetLimits values only for the remaining\n\t\t\tperiods.

\n

If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget.

\n

After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit. At that point, the planned budget provides the same experience as a fixed budget.

\n

\n DescribeBudget and DescribeBudgets response along with\n\t\t\t\tPlannedBudgetLimits also contain BudgetLimit representing\n\t\t\tthe current month or quarter limit present in PlannedBudgetLimits. This\n\t\t\tonly applies to budgets that are created with PlannedBudgetLimits. Budgets\n\t\t\tthat are created without PlannedBudgetLimits only contain\n\t\t\t\tBudgetLimit. They don't contain\n\t\t\tPlannedBudgetLimits.

" } }, "CostFilters": { "target": "com.amazonaws.budgets#CostFilters", "traits": { - "smithy.api#documentation": "

The cost filters, such as Region, Service, member account, Tag, or Cost Category, that are applied to a budget.

\n\t\t

Amazon Web Services Budgets supports the following services as a Service filter for RI budgets:

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

The cost filters, such as Region, Service, member account, Tag, or Cost Category, that are applied to a budget.

\n

Amazon Web Services Budgets supports the following services as a Service filter for RI budgets:

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

The types of costs that are included in this COST budget.

\n\t\t

\n USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets do not have CostTypes.

" + "smithy.api#documentation": "

The types of costs that are included in this COST budget.

\n

\n USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets do not have CostTypes.

" } }, "TimeUnit": { @@ -1348,7 +1340,7 @@ "TimePeriod": { "target": "com.amazonaws.budgets#TimePeriod", "traits": { - "smithy.api#documentation": "

The period of time that's covered by a budget. You setthe start date and end date. The start\n\t\t\tdate must come before the end date. The end date must come before 06/15/87 00:00\n\t\t\t\tUTC.

\n\t\t

If you create your budget and don't specify a start date, Amazon Web Services defaults to the\n\t\t\tstart of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example,\n\t\t\tif you created your budget on January 24, 2018, chose DAILY, and didn't set\n\t\t\ta start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC.\n\t\t\tIf you chose MONTHLY, Amazon Web Services set your start date to\n\t\t\t\t01/01/18 00:00 UTC. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for\n\t\t\tthe Billing and Cost Management console and the API.

\n\t\t

You can change either date with the UpdateBudget operation.

\n\t\t

After the end date, Amazon Web Services deletes the budget and all the associated\n\t\t\tnotifications and subscribers.

" + "smithy.api#documentation": "

The period of time that's covered by a budget. You setthe start date and end date. The start\n\t\t\tdate must come before the end date. The end date must come before 06/15/87 00:00\n\t\t\t\tUTC.

\n

If you create your budget and don't specify a start date, Amazon Web Services defaults to the\n\t\t\tstart of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example,\n\t\t\tif you created your budget on January 24, 2018, chose DAILY, and didn't set\n\t\t\ta start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC.\n\t\t\tIf you chose MONTHLY, Amazon Web Services set your start date to\n\t\t\t\t01/01/18 00:00 UTC. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for\n\t\t\tthe Billing and Cost Management console and the API.

\n

You can change either date with the UpdateBudget operation.

\n

After the end date, Amazon Web Services deletes the budget and all the associated\n\t\t\tnotifications and subscribers.

" } }, "CalculatedSpend": { @@ -1378,18 +1370,18 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the output of the CreateBudget operation. The content consists of the detailed metadata and data file information, and the current status of the budget object.

\n\t\t

This is the Amazon Resource Name (ARN) pattern for a budget:

\n\t\t

\n arn:aws:budgets::AccountId:budget/budgetName\n

" + "smithy.api#documentation": "

Represents the output of the CreateBudget operation. The content consists of the detailed metadata and data file information, and the current status of the budget object.

\n

This is the Amazon Resource Name (ARN) pattern for a budget:

\n

\n arn:aws:budgets::AccountId:budget/budgetName\n

" } }, "com.amazonaws.budgets#BudgetName": { "type": "string", "traits": { - "smithy.api#documentation": "

A string that represents the budget name. The \":\" and \"\\\" characters aren't allowed.

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

A string that represents the budget name. The \":\" and \"\\\" characters, and the \"/action/\"\n\t\t\tsubstring, aren't allowed.

", "smithy.api#length": { "min": 1, "max": 100 }, - "smithy.api#pattern": "^[^:\\\\]+$" + "smithy.api#pattern": "^(?![^:\\\\]*/action/)[^:\\\\]+$" } }, "com.amazonaws.budgets#BudgetNotificationsForAccount": { @@ -1454,35 +1446,47 @@ } }, "com.amazonaws.budgets#BudgetType": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The type of a budget. It must be one of the following types:

\n\t\t

\n COST, USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, or SAVINGS_PLANS_COVERAGE.

", - "smithy.api#enum": [ - { - "value": "USAGE", - "name": "Usage" - }, - { - "value": "COST", - "name": "Cost" - }, - { - "value": "RI_UTILIZATION", - "name": "RIUtilization" - }, - { - "value": "RI_COVERAGE", - "name": "RICoverage" - }, - { - "value": "SAVINGS_PLANS_UTILIZATION", - "name": "SPUtilization" - }, - { - "value": "SAVINGS_PLANS_COVERAGE", - "name": "SPCoverage" + "type": "enum", + "members": { + "Usage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USAGE" + } + }, + "Cost": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COST" + } + }, + "RIUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RI_UTILIZATION" + } + }, + "RICoverage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RI_COVERAGE" + } + }, + "SPUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAVINGS_PLANS_UTILIZATION" } - ] + }, + "SPCoverage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAVINGS_PLANS_COVERAGE" + } + } + }, + "traits": { + "smithy.api#documentation": "

The type of a budget. It must be one of the following types:

\n

\n COST, USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, or SAVINGS_PLANS_COVERAGE.

" } }, "com.amazonaws.budgets#BudgetedAndActualAmounts": { @@ -1544,27 +1548,33 @@ } }, "traits": { - "smithy.api#documentation": "

The spend objects that are associated with this budget. The actualSpend tracks\n\t\t\thow much you've used, cost, usage, RI units, or Savings Plans units and the\n\t\t\t\tforecastedSpend tracks how much that you're predicted to spend based on\n\t\t\tyour historical usage profile.

\n\t\t

For example, if it's the 20th of the month and you have spent 50 dollars on\n\t\t\tAmazon EC2, your actualSpend is 50 USD, and your\n\t\t\t\tforecastedSpend is 75 USD.

" + "smithy.api#documentation": "

The spend objects that are associated with this budget. The actualSpend tracks\n\t\t\thow much you've used, cost, usage, RI units, or Savings Plans units and the\n\t\t\t\tforecastedSpend tracks how much that you're predicted to spend based on\n\t\t\tyour historical usage profile.

\n

For example, if it's the 20th of the month and you have spent 50 dollars on\n\t\t\tAmazon EC2, your actualSpend is 50 USD, and your\n\t\t\t\tforecastedSpend is 75 USD.

" } }, "com.amazonaws.budgets#ComparisonOperator": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The comparison operator of a notification. Currently, the service supports the following\n\t\t\toperators:

\n\t\t

\n GREATER_THAN, LESS_THAN, EQUAL_TO\n

", - "smithy.api#enum": [ - { - "value": "GREATER_THAN", - "name": "GREATER_THAN" - }, - { - "value": "LESS_THAN", - "name": "LESS_THAN" - }, - { - "value": "EQUAL_TO", - "name": "EQUAL_TO" + "type": "enum", + "members": { + "GREATER_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN" + } + }, + "LESS_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESS_THAN" + } + }, + "EQUAL_TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUAL_TO" } - ] + } + }, + "traits": { + "smithy.api#documentation": "

The comparison operator of a notification. Currently, the service supports the following\n\t\t\toperators:

\n

\n GREATER_THAN, LESS_THAN, EQUAL_TO\n

" } }, "com.amazonaws.budgets#CostFilters": { @@ -1585,72 +1595,72 @@ "IncludeTax": { "target": "com.amazonaws.budgets#NullableBoolean", "traits": { - "smithy.api#documentation": "

Specifies whether a budget includes taxes.

\n\t\t

The default value is true.

" + "smithy.api#documentation": "

Specifies whether a budget includes taxes.

\n

The default value is true.

" } }, "IncludeSubscription": { "target": "com.amazonaws.budgets#NullableBoolean", "traits": { - "smithy.api#documentation": "

Specifies whether a budget includes subscriptions.

\n\t\t

The default value is true.

" + "smithy.api#documentation": "

Specifies whether a budget includes subscriptions.

\n

The default value is true.

" } }, "UseBlended": { "target": "com.amazonaws.budgets#NullableBoolean", "traits": { - "smithy.api#documentation": "

Specifies whether a budget uses a blended rate.

\n\t\t

The default value is false.

" + "smithy.api#documentation": "

Specifies whether a budget uses a blended rate.

\n

The default value is false.

" } }, "IncludeRefund": { "target": "com.amazonaws.budgets#NullableBoolean", "traits": { - "smithy.api#documentation": "

Specifies whether a budget includes refunds.

\n\t\t

The default value is true.

" + "smithy.api#documentation": "

Specifies whether a budget includes refunds.

\n

The default value is true.

" } }, "IncludeCredit": { "target": "com.amazonaws.budgets#NullableBoolean", "traits": { - "smithy.api#documentation": "

Specifies whether a budget includes credits.

\n\t\t

The default value is true.

" + "smithy.api#documentation": "

Specifies whether a budget includes credits.

\n

The default value is true.

" } }, "IncludeUpfront": { "target": "com.amazonaws.budgets#NullableBoolean", "traits": { - "smithy.api#documentation": "

Specifies whether a budget includes upfront RI costs.

\n\t\t

The default value is true.

" + "smithy.api#documentation": "

Specifies whether a budget includes upfront RI costs.

\n

The default value is true.

" } }, "IncludeRecurring": { "target": "com.amazonaws.budgets#NullableBoolean", "traits": { - "smithy.api#documentation": "

Specifies whether a budget includes recurring fees such as monthly RI fees.

\n\t\t

The default value is true.

" + "smithy.api#documentation": "

Specifies whether a budget includes recurring fees such as monthly RI fees.

\n

The default value is true.

" } }, "IncludeOtherSubscription": { "target": "com.amazonaws.budgets#NullableBoolean", "traits": { - "smithy.api#documentation": "

Specifies whether a budget includes non-RI subscription costs.

\n\t\t

The default value is true.

" + "smithy.api#documentation": "

Specifies whether a budget includes non-RI subscription costs.

\n

The default value is true.

" } }, "IncludeSupport": { "target": "com.amazonaws.budgets#NullableBoolean", "traits": { - "smithy.api#documentation": "

Specifies whether a budget includes support subscription fees.

\n\t\t

The default value is true.

" + "smithy.api#documentation": "

Specifies whether a budget includes support subscription fees.

\n

The default value is true.

" } }, "IncludeDiscount": { "target": "com.amazonaws.budgets#NullableBoolean", "traits": { - "smithy.api#documentation": "

Specifies whether a budget includes discounts.

\n\t\t

The default value is true.

" + "smithy.api#documentation": "

Specifies whether a budget includes discounts.

\n

The default value is true.

" } }, "UseAmortized": { "target": "com.amazonaws.budgets#NullableBoolean", "traits": { - "smithy.api#documentation": "

Specifies whether a budget uses the amortized rate.

\n\t\t

The default value is false.

" + "smithy.api#documentation": "

Specifies whether a budget uses the amortized rate.

\n

The default value is false.

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

The types of cost that are included in a COST budget, such as tax and subscriptions.

\n\t\t

\n USAGE, RI_UTILIZATION, RI_COVERAGE,\n\t\t\t\tSAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE\n\t\t\tbudgets don't have CostTypes.

" + "smithy.api#documentation": "

The types of cost that are included in a COST budget, such as tax and subscriptions.

\n

\n USAGE, RI_UTILIZATION, RI_COVERAGE,\n\t\t\t\tSAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE\n\t\t\tbudgets don't have CostTypes.

" } }, "com.amazonaws.budgets#CreateBudget": { @@ -1682,7 +1692,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a budget and, if included, notifications and subscribers.

\n\t\t \n\t\t\t

Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

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

Creates a budget and, if included, notifications and subscribers.

\n \n

Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

\n " } }, "com.amazonaws.budgets#CreateBudgetAction": { @@ -1780,6 +1790,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.budgets#CreateBudgetActionResponse": { @@ -1804,6 +1817,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.budgets#CreateBudgetRequest": { @@ -1831,14 +1847,16 @@ } }, "traits": { - "smithy.api#documentation": "

Request of CreateBudget

" + "smithy.api#documentation": "

Request of CreateBudget

", + "smithy.api#input": {} } }, "com.amazonaws.budgets#CreateBudgetResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Response of CreateBudget

" + "smithy.api#documentation": "

Response of CreateBudget

", + "smithy.api#output": {} } }, "com.amazonaws.budgets#CreateNotification": { @@ -1909,14 +1927,16 @@ } }, "traits": { - "smithy.api#documentation": "

Request of CreateNotification

" + "smithy.api#documentation": "

Request of CreateNotification

", + "smithy.api#input": {} } }, "com.amazonaws.budgets#CreateNotificationResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Response of CreateNotification

" + "smithy.api#documentation": "

Response of CreateNotification

", + "smithy.api#output": {} } }, "com.amazonaws.budgets#CreateSubscriber": { @@ -1987,14 +2007,16 @@ } }, "traits": { - "smithy.api#documentation": "

Request of CreateSubscriber

" + "smithy.api#documentation": "

Request of CreateSubscriber

", + "smithy.api#input": {} } }, "com.amazonaws.budgets#CreateSubscriberResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Response of CreateSubscriber

" + "smithy.api#documentation": "

Response of CreateSubscriber

", + "smithy.api#output": {} } }, "com.amazonaws.budgets#CreationLimitExceededException": { @@ -2062,7 +2084,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a budget. You can delete your budget at any time.

\n\t\t \n\t\t\t

Deleting a budget also deletes the notifications and subscribers that are associated with that budget.

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

Deletes a budget. You can delete your budget at any time.

\n \n

Deleting a budget also deletes the notifications and subscribers that are associated with that budget.

\n " } }, "com.amazonaws.budgets#DeleteBudgetAction": { @@ -2119,6 +2141,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.budgets#DeleteBudgetActionResponse": { @@ -2142,6 +2167,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.budgets#DeleteBudgetRequest": { @@ -2163,14 +2191,16 @@ } }, "traits": { - "smithy.api#documentation": "

Request of DeleteBudget

" + "smithy.api#documentation": "

Request of DeleteBudget

", + "smithy.api#input": {} } }, "com.amazonaws.budgets#DeleteBudgetResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Response of DeleteBudget

" + "smithy.api#documentation": "

Response of DeleteBudget

", + "smithy.api#output": {} } }, "com.amazonaws.budgets#DeleteNotification": { @@ -2199,7 +2229,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a notification.

\n\t\t \n\t\t\t

Deleting a notification also deletes the subscribers that are associated with the notification.

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

Deletes a notification.

\n \n

Deleting a notification also deletes the subscribers that are associated with the notification.

\n " } }, "com.amazonaws.budgets#DeleteNotificationRequest": { @@ -2228,14 +2258,16 @@ } }, "traits": { - "smithy.api#documentation": "

Request of DeleteNotification

" + "smithy.api#documentation": "

Request of DeleteNotification

", + "smithy.api#input": {} } }, "com.amazonaws.budgets#DeleteNotificationResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Response of DeleteNotification

" + "smithy.api#documentation": "

Response of DeleteNotification

", + "smithy.api#output": {} } }, "com.amazonaws.budgets#DeleteSubscriber": { @@ -2264,7 +2296,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a subscriber.

\n\t\t \n\t\t\t

Deleting the last subscriber to a notification also deletes the notification.

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

Deletes a subscriber.

\n \n

Deleting the last subscriber to a notification also deletes the notification.

\n " } }, "com.amazonaws.budgets#DeleteSubscriberRequest": { @@ -2300,14 +2332,16 @@ } }, "traits": { - "smithy.api#documentation": "

Request of DeleteSubscriber

" + "smithy.api#documentation": "

Request of DeleteSubscriber

", + "smithy.api#input": {} } }, "com.amazonaws.budgets#DeleteSubscriberResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Response of DeleteSubscriber

" + "smithy.api#documentation": "

Response of DeleteSubscriber

", + "smithy.api#output": {} } }, "com.amazonaws.budgets#DescribeBudget": { @@ -2336,7 +2370,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a budget.

\n\t\t \n\t\t\t

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

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

Describes a budget.

\n \n

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

\n " } }, "com.amazonaws.budgets#DescribeBudgetAction": { @@ -2437,6 +2471,9 @@ "NextToken": { "target": "com.amazonaws.budgets#GenericString" } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.budgets#DescribeBudgetActionHistoriesResponse": { @@ -2452,6 +2489,9 @@ "NextToken": { "target": "com.amazonaws.budgets#GenericString" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.budgets#DescribeBudgetActionRequest": { @@ -2476,6 +2516,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.budgets#DescribeBudgetActionResponse": { @@ -2500,6 +2543,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.budgets#DescribeBudgetActionsForAccount": { @@ -2552,6 +2598,9 @@ "NextToken": { "target": "com.amazonaws.budgets#GenericString" } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.budgets#DescribeBudgetActionsForAccountResponse": { @@ -2567,6 +2616,9 @@ "NextToken": { "target": "com.amazonaws.budgets#GenericString" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.budgets#DescribeBudgetActionsForBudget": { @@ -2628,6 +2680,9 @@ "NextToken": { "target": "com.amazonaws.budgets#GenericString" } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.budgets#DescribeBudgetActionsForBudgetResponse": { @@ -2643,6 +2698,9 @@ "NextToken": { "target": "com.amazonaws.budgets#GenericString" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.budgets#DescribeBudgetNotificationsForAccount": { @@ -2704,6 +2762,9 @@ "NextToken": { "target": "com.amazonaws.budgets#GenericString" } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.budgets#DescribeBudgetNotificationsForAccountResponse": { @@ -2718,6 +2779,9 @@ "NextToken": { "target": "com.amazonaws.budgets#GenericString" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.budgets#DescribeBudgetPerformanceHistory": { @@ -2787,6 +2851,9 @@ "NextToken": { "target": "com.amazonaws.budgets#GenericString" } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.budgets#DescribeBudgetPerformanceHistoryResponse": { @@ -2801,6 +2868,9 @@ "NextToken": { "target": "com.amazonaws.budgets#GenericString" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.budgets#DescribeBudgetRequest": { @@ -2822,7 +2892,8 @@ } }, "traits": { - "smithy.api#documentation": "

Request of DescribeBudget

" + "smithy.api#documentation": "

Request of DescribeBudget

", + "smithy.api#input": {} } }, "com.amazonaws.budgets#DescribeBudgetResponse": { @@ -2836,7 +2907,8 @@ } }, "traits": { - "smithy.api#documentation": "

Response of DescribeBudget

" + "smithy.api#documentation": "

Response of DescribeBudget

", + "smithy.api#output": {} } }, "com.amazonaws.budgets#DescribeBudgets": { @@ -2871,7 +2943,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the budgets that are associated with an account.

\n\t\t \n\t\t\t

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

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

Lists the budgets that are associated with an account.

\n \n

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2904,7 +2976,8 @@ } }, "traits": { - "smithy.api#documentation": "

Request of DescribeBudgets

" + "smithy.api#documentation": "

Request of DescribeBudgets

", + "smithy.api#input": {} } }, "com.amazonaws.budgets#DescribeBudgetsResponse": { @@ -2924,7 +2997,8 @@ } }, "traits": { - "smithy.api#documentation": "

Response of DescribeBudgets

" + "smithy.api#documentation": "

Response of DescribeBudgets

", + "smithy.api#output": {} } }, "com.amazonaws.budgets#DescribeNotificationsForBudget": { @@ -2999,7 +3073,8 @@ } }, "traits": { - "smithy.api#documentation": "

Request of DescribeNotificationsForBudget

" + "smithy.api#documentation": "

Request of DescribeNotificationsForBudget

", + "smithy.api#input": {} } }, "com.amazonaws.budgets#DescribeNotificationsForBudgetResponse": { @@ -3019,7 +3094,8 @@ } }, "traits": { - "smithy.api#documentation": "

Response of GetNotificationsForBudget

" + "smithy.api#documentation": "

Response of GetNotificationsForBudget

", + "smithy.api#output": {} } }, "com.amazonaws.budgets#DescribeSubscribersForNotification": { @@ -3101,7 +3177,8 @@ } }, "traits": { - "smithy.api#documentation": "

Request of DescribeSubscribersForNotification

" + "smithy.api#documentation": "

Request of DescribeSubscribersForNotification

", + "smithy.api#input": {} } }, "com.amazonaws.budgets#DescribeSubscribersForNotificationResponse": { @@ -3121,7 +3198,8 @@ } }, "traits": { - "smithy.api#documentation": "

Response of DescribeSubscribersForNotification

" + "smithy.api#documentation": "

Response of DescribeSubscribersForNotification

", + "smithy.api#output": {} } }, "com.amazonaws.budgets#DimensionValue": { @@ -3154,30 +3232,38 @@ } }, "com.amazonaws.budgets#EventType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SYSTEM", - "name": "System" - }, - { - "value": "CREATE_ACTION", - "name": "CreateAction" - }, - { - "value": "DELETE_ACTION", - "name": "DeleteAction" - }, - { - "value": "UPDATE_ACTION", - "name": "UpdateAction" - }, - { - "value": "EXECUTE_ACTION", - "name": "ExecuteAction" + "type": "enum", + "members": { + "System": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM" + } + }, + "CreateAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_ACTION" } - ] + }, + "DeleteAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_ACTION" + } + }, + "UpdateAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_ACTION" + } + }, + "ExecuteAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXECUTE_ACTION" + } + } } }, "com.amazonaws.budgets#ExecuteBudgetAction": { @@ -3241,6 +3327,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.budgets#ExecuteBudgetActionResponse": { @@ -3272,29 +3361,38 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.budgets#ExecutionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "APPROVE_BUDGET_ACTION", - "name": "ApproveBudgetAction" - }, - { - "value": "RETRY_BUDGET_ACTION", - "name": "RetryBudgetAction" - }, - { - "value": "REVERSE_BUDGET_ACTION", - "name": "ReverseBudgetAction" - }, - { - "value": "RESET_BUDGET_ACTION", - "name": "ResetBudgetAction" + "type": "enum", + "members": { + "ApproveBudgetAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPROVE_BUDGET_ACTION" + } + }, + "RetryBudgetAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRY_BUDGET_ACTION" } - ] + }, + "ReverseBudgetAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVERSE_BUDGET_ACTION" + } + }, + "ResetBudgetAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESET_BUDGET_ACTION" + } + } } }, "com.amazonaws.budgets#ExpiredNextTokenException": { @@ -3355,14 +3453,14 @@ "BudgetAdjustmentPeriod": { "target": "com.amazonaws.budgets#AdjustmentPeriod", "traits": { - "smithy.api#documentation": "

The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the TimeUnit granularity of the budget:

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

The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the TimeUnit granularity of the budget:

\n ", "smithy.api#required": {} } }, "LookBackAvailablePeriods": { "target": "com.amazonaws.budgets#AdjustmentPeriod", "traits": { - "smithy.api#documentation": "

The integer that describes how many budget periods in your BudgetAdjustmentPeriod are included in the calculation of your current BudgetLimit. If the first budget period in your BudgetAdjustmentPeriod has no cost data, then that budget period isn’t included in the average that determines your budget limit.

\n\t\t

For example, if you set BudgetAdjustmentPeriod as 4 quarters, but your account had no cost data in the first quarter, then only the last three quarters are included in the calculation. In this scenario, LookBackAvailablePeriods returns 3.

\n\t\t

You can’t set your own LookBackAvailablePeriods. The value is automatically calculated from the BudgetAdjustmentPeriod and your historical cost data.

" + "smithy.api#documentation": "

The integer that describes how many budget periods in your BudgetAdjustmentPeriod are included in the calculation of your current BudgetLimit. If the first budget period in your BudgetAdjustmentPeriod has no cost data, then that budget period isn’t included in the average that determines your budget limit.

\n

For example, if you set BudgetAdjustmentPeriod as 4 quarters, but your account had no cost data in the first quarter, then only the last three quarters are included in the calculation. In this scenario, LookBackAvailablePeriods returns 3.

\n

You can’t set your own LookBackAvailablePeriods. The value is automatically calculated from the BudgetAdjustmentPeriod and your historical cost data.

" } } }, @@ -3535,22 +3633,24 @@ } }, "traits": { - "smithy.api#documentation": "

A notification that's associated with a budget. A budget can have up to ten notifications.

\n\t\t

Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.

\n\t\t

For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:

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

A notification that's associated with a budget. A budget can have up to ten notifications.

\n

Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.

\n

For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:

\n " } }, "com.amazonaws.budgets#NotificationState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "OK", - "name": "OK" - }, - { - "value": "ALARM", - "name": "ALARM" + "type": "enum", + "members": { + "OK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OK" } - ] + }, + "ALARM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALARM" + } + } } }, "com.amazonaws.budgets#NotificationThreshold": { @@ -3565,19 +3665,23 @@ } }, "com.amazonaws.budgets#NotificationType": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The type of a notification. It must be ACTUAL or FORECASTED.

", - "smithy.api#enum": [ - { - "value": "ACTUAL", - "name": "ACTUAL" - }, - { - "value": "FORECASTED", - "name": "FORECASTED" + "type": "enum", + "members": { + "ACTUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTUAL" + } + }, + "FORECASTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FORECASTED" } - ] + } + }, + "traits": { + "smithy.api#documentation": "

The type of a notification. It must be ACTUAL or FORECASTED.

" } }, "com.amazonaws.budgets#NotificationWithSubscribers": { @@ -3763,7 +3867,7 @@ } }, "traits": { - "smithy.api#documentation": "

The amount of cost or usage that's measured for a budget.

\n\t\t

For example, a Spend for 3 GB of S3 usage has the following\n\t\t\tparameters:

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

The amount of cost or usage that's measured for a budget.

\n

For example, a Spend for 3 GB of S3 usage has the following\n\t\t\tparameters:

\n " } }, "com.amazonaws.budgets#SsmActionDefinition": { @@ -3808,13 +3912,13 @@ "Address": { "target": "com.amazonaws.budgets#SubscriberAddress", "traits": { - "smithy.api#documentation": "

The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

\n\t\t

When you create a subscriber, the value of Address can't contain line breaks.

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

The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

\n

When you create a subscriber, the value of Address can't contain line breaks.

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

The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.

\n\t\t

For example, an email subscriber has the following parameters:

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

The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.

\n

For example, an email subscriber has the following parameters:

\n " } }, "com.amazonaws.budgets#SubscriberAddress": { @@ -3843,19 +3947,23 @@ } }, "com.amazonaws.budgets#SubscriptionType": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The subscription type of the subscriber. It can be SMS or EMAIL.

", - "smithy.api#enum": [ - { - "value": "SNS", - "name": "SNS" - }, - { - "value": "EMAIL", - "name": "EMAIL" + "type": "enum", + "members": { + "SNS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNS" } - ] + }, + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } + } + }, + "traits": { + "smithy.api#documentation": "

The subscription type of the subscriber. It can be SMS or EMAIL.

" } }, "com.amazonaws.budgets#TargetId": { @@ -3881,19 +3989,23 @@ } }, "com.amazonaws.budgets#ThresholdType": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The type of threshold for a notification.

", - "smithy.api#enum": [ - { - "value": "PERCENTAGE", - "name": "PERCENTAGE" - }, - { - "value": "ABSOLUTE_VALUE", - "name": "ABSOLUTE_VALUE" + "type": "enum", + "members": { + "PERCENTAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTAGE" + } + }, + "ABSOLUTE_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABSOLUTE_VALUE" } - ] + } + }, + "traits": { + "smithy.api#documentation": "

The type of threshold for a notification.

" } }, "com.amazonaws.budgets#ThrottlingException": { @@ -3904,7 +4016,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n The number of API requests has exceeded the maximum allowed API request throttling limit for the account.\n

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

The number of API requests has exceeded the maximum allowed API request throttling limit\n for the account.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3915,13 +4027,13 @@ "Start": { "target": "com.amazonaws.budgets#GenericTimestamp", "traits": { - "smithy.api#documentation": "

The start date for a budget. If you created your budget and didn't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

\n\t\t

You can change your start date with the UpdateBudget operation.

" + "smithy.api#documentation": "

The start date for a budget. If you created your budget and didn't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

\n

You can change your start date with the UpdateBudget operation.

" } }, "End": { "target": "com.amazonaws.budgets#GenericTimestamp", "traits": { - "smithy.api#documentation": "

The end date for a budget. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

\n\t\t

After the end date, Amazon Web Services deletes the budget and all the associated\n\t\t\tnotifications and subscribers. You can change your end date with the\n\t\t\t\tUpdateBudget operation.

" + "smithy.api#documentation": "

The end date for a budget. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

\n

After the end date, Amazon Web Services deletes the budget and all the associated\n\t\t\tnotifications and subscribers. You can change your end date with the\n\t\t\t\tUpdateBudget operation.

" } } }, @@ -3930,27 +4042,35 @@ } }, "com.amazonaws.budgets#TimeUnit": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The time unit of the budget, such as MONTHLY or QUARTERLY.

", - "smithy.api#enum": [ - { - "value": "DAILY", - "name": "DAILY" - }, - { - "value": "MONTHLY", - "name": "MONTHLY" - }, - { - "value": "QUARTERLY", - "name": "QUARTERLY" - }, - { - "value": "ANNUALLY", - "name": "ANNUALLY" + "type": "enum", + "members": { + "DAILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAILY" } - ] + }, + "MONTHLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTHLY" + } + }, + "QUARTERLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUARTERLY" + } + }, + "ANNUALLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANNUALLY" + } + } + }, + "traits": { + "smithy.api#documentation": "

The time unit of the budget, such as MONTHLY or QUARTERLY.

" } }, "com.amazonaws.budgets#UnitValue": { @@ -3990,7 +4110,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When you modify a budget, the calculatedSpend drops to zero until Amazon Web Services has new usage data to use for forecasting.

\n\t\t \n\t\t\t

Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

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

Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When you modify a budget, the calculatedSpend drops to zero until Amazon Web Services has new usage data to use for forecasting.

\n \n

Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

\n " } }, "com.amazonaws.budgets#UpdateBudgetAction": { @@ -4071,6 +4191,9 @@ "Subscribers": { "target": "com.amazonaws.budgets#Subscribers" } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.budgets#UpdateBudgetActionResponse": { @@ -4102,6 +4225,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.budgets#UpdateBudgetRequest": { @@ -4123,14 +4249,16 @@ } }, "traits": { - "smithy.api#documentation": "

Request of UpdateBudget

" + "smithy.api#documentation": "

Request of UpdateBudget

", + "smithy.api#input": {} } }, "com.amazonaws.budgets#UpdateBudgetResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Response of UpdateBudget

" + "smithy.api#documentation": "

Response of UpdateBudget

", + "smithy.api#output": {} } }, "com.amazonaws.budgets#UpdateNotification": { @@ -4198,14 +4326,16 @@ } }, "traits": { - "smithy.api#documentation": "

Request of UpdateNotification

" + "smithy.api#documentation": "

Request of UpdateNotification

", + "smithy.api#input": {} } }, "com.amazonaws.budgets#UpdateNotificationResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Response of UpdateNotification

" + "smithy.api#documentation": "

Response of UpdateNotification

", + "smithy.api#output": {} } }, "com.amazonaws.budgets#UpdateSubscriber": { @@ -4280,14 +4410,16 @@ } }, "traits": { - "smithy.api#documentation": "

Request of UpdateSubscriber

" + "smithy.api#documentation": "

Request of UpdateSubscriber

", + "smithy.api#input": {} } }, "com.amazonaws.budgets#UpdateSubscriberResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Response of UpdateSubscriber

" + "smithy.api#documentation": "

Response of UpdateSubscriber

", + "smithy.api#output": {} } }, "com.amazonaws.budgets#User": { diff --git a/codegen/sdk/aws-models/chime-sdk-voice.json b/codegen/sdk/aws-models/chime-sdk-voice.json index 5522ed578b5a..1b5ccd24ad4e 100644 --- a/codegen/sdk/aws-models/chime-sdk-voice.json +++ b/codegen/sdk/aws-models/chime-sdk-voice.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/aws-models/cleanrooms.json b/codegen/sdk/aws-models/cleanrooms.json index 96d5043232df..dec49448b2cd 100644 --- a/codegen/sdk/aws-models/cleanrooms.json +++ b/codegen/sdk/aws-models/cleanrooms.json @@ -16,6 +16,9 @@ } ], "resources": [ + { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateResource" + }, { "target": "com.amazonaws.cleanrooms#CollaborationResource" }, @@ -428,9 +431,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseFIPS": true, - "UseDualStack": true, - "Region": "us-gov-east-1" + "UseDualStack": true } }, { @@ -441,9 +444,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseFIPS": true, - "UseDualStack": false, - "Region": "us-gov-east-1" + "UseDualStack": false } }, { @@ -454,9 +457,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseFIPS": false, - "UseDualStack": true, - "Region": "us-gov-east-1" + "UseDualStack": true } }, { @@ -467,9 +470,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseFIPS": false, - "UseDualStack": false, - "Region": "us-gov-east-1" + "UseDualStack": false } }, { @@ -480,9 +483,9 @@ } }, "params": { + "Region": "cn-north-1", "UseFIPS": true, - "UseDualStack": true, - "Region": "cn-north-1" + "UseDualStack": true } }, { @@ -493,9 +496,9 @@ } }, "params": { + "Region": "cn-north-1", "UseFIPS": true, - "UseDualStack": false, - "Region": "cn-north-1" + "UseDualStack": false } }, { @@ -506,9 +509,9 @@ } }, "params": { + "Region": "cn-north-1", "UseFIPS": false, - "UseDualStack": true, - "Region": "cn-north-1" + "UseDualStack": true } }, { @@ -519,9 +522,9 @@ } }, "params": { + "Region": "cn-north-1", "UseFIPS": false, - "UseDualStack": false, - "Region": "cn-north-1" + "UseDualStack": false } }, { @@ -530,9 +533,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { + "Region": "us-iso-east-1", "UseFIPS": true, - "UseDualStack": true, - "Region": "us-iso-east-1" + "UseDualStack": true } }, { @@ -543,9 +546,9 @@ } }, "params": { + "Region": "us-iso-east-1", "UseFIPS": true, - "UseDualStack": false, - "Region": "us-iso-east-1" + "UseDualStack": false } }, { @@ -554,9 +557,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { + "Region": "us-iso-east-1", "UseFIPS": false, - "UseDualStack": true, - "Region": "us-iso-east-1" + "UseDualStack": true } }, { @@ -567,9 +570,9 @@ } }, "params": { + "Region": "us-iso-east-1", "UseFIPS": false, - "UseDualStack": false, - "Region": "us-iso-east-1" + "UseDualStack": false } }, { @@ -580,9 +583,9 @@ } }, "params": { + "Region": "us-east-1", "UseFIPS": true, - "UseDualStack": true, - "Region": "us-east-1" + "UseDualStack": true } }, { @@ -593,9 +596,9 @@ } }, "params": { + "Region": "us-east-1", "UseFIPS": true, - "UseDualStack": false, - "Region": "us-east-1" + "UseDualStack": false } }, { @@ -606,9 +609,9 @@ } }, "params": { + "Region": "us-east-1", "UseFIPS": false, - "UseDualStack": true, - "Region": "us-east-1" + "UseDualStack": true } }, { @@ -619,9 +622,9 @@ } }, "params": { + "Region": "us-east-1", "UseFIPS": false, - "UseDualStack": false, - "Region": "us-east-1" + "UseDualStack": false } }, { @@ -630,9 +633,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { + "Region": "us-isob-east-1", "UseFIPS": true, - "UseDualStack": true, - "Region": "us-isob-east-1" + "UseDualStack": true } }, { @@ -643,9 +646,9 @@ } }, "params": { + "Region": "us-isob-east-1", "UseFIPS": true, - "UseDualStack": false, - "Region": "us-isob-east-1" + "UseDualStack": false } }, { @@ -654,9 +657,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { + "Region": "us-isob-east-1", "UseFIPS": false, - "UseDualStack": true, - "Region": "us-isob-east-1" + "UseDualStack": true } }, { @@ -667,9 +670,9 @@ } }, "params": { + "Region": "us-isob-east-1", "UseFIPS": false, - "UseDualStack": false, - "Region": "us-isob-east-1" + "UseDualStack": false } }, { @@ -680,9 +683,9 @@ } }, "params": { + "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, - "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -692,9 +695,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, - "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -704,9 +707,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { + "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, - "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -868,6 +871,18 @@ ] } }, + "com.amazonaws.cleanrooms#AllowedAnalysesList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArnOrQueryWildcard" + } + }, + "com.amazonaws.cleanrooms#AllowedAnalysisProviderList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#AccountId" + } + }, "com.amazonaws.cleanrooms#AllowedColumnList": { "type": "list", "member": { @@ -880,6 +895,17 @@ } } }, + "com.amazonaws.cleanrooms#AnalysisFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "SQL", + "value": "SQL" + } + ] + } + }, "com.amazonaws.cleanrooms#AnalysisMethod": { "type": "string", "traits": { @@ -891,6 +917,47 @@ ] } }, + "com.amazonaws.cleanrooms#AnalysisParameter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cleanrooms#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-)\n characters but cannot start or end with a hyphen.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.cleanrooms#ParameterType", + "traits": { + "smithy.api#documentation": "

The type of parameter.

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

Optional. The default value that is applied in the analysis template. The member who can\n query can override this value in the query editor.

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

Optional. The member who can query can provide this placeholder for a literal data value\n in an analysis template.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.cleanrooms#AnalysisParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#AnalysisParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, "com.amazonaws.cleanrooms#AnalysisRule": { "type": "structure", "members": { @@ -904,7 +971,7 @@ "type": { "target": "com.amazonaws.cleanrooms#AnalysisRuleType", "traits": { - "smithy.api#documentation": "

The type of analysis rule. Valid values are `AGGREGATION` and `LIST`.

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

The type of analysis rule.

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

Enables query structure and specified queries that produce aggregate statistics.

" + "smithy.api#documentation": "

A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.

" } }, "com.amazonaws.cleanrooms#AnalysisRuleColumnList": { @@ -1021,6 +1088,33 @@ "target": "com.amazonaws.cleanrooms#AnalysisRuleColumnName" } }, + "com.amazonaws.cleanrooms#AnalysisRuleCustom": { + "type": "structure", + "members": { + "allowedAnalyses": { + "target": "com.amazonaws.cleanrooms#AllowedAnalysesList", + "traits": { + "smithy.api#documentation": "

The analysis templates that are allowed by the custom analysis rule.

", + "smithy.api#length": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "allowedAnalysisProviders": { + "target": "com.amazonaws.cleanrooms#AllowedAnalysisProviderList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when\n allowedAnalyses is ANY_QUERY.

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

A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables.

" + } + }, "com.amazonaws.cleanrooms#AnalysisRuleList": { "type": "structure", "members": { @@ -1037,7 +1131,7 @@ "allowedJoinOperators": { "target": "com.amazonaws.cleanrooms#JoinOperatorsList", "traits": { - "smithy.api#documentation": "

Which logical operators (if any) are to be used in an INNER JOIN match condition.\n Default is AND.

" + "smithy.api#documentation": "

The logical operators (if any) that are to be used in an INNER JOIN match condition.\n Default is AND.

" } }, "listColumns": { @@ -1058,12 +1152,12 @@ "v1": { "target": "com.amazonaws.cleanrooms#AnalysisRulePolicyV1", "traits": { - "smithy.api#documentation": "

Controls on the query specifications that can be run on configured table..

" + "smithy.api#documentation": "

Controls on the query specifications that can be run on configured table.

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

Controls on the query specifications that can be run on configured table..

" + "smithy.api#documentation": "

Controls on the query specifications that can be run on configured table.

" } }, "com.amazonaws.cleanrooms#AnalysisRulePolicyV1": { @@ -1080,10 +1174,16 @@ "traits": { "smithy.api#documentation": "

Analysis rule type that enables only aggregation queries on a configured table.

" } + }, + "custom": { + "target": "com.amazonaws.cleanrooms#AnalysisRuleCustom", + "traits": { + "smithy.api#documentation": "

Analysis rule type that enables custom SQL queries on a configured table.

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

Controls on the query specifications that can be run on configured table..

" + "smithy.api#documentation": "

Controls on the query specifications that can be run on configured table.

" } }, "com.amazonaws.cleanrooms#AnalysisRuleType": { @@ -1100,6 +1200,12 @@ "traits": { "smithy.api#enumValue": "LIST" } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } } } }, @@ -1109,225 +1215,828 @@ "target": "com.amazonaws.cleanrooms#AnalysisRuleType" } }, - "com.amazonaws.cleanrooms#BatchGetSchema": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanrooms#BatchGetSchemaInput" - }, - "output": { - "target": "com.amazonaws.cleanrooms#BatchGetSchemaOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cleanrooms#AccessDeniedException" - }, - { - "target": "com.amazonaws.cleanrooms#InternalServerException" - }, - { - "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cleanrooms#ThrottlingException" - }, - { - "target": "com.amazonaws.cleanrooms#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to view details of schemas", - "smithy.api#documentation": "

Retrieves multiple schemas by their identifiers.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/collaborations/{collaborationIdentifier}/batch-schema" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.cleanrooms#BatchGetSchemaError": { + "com.amazonaws.cleanrooms#AnalysisSchema": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.cleanrooms#TableAlias", - "traits": { - "smithy.api#documentation": "

An error name for the error.

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

An error code for the error.

", - "smithy.api#required": {} - } - }, - "message": { - "target": "smithy.api#String", + "referencedTables": { + "target": "com.amazonaws.cleanrooms#QueryTables", "traits": { - "smithy.api#documentation": "

An error message for the error.

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

The tables referenced in the analysis schema.

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

An error describing why a schema could not be fetched.

" - } - }, - "com.amazonaws.cleanrooms#BatchGetSchemaErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanrooms#BatchGetSchemaError" - }, - "traits": { - "smithy.api#length": { - "max": 25 - } + "smithy.api#documentation": "

A relation within an analysis.

" } }, - "com.amazonaws.cleanrooms#BatchGetSchemaInput": { - "type": "structure", + "com.amazonaws.cleanrooms#AnalysisSource": { + "type": "union", "members": { - "collaborationIdentifier": { - "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "text": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateText", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the schemas belong to. Currently accepts\n collaboration ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "CollaborationId" - } - }, - "names": { - "target": "com.amazonaws.cleanrooms#TableAliasList", - "traits": { - "smithy.api#documentation": "

The names for the schema objects to retrieve.>

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

The query text.

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

The structure that defines the body of the analysis template.

", + "smithy.api#sensitive": {} } }, - "com.amazonaws.cleanrooms#BatchGetSchemaOutput": { + "com.amazonaws.cleanrooms#AnalysisTemplate": { "type": "structure", "members": { - "schemas": { - "target": "com.amazonaws.cleanrooms#SchemaList", + "id": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", "traits": { - "smithy.api#documentation": "

The retrieved list of schemas.

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

The identifier for the analysis template.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AnalysisTemplateId" } }, - "errors": { - "target": "com.amazonaws.cleanrooms#BatchGetSchemaErrorList", + "arn": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", "traits": { - "smithy.api#documentation": "

Error reasons for schemas that could not be retrieved. One error is returned for every\n schema that could not be retrieved.

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

The Amazon Resource Name (ARN) of the analysis template.

", "smithy.api#required": {} } - } - } - }, - "com.amazonaws.cleanrooms#CleanroomsArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 100 }, - "smithy.api#pattern": "^arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:[\\d\\w/-]+$" - } - }, - "com.amazonaws.cleanrooms#Collaboration": { - "type": "structure", - "members": { - "id": { + "collaborationId": { "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

The unique ID for the collaboration.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "CollaborationId" + "smithy.api#documentation": "

The unique ID for the associated collaboration of the analysis template.

", + "smithy.api#required": {} } }, - "arn": { + "collaborationArn": { "target": "com.amazonaws.cleanrooms#CollaborationArn", "traits": { - "smithy.api#documentation": "

The unique ARN for the collaboration.

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

The unique ARN for the analysis template’s associated collaboration.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.cleanrooms#CollaborationName", + "membershipId": { + "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

A human-readable identifier provided by the collaboration owner. Display names are not unique.

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

The identifier of a member who created the analysis template.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.cleanrooms#CollaborationDescription", + "membershipArn": { + "target": "com.amazonaws.cleanrooms#MembershipArn", "traits": { - "smithy.api#documentation": "

A description of the collaboration provided by the collaboration owner.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the member who created the analysis template.

", + "smithy.api#required": {} } }, - "creatorAccountId": { - "target": "com.amazonaws.cleanrooms#AccountId", + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

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

The description of the analysis template.

" } }, - "creatorDisplayName": { - "target": "com.amazonaws.cleanrooms#DisplayName", + "name": { + "target": "com.amazonaws.cleanrooms#ResourceAlias", "traits": { - "smithy.api#documentation": "

A display name of the collaboration creator.

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

The name of the analysis template.

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

The time when the collaboration was created.

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

The time that the analysis template was created.

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

The time the collaboration metadata was last updated.

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

The time that the analysis template was last updated.

", "smithy.api#required": {} } }, - "memberStatus": { - "target": "com.amazonaws.cleanrooms#MemberStatus", + "schema": { + "target": "com.amazonaws.cleanrooms#AnalysisSchema", "traits": { - "smithy.api#documentation": "

The status of a member in a collaboration.

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

The entire schema object.

", "smithy.api#required": {} } }, - "membershipId": { - "target": "com.amazonaws.cleanrooms#UUID", + "format": { + "target": "com.amazonaws.cleanrooms#AnalysisFormat", "traits": { - "smithy.api#documentation": "

The unique ID for your membership within the collaboration.

" + "smithy.api#documentation": "

The format of the analysis template.

", + "smithy.api#required": {} } }, - "membershipArn": { + "source": { + "target": "com.amazonaws.cleanrooms#AnalysisSource", + "traits": { + "smithy.api#documentation": "

The source of the analysis template.

", + "smithy.api#required": {} + } + }, + "analysisParameters": { + "target": "com.amazonaws.cleanrooms#AnalysisParameterList", + "traits": { + "smithy.api#documentation": "

The parameters of the analysis template.

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

The analysis template.

" + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 200 + }, + "smithy.api#pattern": "^arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/analysistemplate/[\\d\\w-]+$" + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateArnOrQueryWildcard": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 200 + }, + "smithy.api#pattern": "^(ANY_QUERY|arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:membership/[\\d\\w-]+/analysistemplate/[\\d\\w-]+)$" + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateResource": { + "type": "resource", + "identifiers": { + "MembershipId": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier" + }, + "AnalysisTemplateId": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier" + } + }, + "create": { + "target": "com.amazonaws.cleanrooms#CreateAnalysisTemplate" + }, + "read": { + "target": "com.amazonaws.cleanrooms#GetAnalysisTemplate" + }, + "update": { + "target": "com.amazonaws.cleanrooms#UpdateAnalysisTemplate" + }, + "delete": { + "target": "com.amazonaws.cleanrooms#DeleteAnalysisTemplate" + }, + "list": { + "target": "com.amazonaws.cleanrooms#ListAnalysisTemplates" + }, + "traits": { + "aws.api#arn": { + "template": "membership/{MembershipId}/analysistemplate/{AnalysisTemplateId}" + }, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "analysistemplate" + }, + "smithy.api#documentation": "Represents a query that can be stored within a collaboration" + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis template.

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

The time that the analysis template summary was created.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the analysis template.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#ResourceAlias", + "traits": { + "smithy.api#documentation": "

The name of the analysis template.

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

The time that the analysis template summary was last updated.

", + "smithy.api#required": {} + } + }, + "membershipArn": { + "target": "com.amazonaws.cleanrooms#MembershipArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the member who created the analysis template.

", + "smithy.api#required": {} + } + }, + "membershipId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "

The identifier for a membership resource.

", + "smithy.api#required": {} + } + }, + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", + "traits": { + "smithy.api#documentation": "

The unique ARN for the analysis template summary’s associated collaboration.

", + "smithy.api#required": {} + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis template summary belongs to. Currently accepts collaboration ID.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the analysis template.

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

The metadata of the analysis template.

" + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateSummary" + } + }, + "com.amazonaws.cleanrooms#AnalysisTemplateText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15000 + } + } + }, + "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to view details of multiple analysis tempaltes within a collaboration", + "smithy.api#documentation": "

Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/collaborations/{collaborationIdentifier}/batch-analysistemplates" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateError": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis template.

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

An error code for the error.

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

A description of why the call failed.

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

Details of errors thrown by the call to retrieve multiple analysis templates within a collaboration by their identifiers.

" + } + }, + "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateError" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "analysisTemplateArns": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArnList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateOutput": { + "type": "structure", + "members": { + "collaborationAnalysisTemplates": { + "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateList", + "traits": { + "smithy.api#documentation": "

The retrieved list of analysis templates within a collaboration.

", + "smithy.api#required": {} + } + }, + "errors": { + "target": "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateErrorList", + "traits": { + "smithy.api#documentation": "

Error reasons for collaboration analysis templates that could not be retrieved. One error is returned for every collaboration analysis template that could not be retrieved.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#BatchGetSchema": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#BatchGetSchemaInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#BatchGetSchemaOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to view details of schemas", + "smithy.api#documentation": "

Retrieves multiple schemas by their identifiers.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/collaborations/{collaborationIdentifier}/batch-schema" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#BatchGetSchemaError": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cleanrooms#TableAlias", + "traits": { + "smithy.api#documentation": "

An error name for the error.

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

An error code for the error.

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

An error message for the error.

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

An error describing why a schema could not be fetched.

" + } + }, + "com.amazonaws.cleanrooms#BatchGetSchemaErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#BatchGetSchemaError" + }, + "traits": { + "smithy.api#length": { + "max": 25 + } + } + }, + "com.amazonaws.cleanrooms#BatchGetSchemaInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for the collaboration that the schemas belong to. Currently accepts\n collaboration ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "names": { + "target": "com.amazonaws.cleanrooms#TableAliasList", + "traits": { + "smithy.api#documentation": "

The names for the schema objects to retrieve.>

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#BatchGetSchemaOutput": { + "type": "structure", + "members": { + "schemas": { + "target": "com.amazonaws.cleanrooms#SchemaList", + "traits": { + "smithy.api#documentation": "

The retrieved list of schemas.

", + "smithy.api#required": {} + } + }, + "errors": { + "target": "com.amazonaws.cleanrooms#BatchGetSchemaErrorList", + "traits": { + "smithy.api#documentation": "

Error reasons for schemas that could not be retrieved. One error is returned for every\n schema that could not be retrieved.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#CleanroomsArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 100 + }, + "smithy.api#pattern": "^arn:aws:cleanrooms:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:[\\d\\w/-]+$" + } + }, + "com.amazonaws.cleanrooms#Collaboration": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "

The unique ID for the collaboration.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "arn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", + "traits": { + "smithy.api#documentation": "

The unique ARN for the collaboration.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#CollaborationName", + "traits": { + "smithy.api#documentation": "

A human-readable identifier provided by the collaboration owner. Display names are not unique.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#CollaborationDescription", + "traits": { + "smithy.api#documentation": "

A description of the collaboration provided by the collaboration owner.

" + } + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanrooms#AccountId", + "traits": { + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#required": {} + } + }, + "creatorDisplayName": { + "target": "com.amazonaws.cleanrooms#DisplayName", + "traits": { + "smithy.api#documentation": "

A display name of the collaboration creator.

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

The time when the collaboration was created.

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

The time the collaboration metadata was last updated.

", + "smithy.api#required": {} + } + }, + "memberStatus": { + "target": "com.amazonaws.cleanrooms#MemberStatus", + "traits": { + "smithy.api#documentation": "

The status of a member in a collaboration.

", + "smithy.api#required": {} + } + }, + "membershipId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "

The unique ID for your membership within the collaboration.

" + } + }, + "membershipArn": { "target": "com.amazonaws.cleanrooms#MembershipArn", "traits": { - "smithy.api#documentation": "

The unique ARN for your membership within the collaboration.

" + "smithy.api#documentation": "

The unique ARN for your membership within the collaboration.

" + } + }, + "dataEncryptionMetadata": { + "target": "com.amazonaws.cleanrooms#DataEncryptionMetadata", + "traits": { + "smithy.api#documentation": "

The settings for client-side encryption for cryptographic computing.

" + } + }, + "queryLogStatus": { + "target": "com.amazonaws.cleanrooms#CollaborationQueryLogStatus", + "traits": { + "smithy.api#documentation": "

An indicator as to whether query logging has been enabled or disabled for the\n collaboration.

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

The multi-party data share environment. The collaboration contains metadata about its purpose and participants.

" + } + }, + "com.amazonaws.cleanrooms#CollaborationAnalysisTemplate": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the analysis template.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AnalysisTemplateId" + } + }, + "arn": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis template.

", + "smithy.api#required": {} + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#required": {} + } + }, + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", + "traits": { + "smithy.api#documentation": "

The unique ARN for the analysis template’s associated collaboration.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the analysis template.

" + } + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanrooms#AccountId", + "traits": { + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#ResourceAlias", + "traits": { + "smithy.api#documentation": "

The name of the analysis template.

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

The time that the analysis template within a collaboration was created.

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

The time that the analysis template in the collaboration was last updated.

", + "smithy.api#required": {} + } + }, + "schema": { + "target": "com.amazonaws.cleanrooms#AnalysisSchema", + "traits": { + "smithy.api#documentation": "

The entire schema object.

", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.cleanrooms#AnalysisFormat", + "traits": { + "smithy.api#documentation": "

The format of the analysis template in the collaboration.

", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.cleanrooms#AnalysisSource", + "traits": { + "smithy.api#documentation": "

The source of the analysis template within a collaboration.

", + "smithy.api#required": {} + } + }, + "analysisParameters": { + "target": "com.amazonaws.cleanrooms#AnalysisParameterList", + "traits": { + "smithy.api#documentation": "

The analysis parameters that have been specified in the analysis template.

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

The analysis template within a collaboration.

" + } + }, + "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplate" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis template.

", + "smithy.api#required": {} } }, - "dataEncryptionMetadata": { - "target": "com.amazonaws.cleanrooms#DataEncryptionMetadata", + "createTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The settings for client-side encryption for cryptographic computing.

" + "smithy.api#documentation": "

The time that the summary of the analysis template in a collaboration was created.

", + "smithy.api#required": {} } }, - "queryLogStatus": { - "target": "com.amazonaws.cleanrooms#CollaborationQueryLogStatus", + "id": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", "traits": { - "smithy.api#documentation": "

An indicator as to whether query logging has been enabled or disabled for the\n collaboration.

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

The identifier of the analysis template.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#ResourceAlias", + "traits": { + "smithy.api#documentation": "

The name of the analysis template.

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

The time that the summary of the analysis template in the collaboration was last updated.

", "smithy.api#required": {} } + }, + "collaborationArn": { + "target": "com.amazonaws.cleanrooms#CollaborationArn", + "traits": { + "smithy.api#documentation": "

The unique ARN for the analysis template’s associated collaboration.

", + "smithy.api#required": {} + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanrooms#UUID", + "traits": { + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#required": {} + } + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanrooms#AccountId", + "traits": { + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the analysis template.

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

The multi-party data share environment. The collaboration contains metadata about its purpose and participants.

" + "smithy.api#documentation": "

The metadata of the analysis template within a collaboration.

" + } + }, + "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateSummary" } }, "com.amazonaws.cleanrooms#CollaborationArn": { @@ -1407,18 +2116,27 @@ "target": "com.amazonaws.cleanrooms#ListCollaborations" }, "operations": [ + { + "target": "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplate" + }, { "target": "com.amazonaws.cleanrooms#BatchGetSchema" }, { "target": "com.amazonaws.cleanrooms#DeleteMember" }, + { + "target": "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplate" + }, { "target": "com.amazonaws.cleanrooms#GetSchema" }, { "target": "com.amazonaws.cleanrooms#GetSchemaAnalysisRule" }, + { + "target": "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplates" + }, { "target": "com.amazonaws.cleanrooms#ListMembers" }, @@ -1432,7 +2150,7 @@ }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { - "name": "Collaboration" + "name": "collaboration" }, "smithy.api#documentation": "Represents a collaboration between AWS accounts that allows for secure data collaboration" } @@ -1621,7 +2339,7 @@ "analysisRuleTypes": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleTypeList", "traits": { - "smithy.api#documentation": "

The types of analysis rules associated with this configured table. Valid values are `AGGREGATION` and `LIST`. Currently, only one analysis rule may be associated with a configured table.

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

The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.

", "smithy.api#required": {} } }, @@ -1672,7 +2390,7 @@ "type": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", "traits": { - "smithy.api#documentation": "

The type of configured table analysis rule. Valid values are `AGGREGATION` and `LIST`.

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

The type of configured table analysis rule.

", "smithy.api#required": {} } }, @@ -1723,6 +2441,9 @@ "traits": { "smithy.api#documentation": "

Analysis rule type that enables only aggregation queries on a configured table.

" } + }, + "custom": { + "target": "com.amazonaws.cleanrooms#AnalysisRuleCustom" } }, "traits": { @@ -1743,6 +2464,12 @@ "traits": { "smithy.api#enumValue": "LIST" } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } } } }, @@ -1758,7 +2485,7 @@ "smithy.api#length": { "max": 100 }, - "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:configuredTable/[\\d\\w-]+$" + "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:configuredtable/[\\d\\w-]+$" } }, "com.amazonaws.cleanrooms#ConfiguredTableAssociation": { @@ -1853,7 +2580,7 @@ "smithy.api#length": { "max": 100 }, - "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:configuredTableAssociation/[\\d\\w-]+/[\\d\\w-]+$" + "smithy.api#pattern": "^arn:aws:[\\w]+:[\\w]{2}-[\\w]{4,9}-[\\d]:[\\d]{12}:configuredtableassociation/[\\d\\w-]+/[\\d\\w-]+$" } }, "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier": { @@ -1897,7 +2624,7 @@ }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { - "name": "ConfiguredTableAssociation" + "name": "configuredtableassociation" }, "smithy.api#documentation": "Represents a table that can be queried within a collaboration" } @@ -2026,7 +2753,7 @@ }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { - "name": "ConfiguredTable" + "name": "configuredtable" }, "smithy.api#documentation": "Represents a table that can be associated with collaborations" } @@ -2148,6 +2875,112 @@ ] } }, + "com.amazonaws.cleanrooms#CreateAnalysisTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#CreateAnalysisTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#CreateAnalysisTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#ConflictException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a new analysis template", + "smithy.api#documentation": "

Creates a new analysis template.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/memberships/{membershipIdentifier}/analysistemplates" + } + } + }, + "com.amazonaws.cleanrooms#CreateAnalysisTemplateInput": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the analysis template.

" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for a membership resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "name": { + "target": "com.amazonaws.cleanrooms#TableAlias", + "traits": { + "smithy.api#documentation": "

The name of the analysis template.

", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.cleanrooms#AnalysisFormat", + "traits": { + "smithy.api#documentation": "

The format of the analysis template.

", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.cleanrooms#AnalysisSource", + "traits": { + "smithy.api#documentation": "

The information in the analysis template. Currently supports text, the\n query text for the analysis template.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cleanrooms#TagMap", + "traits": { + "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

" + } + }, + "analysisParameters": { + "target": "com.amazonaws.cleanrooms#AnalysisParameterList", + "traits": { + "smithy.api#documentation": "

The parameters of the analysis template.

" + } + } + } + }, + "com.amazonaws.cleanrooms#CreateAnalysisTemplateOutput": { + "type": "structure", + "members": { + "analysisTemplate": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplate", + "traits": { + "smithy.api#documentation": "

The analysis template.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.cleanrooms#CreateCollaboration": { "type": "operation", "input": { @@ -2350,7 +3183,7 @@ "analysisRuleType": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", "traits": { - "smithy.api#documentation": "

The type of analysis rule. Valid values are AGGREGATION and LIST.

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

The type of analysis rule.

", "smithy.api#required": {} } }, @@ -2649,6 +3482,69 @@ "smithy.api#documentation": "

The settings for client-side encryption for cryptographic computing.

" } }, + "com.amazonaws.cleanrooms#DeleteAnalysisTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#DeleteAnalysisTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#DeleteAnalysisTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to remove an analysis template from a collaboration", + "smithy.api#documentation": "

Deletes an analysis template.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/memberships/{membershipIdentifier}/analysistemplates/{analysisTemplateIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanrooms#DeleteAnalysisTemplateInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for a membership resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "analysisTemplateIdentifier": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for the analysis template resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AnalysisTemplateId" + } + } + } + }, + "com.amazonaws.cleanrooms#DeleteAnalysisTemplateOutput": { + "type": "structure", + "members": {} + }, "com.amazonaws.cleanrooms#DeleteCollaboration": { "type": "operation", "input": { @@ -3038,7 +3934,78 @@ "name": "ACTIVE", "value": "ACTIVE" } - ] + ] + } + }, + "com.amazonaws.cleanrooms#GetAnalysisTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#GetAnalysisTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#GetAnalysisTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get an analysis template", + "smithy.api#documentation": "

Retrieves an analysis template.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/analysistemplates/{analysisTemplateIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#GetAnalysisTemplateInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for a membership resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "analysisTemplateIdentifier": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for the analysis template resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AnalysisTemplateId" + } + } + } + }, + "com.amazonaws.cleanrooms#GetAnalysisTemplateOutput": { + "type": "structure", + "members": { + "analysisTemplate": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplate", + "traits": { + "smithy.api#documentation": "

The analysis template.

", + "smithy.api#required": {} + } + } } }, "com.amazonaws.cleanrooms#GetCollaboration": { @@ -3074,6 +4041,77 @@ "smithy.api#readonly": {} } }, + "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get an analysis template within a collaboration", + "smithy.api#documentation": "

Retrieves an analysis template within a collaboration.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/analysistemplates/{analysisTemplateArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "analysisTemplateArn": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AnalysisTemplateArn" + } + } + } + }, + "com.amazonaws.cleanrooms#GetCollaborationAnalysisTemplateOutput": { + "type": "structure", + "members": { + "collaborationAnalysisTemplate": { + "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplate", + "traits": { + "smithy.api#documentation": "

The analysis template within a collaboration.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.cleanrooms#GetCollaborationInput": { "type": "structure", "members": { @@ -3598,85 +4636,254 @@ "smithy.api#length": { "max": 128 }, - "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$" - } - }, - "com.amazonaws.cleanrooms#GlueTableReference": { - "type": "structure", - "members": { - "tableName": { - "target": "com.amazonaws.cleanrooms#GlueTableName", + "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$" + } + }, + "com.amazonaws.cleanrooms#GlueTableReference": { + "type": "structure", + "members": { + "tableName": { + "target": "com.amazonaws.cleanrooms#GlueTableName", + "traits": { + "smithy.api#documentation": "

The name of the Glue table.

", + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.cleanrooms#GlueDatabaseName", + "traits": { + "smithy.api#documentation": "

The name of the database the Glue table belongs to.

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

A reference to a table within an Glue data catalog.

" + } + }, + "com.amazonaws.cleanrooms#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

Unexpected error during processing of request.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.cleanrooms#JoinOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "OR", + "value": "OR" + }, + { + "name": "AND", + "value": "AND" + } + ] + } + }, + "com.amazonaws.cleanrooms#JoinOperatorsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#JoinOperator" + }, + "traits": { + "smithy.api#length": { + "max": 2 + } + } + }, + "com.amazonaws.cleanrooms#JoinRequiredOption": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "QUERY_RUNNER", + "value": "QUERY_RUNNER" + } + ] + } + }, + "com.amazonaws.cleanrooms#KeyPrefix": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\w!.*/-]*$" + } + }, + "com.amazonaws.cleanrooms#ListAnalysisTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#ListAnalysisTemplatesInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#ListAnalysisTemplatesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list analysis templates", + "smithy.api#documentation": "

Lists analysis templates that the caller owns.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/analysistemplates" + }, + "smithy.api#paginated": { + "items": "analysisTemplateSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#ListAnalysisTemplatesInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for a membership resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

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

The maximum size of the results that is returned per call.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.cleanrooms#ListAnalysisTemplatesOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + } + }, + "analysisTemplateSummaries": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateSummaryList", + "traits": { + "smithy.api#documentation": "

Lists analysis template metadata.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplatesInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplatesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list analysis templates within a collaboration", + "smithy.api#documentation": "

Lists analysis templates within a collaboration.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/analysistemplates" + }, + "smithy.api#paginated": { + "items": "collaborationAnalysisTemplateSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplatesInput": { + "type": "structure", + "members": { + "collaborationIdentifier": { + "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", + "traits": { + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "CollaborationId" + } + }, + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The name of the Glue table.

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

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#httpQuery": "nextToken" } }, - "databaseName": { - "target": "com.amazonaws.cleanrooms#GlueDatabaseName", + "maxResults": { + "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "

The name of the database the Glue table belongs to.

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

The maximum size of the results that is returned per call.

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

A reference to a table within an Glue data catalog.

" } }, - "com.amazonaws.cleanrooms#InternalServerException": { + "com.amazonaws.cleanrooms#ListCollaborationAnalysisTemplatesOutput": { "type": "structure", "members": { - "message": { - "target": "smithy.api#String" - } - }, - "traits": { - "smithy.api#documentation": "

Unexpected error during processing of request.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.cleanrooms#JoinOperator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "OR", - "value": "OR" - }, - { - "name": "AND", - "value": "AND" + "nextToken": { + "target": "com.amazonaws.cleanrooms#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" } - ] - } - }, - "com.amazonaws.cleanrooms#JoinOperatorsList": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanrooms#JoinOperator" - }, - "traits": { - "smithy.api#length": { - "max": 2 - } - } - }, - "com.amazonaws.cleanrooms#JoinRequiredOption": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "QUERY_RUNNER", - "value": "QUERY_RUNNER" + }, + "collaborationAnalysisTemplateSummaries": { + "target": "com.amazonaws.cleanrooms#CollaborationAnalysisTemplateSummaryList", + "traits": { + "smithy.api#documentation": "

The metadata of the analysis template within a collaboration.

", + "smithy.api#required": {} } - ] - } - }, - "com.amazonaws.cleanrooms#KeyPrefix": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[\\w!.*/-]*$" + } } }, "com.amazonaws.cleanrooms#ListCollaborations": { @@ -4659,7 +5866,7 @@ }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { - "name": "Membership" + "name": "membership" }, "smithy.api#documentation": "Represents an AWS account that is a part of a collaboration" } @@ -4783,6 +5990,129 @@ } } }, + "com.amazonaws.cleanrooms#ParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.cleanrooms#ParameterName" + }, + "value": { + "target": "com.amazonaws.cleanrooms#ParameterValue" + } + }, + "com.amazonaws.cleanrooms#ParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9a-zA-Z_]+$" + } + }, + "com.amazonaws.cleanrooms#ParameterType": { + "type": "enum", + "members": { + "SMALLINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMALLINT" + } + }, + "INTEGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTEGER" + } + }, + "BIGINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIGINT" + } + }, + "DECIMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DECIMAL" + } + }, + "REAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REAL" + } + }, + "DOUBLE_PRECISION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOUBLE_PRECISION" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOOLEAN" + } + }, + "CHAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHAR" + } + }, + "VARCHAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARCHAR" + } + }, + "DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE" + } + }, + "TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTAMP" + } + }, + "TIMESTAMPTZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTAMPTZ" + } + }, + "TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIME" + } + }, + "TIMETZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMETZ" + } + }, + "VARBYTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARBYTE" + } + } + } + }, + "com.amazonaws.cleanrooms#ParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 + } + } + }, "com.amazonaws.cleanrooms#ProtectedQuery": { "type": "structure", "members": { @@ -5008,6 +6338,18 @@ "max": 15000 } } + }, + "analysisTemplateArn": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

" + } + }, + "parameters": { + "target": "com.amazonaws.cleanrooms#ParameterMap", + "traits": { + "smithy.api#documentation": "

The protected query SQL parameters.

" + } } }, "traits": { @@ -5125,6 +6467,30 @@ ] } }, + "com.amazonaws.cleanrooms#QueryTables": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#TableAlias" + } + }, + "com.amazonaws.cleanrooms#ResourceAlias": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$" + } + }, + "com.amazonaws.cleanrooms#ResourceDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$" + } + }, "com.amazonaws.cleanrooms#ResourceNotFoundException": { "type": "structure", "members": { @@ -5288,7 +6654,7 @@ "analysisRuleTypes": { "target": "com.amazonaws.cleanrooms#AnalysisRuleTypeList", "traits": { - "smithy.api#documentation": "

The analysis rule types associated with the schema. Valued values are LIST and\n AGGREGATION. Currently, only one entry is present.

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

The analysis rule types associated with the schema. Currently, only one entry is present.

", "smithy.api#required": {} } }, @@ -5809,6 +7175,82 @@ "smithy.api#output": {} } }, + "com.amazonaws.cleanrooms#UpdateAnalysisTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanrooms#UpdateAnalysisTemplateInput" + }, + "output": { + "target": "com.amazonaws.cleanrooms#UpdateAnalysisTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cleanrooms#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanrooms#InternalServerException" + }, + { + "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanrooms#ThrottlingException" + }, + { + "target": "com.amazonaws.cleanrooms#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to update an analysis template", + "smithy.api#documentation": "

Updates the analysis template metadata.

", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/memberships/{membershipIdentifier}/analysistemplates/{analysisTemplateIdentifier}" + } + } + }, + "com.amazonaws.cleanrooms#UpdateAnalysisTemplateInput": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanrooms#MembershipIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for a membership resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "MembershipId" + } + }, + "analysisTemplateIdentifier": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplateIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier for the analysis template resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "AnalysisTemplateId" + } + }, + "description": { + "target": "com.amazonaws.cleanrooms#ResourceDescription", + "traits": { + "smithy.api#documentation": "

A new description for the analysis template.

" + } + } + } + }, + "com.amazonaws.cleanrooms#UpdateAnalysisTemplateOutput": { + "type": "structure", + "members": { + "analysisTemplate": { + "target": "com.amazonaws.cleanrooms#AnalysisTemplate", + "traits": { + "smithy.api#documentation": "

The analysis template.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.cleanrooms#UpdateCollaboration": { "type": "operation", "input": { @@ -6339,6 +7781,10 @@ { "value": "INVALID_QUERY", "name": "INVALID_QUERY" + }, + { + "value": "IAM_SYNCHRONIZATION_DELAY", + "name": "IAM_SYNCHRONIZATION_DELAY" } ] } diff --git a/codegen/sdk/aws-models/cloud9.json b/codegen/sdk/aws-models/cloud9.json index f50b8d9575b5..709acb86ff55 100644 --- a/codegen/sdk/aws-models/cloud9.json +++ b/codegen/sdk/aws-models/cloud9.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.

\n

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

\n

In 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

\n SSM paths\n

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

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

\n

The default 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.

\n

From 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

\n SSM paths\n

\n " } }, "automaticStopTimeMinutes": { @@ -1227,6 +1227,9 @@ "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloud9#CreateEnvironmentEC2Result": { @@ -1238,6 +1241,9 @@ "smithy.api#documentation": "

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 \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.

\n " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloud9#UpdateEnvironmentResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.cloud9#UserArn": { "type": "string", diff --git a/codegen/sdk/aws-models/cloudformation.json b/codegen/sdk/aws-models/cloudformation.json index 432c12d8a05b..f0751d187a14 100644 --- a/codegen/sdk/aws-models/cloudformation.json +++ b/codegen/sdk/aws-models/cloudformation.json @@ -456,7 +456,10 @@ "type": "structure", "members": { "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" + "target": "com.amazonaws.cloudformation#ErrorMessage", + "traits": { + "smithy.api#documentation": "

An message with details about the error that occurred.

" + } } }, "traits": { @@ -1343,52 +1346,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", @@ -1396,13 +1403,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -1412,92 +1428,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://cloudformation-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://cloudformation-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" + ] + } ] } ], @@ -1506,155 +1513,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://cloudformation.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://cloudformation-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] + "endpoint": { + "url": "https://cloudformation.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://cloudformation-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://cloudformation.{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://cloudformation.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://cloudformation.{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://cloudformation.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -1668,9 +1635,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "af-south-1", "UseFIPS": false, - "Region": "af-south-1" + "UseDualStack": false } }, { @@ -1681,9 +1648,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-east-1", "UseFIPS": false, - "Region": "ap-east-1" + "UseDualStack": false } }, { @@ -1694,9 +1661,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-northeast-1", "UseFIPS": false, - "Region": "ap-northeast-1" + "UseDualStack": false } }, { @@ -1707,9 +1674,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-northeast-2", "UseFIPS": false, - "Region": "ap-northeast-2" + "UseDualStack": false } }, { @@ -1720,9 +1687,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-northeast-3", "UseFIPS": false, - "Region": "ap-northeast-3" + "UseDualStack": false } }, { @@ -1733,9 +1700,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-south-1", "UseFIPS": false, - "Region": "ap-south-1" + "UseDualStack": false } }, { @@ -1746,9 +1713,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-southeast-1", "UseFIPS": false, - "Region": "ap-southeast-1" + "UseDualStack": false } }, { @@ -1759,9 +1726,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-southeast-2", "UseFIPS": false, - "Region": "ap-southeast-2" + "UseDualStack": false } }, { @@ -1772,9 +1739,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ap-southeast-3", "UseFIPS": false, - "Region": "ap-southeast-3" + "UseDualStack": false } }, { @@ -1785,9 +1752,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "ca-central-1", "UseFIPS": false, - "Region": "ca-central-1" + "UseDualStack": false } }, { @@ -1798,9 +1765,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-central-1", "UseFIPS": false, - "Region": "eu-central-1" + "UseDualStack": false } }, { @@ -1811,9 +1778,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-north-1", "UseFIPS": false, - "Region": "eu-north-1" + "UseDualStack": false } }, { @@ -1824,9 +1791,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-south-1", "UseFIPS": false, - "Region": "eu-south-1" + "UseDualStack": false } }, { @@ -1837,9 +1804,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-west-1", "UseFIPS": false, - "Region": "eu-west-1" + "UseDualStack": false } }, { @@ -1850,9 +1817,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-west-2", "UseFIPS": false, - "Region": "eu-west-2" + "UseDualStack": false } }, { @@ -1863,9 +1830,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "eu-west-3", "UseFIPS": false, - "Region": "eu-west-3" + "UseDualStack": false } }, { @@ -1876,9 +1843,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "me-south-1", "UseFIPS": false, - "Region": "me-south-1" + "UseDualStack": false } }, { @@ -1889,9 +1856,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "sa-east-1", "UseFIPS": false, - "Region": "sa-east-1" + "UseDualStack": false } }, { @@ -1902,9 +1869,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, - "Region": "us-east-1" + "UseDualStack": false } }, { @@ -1915,9 +1882,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": true, - "Region": "us-east-1" + "UseDualStack": false } }, { @@ -1928,9 +1895,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-east-2", "UseFIPS": false, - "Region": "us-east-2" + "UseDualStack": false } }, { @@ -1941,9 +1908,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-east-2", "UseFIPS": true, - "Region": "us-east-2" + "UseDualStack": false } }, { @@ -1954,9 +1921,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-1", "UseFIPS": false, - "Region": "us-west-1" + "UseDualStack": false } }, { @@ -1967,9 +1934,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-1", "UseFIPS": true, - "Region": "us-west-1" + "UseDualStack": false } }, { @@ -1980,9 +1947,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-2", "UseFIPS": false, - "Region": "us-west-2" + "UseDualStack": false } }, { @@ -1993,9 +1960,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-west-2", "UseFIPS": true, - "Region": "us-west-2" + "UseDualStack": false } }, { @@ -2006,9 +1973,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": true, - "Region": "us-east-1" + "UseDualStack": true } }, { @@ -2019,9 +1986,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": false, - "Region": "us-east-1" + "UseDualStack": true } }, { @@ -2032,9 +1999,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": false, - "Region": "cn-north-1" + "UseDualStack": false } }, { @@ -2045,9 +2012,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "cn-northwest-1", "UseFIPS": false, - "Region": "cn-northwest-1" + "UseDualStack": false } }, { @@ -2058,9 +2025,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": true, - "Region": "cn-north-1" + "UseDualStack": true } }, { @@ -2071,9 +2038,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": true, - "Region": "cn-north-1" + "UseDualStack": false } }, { @@ -2084,9 +2051,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": false, - "Region": "cn-north-1" + "UseDualStack": true } }, { @@ -2097,9 +2064,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-gov-east-1", "UseFIPS": false, - "Region": "us-gov-east-1" + "UseDualStack": false } }, { @@ -2110,9 +2077,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-gov-east-1", "UseFIPS": true, - "Region": "us-gov-east-1" + "UseDualStack": false } }, { @@ -2123,9 +2090,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-gov-west-1", "UseFIPS": false, - "Region": "us-gov-west-1" + "UseDualStack": false } }, { @@ -2136,9 +2103,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-gov-west-1", "UseFIPS": true, - "Region": "us-gov-west-1" + "UseDualStack": false } }, { @@ -2149,9 +2116,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": true, - "Region": "us-gov-east-1" + "UseDualStack": true } }, { @@ -2162,9 +2129,9 @@ } }, "params": { - "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": false, - "Region": "us-gov-east-1" + "UseDualStack": true } }, { @@ -2175,9 +2142,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-iso-east-1", "UseFIPS": false, - "Region": "us-iso-east-1" + "UseDualStack": false } }, { @@ -2188,9 +2155,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-iso-west-1", "UseFIPS": false, - "Region": "us-iso-west-1" + "UseDualStack": false } }, { @@ -2199,9 +2166,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, + "Region": "us-iso-east-1", "UseFIPS": true, - "Region": "us-iso-east-1" + "UseDualStack": true } }, { @@ -2212,9 +2179,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-iso-east-1", "UseFIPS": true, - "Region": "us-iso-east-1" + "UseDualStack": false } }, { @@ -2223,9 +2190,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, + "Region": "us-iso-east-1", "UseFIPS": false, - "Region": "us-iso-east-1" + "UseDualStack": true } }, { @@ -2236,9 +2203,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-isob-east-1", "UseFIPS": false, - "Region": "us-isob-east-1" + "UseDualStack": false } }, { @@ -2247,9 +2214,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, + "Region": "us-isob-east-1", "UseFIPS": true, - "Region": "us-isob-east-1" + "UseDualStack": true } }, { @@ -2260,9 +2227,9 @@ } }, "params": { - "UseDualStack": false, + "Region": "us-isob-east-1", "UseFIPS": true, - "Region": "us-isob-east-1" + "UseDualStack": false } }, { @@ -2271,9 +2238,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, + "Region": "us-isob-east-1", "UseFIPS": false, - "Region": "us-isob-east-1" + "UseDualStack": true } }, { @@ -2284,9 +2251,9 @@ } }, "params": { - "UseDualStack": false, - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2298,8 +2265,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2309,9 +2276,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, - "UseFIPS": true, "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2321,9 +2288,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } }, @@ -2711,6 +2678,12 @@ "traits": { "smithy.api#documentation": "

Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with\n termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From\n Being Deleted in the CloudFormation User Guide. Termination protection is deactivated on stacks\n by default.

\n

For nested\n stacks, termination protection is set on the root stack and can't be changed directly on the nested\n stack.

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

This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.

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

Preserves the state of previously provisioned resources when an operation\n fails. This parameter can't be specified when\n the OnStackFailure parameter to the CreateChangeSet API operation was\n specified.

\n \n

Default: True\n

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

This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.

" + } } }, "traits": { @@ -9123,6 +9102,9 @@ "target": "com.amazonaws.cloudformation#ResourceToSkip" } }, + "com.amazonaws.cloudformation#RetainExceptOnCreate": { + "type": "boolean" + }, "com.amazonaws.cloudformation#RetainResources": { "type": "list", "member": { @@ -9218,6 +9200,12 @@ "traits": { "smithy.api#documentation": "

A unique identifier for this RollbackStack request.

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

This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.

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

Information about whether a stack's actual configuration differs, or has drifted, from its\n expected configuration, as defined in the stack template and any values specified as template parameters. For more\n information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

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

This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.

" + } } }, "traits": { @@ -12289,7 +12283,10 @@ "type": "structure", "members": { "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" + "target": "com.amazonaws.cloudformation#ErrorMessage", + "traits": { + "smithy.api#documentation": "

An message with details about the error that occurred.

" + } } }, "traits": { @@ -12355,7 +12352,10 @@ "type": "structure", "members": { "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" + "target": "com.amazonaws.cloudformation#ErrorMessage", + "traits": { + "smithy.api#documentation": "

An message with details about the error that occurred.

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

A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry\n UpdateStack requests to ensure that CloudFormation successfully received them.

\n

All events triggered by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

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

This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/cloudfront.json b/codegen/sdk/aws-models/cloudfront.json index e144a0f18e83..dabc40a62176 100644 --- a/codegen/sdk/aws-models/cloudfront.json +++ b/codegen/sdk/aws-models/cloudfront.json @@ -112,7 +112,7 @@ "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

This field is true if any of the Amazon Web Services accounts in the list have active\n\t\t\tCloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed\n\t\t\tcookies. If not, this field is false.

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

This field is true if any of the Amazon Web Services accounts in the list are configured as\n\t\t\ttrusted signers. If not, this field is false.

", "smithy.api#required": {} } }, @@ -2804,6 +2804,9 @@ { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToKeyGroup" }, + { + "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToOriginAccessControl" + }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToOriginRequestPolicy" }, @@ -2854,7 +2857,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a staging distribution using the configuration of the provided primary\n\t\t\tdistribution. A staging distribution is a copy of an existing distribution (called the\n\t\t\tprimary distribution) that you can use in a continuous deployment workflow.

\n

After you create a staging distribution, you can use UpdateDistribution\n\t\t\tto modify the staging distribution's configuration. Then you can use\n\t\t\t\tCreateContinuousDeploymentPolicy to incrementally move traffic to the\n\t\t\tstaging distribution.

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

Creates a staging distribution using the configuration of the provided primary\n\t\t\tdistribution. A staging distribution is a copy of an existing distribution (called the\n\t\t\tprimary distribution) that you can use in a continuous deployment workflow.

\n

After you create a staging distribution, you can use UpdateDistribution\n\t\t\tto modify the staging distribution's configuration. Then you can use\n\t\t\t\tCreateContinuousDeploymentPolicy to incrementally move traffic to the\n\t\t\tstaging distribution.

\n

This API operation requires the following IAM permissions:

\n ", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/distribution/{PrimaryDistributionId}/copy", @@ -2893,6 +2896,12 @@ "smithy.api#documentation": "

A value that uniquely identifies a request to create a resource. This helps to prevent\n\t\t\tCloudFront from creating a duplicate resource if you accidentally resubmit an identical\n\t\t\trequest.

", "smithy.api#required": {} } + }, + "Enabled": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean flag to specify the state of the staging distribution when it's\n\t\t\tcreated. When you set this value to True, the staging\n\t\t\tdistribution is enabled. When you set this value to False, the\n\t\t\tstaging distribution is disabled.

\n

If you omit this field, the default value is True.

" + } } }, "traits": { @@ -2922,6 +2931,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CreateCachePolicy": { @@ -3008,6 +3020,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CreateCloudFrontOriginAccessIdentity": { @@ -3088,7 +3103,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CreateContinuousDeploymentPolicy": { @@ -3169,6 +3185,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CreateDistribution": { @@ -3429,7 +3448,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CreateDistributionWithTags": { @@ -3456,6 +3476,9 @@ { "target": "com.amazonaws.cloudfront#IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior" }, + { + "target": "com.amazonaws.cloudfront#IllegalOriginAccessConfiguration" + }, { "target": "com.amazonaws.cloudfront#InconsistentQuantities" }, @@ -3585,6 +3608,9 @@ { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToKeyGroup" }, + { + "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToOriginAccessControl" + }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToOriginRequestPolicy" }, @@ -3635,7 +3661,7 @@ } ], "traits": { - "smithy.api#documentation": "

Create a new distribution with tags.

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

Create a new distribution with tags. This API operation requires the following IAM\n\t\t\tpermissions:

\n ", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/distribution?WithTags", @@ -3687,7 +3713,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CreateFieldLevelEncryptionConfig": { @@ -3774,6 +3801,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CreateFieldLevelEncryptionProfile": { @@ -3860,6 +3890,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CreateFunction": { @@ -3949,6 +3982,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CreateInvalidation": { @@ -4036,7 +4072,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CreateKeyGroup": { @@ -4111,6 +4148,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CreateMonitoringSubscription": { @@ -4179,6 +4219,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CreateOriginAccessControl": { @@ -4250,6 +4293,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CreateOriginRequestPolicy": { @@ -4336,6 +4382,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CreatePublicKey": { @@ -4407,6 +4456,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CreateRealtimeLogConfig": { @@ -4485,6 +4537,9 @@ "smithy.api#documentation": "

A real-time log configuration.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CreateResponseHeadersPolicy": { @@ -4571,6 +4626,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CreateStreamingDistribution": { @@ -4675,7 +4733,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CreateStreamingDistributionWithTags": { @@ -4783,7 +4842,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#CustomErrorResponse": { @@ -5547,7 +5607,10 @@ }, "com.amazonaws.cloudfront#DeleteMonitoringSubscriptionResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.cloudfront#DeleteOriginAccessControl": { "type": "operation", @@ -5957,6 +6020,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#Distribution": { @@ -7149,7 +7215,7 @@ "Runtime": { "target": "com.amazonaws.cloudfront#FunctionRuntime", "traits": { - "smithy.api#documentation": "

The function's runtime environment. The only valid value is\n\t\t\t\tcloudfront-js-1.0.

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

The function's runtime environment verion.

", "smithy.api#required": {} } } @@ -7276,6 +7342,12 @@ "traits": { "smithy.api#enumValue": "cloudfront-js-1.0" } + }, + "cloudfront_js_2_0": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cloudfront-js-2.0" + } } } }, @@ -7487,6 +7559,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetCachePolicyRequest": { @@ -7522,6 +7597,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentity": { @@ -7610,7 +7688,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityRequest": { @@ -7649,7 +7728,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetContinuousDeploymentPolicy": { @@ -7734,6 +7814,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetContinuousDeploymentPolicyRequest": { @@ -7769,6 +7852,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetDistribution": { @@ -7875,7 +7961,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetDistributionRequest": { @@ -7914,7 +8001,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetFieldLevelEncryption": { @@ -8000,6 +8088,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetFieldLevelEncryptionProfile": { @@ -8085,6 +8176,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetFieldLevelEncryptionProfileRequest": { @@ -8120,6 +8214,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetFieldLevelEncryptionRequest": { @@ -8155,6 +8252,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetFunction": { @@ -8229,6 +8329,9 @@ "smithy.api#httpHeader": "Content-Type" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetInvalidation": { @@ -8314,7 +8417,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetKeyGroup": { @@ -8394,6 +8498,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetKeyGroupRequest": { @@ -8429,6 +8536,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetMonitoringSubscription": { @@ -8488,6 +8598,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetOriginAccessControl": { @@ -8573,6 +8686,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetOriginAccessControlRequest": { @@ -8608,6 +8724,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetOriginRequestPolicy": { @@ -8693,6 +8812,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetOriginRequestPolicyRequest": { @@ -8728,6 +8850,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetPublicKey": { @@ -8813,6 +8938,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetPublicKeyRequest": { @@ -8848,6 +8976,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetRealtimeLogConfig": { @@ -8907,6 +9038,9 @@ "smithy.api#documentation": "

A real-time log configuration.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetResponseHeadersPolicy": { @@ -8992,6 +9126,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetResponseHeadersPolicyRequest": { @@ -9027,6 +9164,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetStreamingDistribution": { @@ -9133,7 +9273,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#GetStreamingDistributionRequest": { @@ -9172,7 +9313,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#HeaderList": { @@ -10161,6 +10303,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListCloudFrontOriginAccessIdentities": { @@ -10226,7 +10371,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListConflictingAliases": { @@ -10302,6 +10448,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListContinuousDeploymentPolicies": { @@ -10364,6 +10513,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListDistributions": { @@ -10462,6 +10614,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListDistributionsByKeyGroup": { @@ -10528,6 +10683,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListDistributionsByOriginRequestPolicyId": { @@ -10598,6 +10756,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListDistributionsByRealtimeLogConfig": { @@ -10663,6 +10824,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListDistributionsByResponseHeadersPolicyId": { @@ -10732,6 +10896,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListDistributionsByWebACLId": { @@ -10802,7 +10969,8 @@ } }, "traits": { - "smithy.api#documentation": "

The response to a request to list the distributions that are associated with a\n\t\t\tspecified WAF web ACL.

" + "smithy.api#documentation": "

The response to a request to list the distributions that are associated with a\n\t\t\tspecified WAF web ACL.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListDistributionsRequest": { @@ -10840,7 +11008,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListFieldLevelEncryptionConfigs": { @@ -10897,6 +11066,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListFieldLevelEncryptionProfiles": { @@ -10953,6 +11125,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListFunctions": { @@ -11019,6 +11194,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListInvalidations": { @@ -11098,7 +11276,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListKeyGroups": { @@ -11155,6 +11334,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListOriginAccessControls": { @@ -11211,6 +11393,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListOriginRequestPolicies": { @@ -11280,6 +11465,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListPublicKeys": { @@ -11336,6 +11524,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListRealtimeLogConfigs": { @@ -11398,6 +11589,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListResponseHeadersPolicies": { @@ -11467,6 +11661,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListStreamingDistributions": { @@ -11532,7 +11729,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ListTagsForResource": { @@ -11596,7 +11794,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#LocationList": { @@ -13287,6 +13486,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#QueryArgProfile": { @@ -15197,6 +15399,9 @@ "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#TestResult": { @@ -16009,7 +16214,7 @@ "Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

This field is true if any of the Amazon Web Services accounts have public keys that\n\t\t\tCloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this\n\t\t\tfield is false.

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

This field is true if any of the Amazon Web Services accounts in the list are configured as\n\t\t\ttrusted signers. If not, this field is false.

", "smithy.api#required": {} } }, @@ -16202,6 +16407,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#UpdateCloudFrontOriginAccessIdentity": { @@ -16299,7 +16507,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#UpdateContinuousDeploymentPolicy": { @@ -16391,6 +16600,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#UpdateDistribution": { @@ -16549,6 +16761,9 @@ { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToKeyGroup" }, + { + "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToOriginAccessControl" + }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToOriginRequestPolicy" }, @@ -16659,7 +16874,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#UpdateDistributionWithStagingConfig": { @@ -16803,6 +17019,9 @@ { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToKeyGroup" }, + { + "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToOriginAccessControl" + }, { "target": "com.amazonaws.cloudfront#TooManyDistributionsAssociatedToOriginRequestPolicy" }, @@ -16853,7 +17072,7 @@ } ], "traits": { - "smithy.api#documentation": "

Copies the staging distribution's configuration to its corresponding primary\n\t\t\tdistribution. The primary distribution retains its Aliases (also known as\n\t\t\talternate domain names or CNAMEs) and ContinuousDeploymentPolicyId value,\n\t\t\tbut otherwise its configuration is overwritten to match the staging distribution.

\n

You can use this operation in a continuous deployment workflow after you have tested\n\t\t\tconfiguration changes on the staging distribution. After using a continuous deployment\n\t\t\tpolicy to move a portion of your domain name's traffic to the staging distribution and\n\t\t\tverifying that it works as intended, you can use this operation to copy the staging\n\t\t\tdistribution's configuration to the primary distribution. This action will disable the\n\t\t\tcontinuous deployment policy and move your domain's traffic back to the primary distribution.

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

Copies the staging distribution's configuration to its corresponding primary\n\t\t\tdistribution. The primary distribution retains its Aliases (also known as\n\t\t\talternate domain names or CNAMEs) and ContinuousDeploymentPolicyId value,\n\t\t\tbut otherwise its configuration is overwritten to match the staging distribution.

\n

You can use this operation in a continuous deployment workflow after you have tested\n\t\t\tconfiguration changes on the staging distribution. After using a continuous deployment\n\t\t\tpolicy to move a portion of your domain name's traffic to the staging distribution and\n\t\t\tverifying that it works as intended, you can use this operation to copy the staging\n\t\t\tdistribution's configuration to the primary distribution. This action will disable the\n\t\t\tcontinuous deployment policy and move your domain's traffic back to the primary distribution.

\n

This API operation requires the following IAM permissions:

\n ", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/distribution/{Id}/promote-staging-config", @@ -16907,6 +17126,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionConfig": { @@ -17010,6 +17232,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionProfile": { @@ -17116,6 +17341,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#UpdateFunction": { @@ -17210,6 +17438,9 @@ "smithy.api#httpHeader": "ETtag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#UpdateKeyGroup": { @@ -17298,6 +17529,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#UpdateOriginAccessControl": { @@ -17389,6 +17623,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#UpdateOriginRequestPolicy": { @@ -17492,6 +17729,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#UpdatePublicKey": { @@ -17583,6 +17823,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#UpdateRealtimeLogConfig": { @@ -17660,6 +17903,9 @@ "smithy.api#documentation": "

A real-time log configuration.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#UpdateResponseHeadersPolicy": { @@ -17763,6 +18009,9 @@ "smithy.api#httpHeader": "ETag" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#UpdateStreamingDistribution": { @@ -17878,7 +18127,8 @@ } }, "traits": { - "smithy.api#documentation": "

The returned result of the corresponding request.

" + "smithy.api#documentation": "

The returned result of the corresponding request.

", + "smithy.api#output": {} } }, "com.amazonaws.cloudfront#ViewerCertificate": { diff --git a/codegen/sdk/aws-models/cloudtrail.json b/codegen/sdk/aws-models/cloudtrail.json index a2cd6425b2a5..eb2ee584425b 100644 --- a/codegen/sdk/aws-models/cloudtrail.json +++ b/codegen/sdk/aws-models/cloudtrail.json @@ -246,7 +246,7 @@ "Field": { "target": "com.amazonaws.cloudtrail#SelectorField", "traits": { - "smithy.api#documentation": "

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.

\n

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 ", + "smithy.api#documentation": "

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.

\n

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 ", "smithy.api#required": {} } }, @@ -845,52 +845,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", @@ -898,13 +902,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -914,92 +927,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://cloudtrail-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://cloudtrail-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" + ] + } ] } ], @@ -1008,168 +1012,128 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } + "ref": "Region" + }, + "us-gov-east-1" ] } ], - "type": "tree", - "rules": [ + "endpoint": { + "url": "https://cloudtrail.us-gov-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "us-gov-east-1" - ] - } - ], - "endpoint": { - "url": "https://cloudtrail.us-gov-east-1.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, + "fn": "stringEquals", + "argv": [ { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "us-gov-west-1" - ] - } - ], - "endpoint": { - "url": "https://cloudtrail.us-gov-west-1.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "ref": "Region" }, - { - "conditions": [], - "endpoint": { - "url": "https://cloudtrail-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "us-gov-west-1" ] } - ] + ], + "endpoint": { + "url": "https://cloudtrail.us-gov-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://cloudtrail-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://cloudtrail.{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://cloudtrail.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://cloudtrail.{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://cloudtrail.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -2109,7 +2073,7 @@ "RetentionPeriod": { "target": "com.amazonaws.cloudtrail#RetentionPeriod", "traits": { - "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.

" + "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.

\n \n

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.

\n " } }, "TerminationProtectionEnabled": { @@ -2497,7 +2461,7 @@ "Type": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

The resource type in which you want to log data events. You can specify the following\n basic event selector resource types:

\n \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 " + "smithy.api#documentation": "

The resource type in which you want to log data events. You can specify the following\n basic event selector resource types:

\n \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 " } }, "Values": { @@ -6414,7 +6378,7 @@ "code": "MaxConcurrentQueries", "httpResponseCode": 429 }, - "smithy.api#documentation": "

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.

\n \n

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.

\n " } }, "TerminationProtectionEnabled": { diff --git a/codegen/sdk/aws-models/codestar-connections.json b/codegen/sdk/aws-models/codestar-connections.json index 0d83c6e9ed69..ec4ec621cafc 100644 --- a/codegen/sdk/aws-models/codestar-connections.json +++ b/codegen/sdk/aws-models/codestar-connections.json @@ -36,7 +36,7 @@ "min": 12, "max": 12 }, - "smithy.api#pattern": "[0-9]{12}" + "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.codestarconnections#AmazonResourceName": { @@ -46,7 +46,7 @@ "min": 1, "max": 1011 }, - "smithy.api#pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+" + "smithy.api#pattern": "^arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+$" } }, "com.amazonaws.codestarconnections#CodeStar_connections_20191201": { @@ -102,7 +102,7 @@ "name": "codestar-connections" }, "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "AWS CodeStar Connections\n

This AWS CodeStar Connections API Reference provides descriptions and usage examples of\n the operations and data types for the AWS CodeStar Connections API. You can use the\n connections API to work with connections and installations.

\n

\n Connections are configurations that you use to connect AWS\n resources to external code repositories. Each connection is a resource that can be given to\n services such as CodePipeline to connect to a third-party repository such as Bitbucket. For\n example, you can add the connection in CodePipeline so that it triggers your pipeline when a\n code change is made to your third-party code repository. Each connection is named and\n associated with a unique ARN that is used to reference the connection.

\n

When you create a connection, the console initiates a third-party connection handshake.\n Installations are the apps that are used to conduct this handshake. For\n example, the installation for the Bitbucket provider type is the Bitbucket app. When you\n create a connection, you can choose an existing installation or create one.

\n

When you want to create a connection to an installed provider type such as GitHub\n Enterprise Server, you create a host for your connections.

\n

You can work with connections by calling:

\n \n

You can work with hosts by calling:

\n \n

You can work with tags in AWS CodeStar Connections by calling the following:

\n \n

For information about how to use AWS CodeStar Connections, see the Developer Tools User\n Guide.

", + "smithy.api#documentation": "AWS CodeStar Connections\n

This Amazon Web Services CodeStar Connections API Reference provides descriptions and usage examples of\n the operations and data types for the Amazon Web Services CodeStar Connections API. You can use the\n connections API to work with connections and installations.

\n

\n Connections are configurations that you use to connect Amazon Web Services\n resources to external code repositories. Each connection is a resource that can be given to\n services such as CodePipeline to connect to a third-party repository such as Bitbucket. For\n example, you can add the connection in CodePipeline so that it triggers your pipeline when a\n code change is made to your third-party code repository. Each connection is named and\n associated with a unique ARN that is used to reference the connection.

\n

When you create a connection, the console initiates a third-party connection handshake.\n Installations are the apps that are used to conduct this handshake. For\n example, the installation for the Bitbucket provider type is the Bitbucket app. When you\n create a connection, you can choose an existing installation or create one.

\n

When you want to create a connection to an installed provider type such as GitHub\n Enterprise Server, you create a host for your connections.

\n

You can work with connections by calling:

\n \n

You can work with hosts by calling:

\n \n

You can work with tags in Amazon Web Services CodeStar Connections by calling the following:

\n \n

For information about how to use Amazon Web Services CodeStar Connections, see the Developer Tools User\n Guide.

", "smithy.api#title": "AWS CodeStar connections", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -984,13 +984,13 @@ "ConnectionName": { "target": "com.amazonaws.codestarconnections#ConnectionName", "traits": { - "smithy.api#documentation": "

The name of the connection. Connection names must be unique in an AWS user account.

" + "smithy.api#documentation": "

The name of the connection. Connection names must be unique in an Amazon Web Services account.

" } }, "ConnectionArn": { "target": "com.amazonaws.codestarconnections#ConnectionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection\n reference when the connection is shared between AWS services.

\n \n

The ARN is never reused if the connection is deleted.

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

The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection\n reference when the connection is shared between Amazon Web Services.

\n \n

The ARN is never reused if the connection is deleted.

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

A resource that is used to connect third-party source providers with services like AWS CodePipeline.

\n

Note: A connection created through CloudFormation, the CLI, or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by updating the \n connection in the console.

" + "smithy.api#documentation": "

A resource that is used to connect third-party source providers with services like CodePipeline.

\n

Note: A connection created through CloudFormation, the CLI, or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by updating the \n connection in the console.

" } }, "com.amazonaws.codestarconnections#ConnectionArn": { @@ -1029,7 +1029,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+" + "smithy.api#pattern": "^arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+$" } }, "com.amazonaws.codestarconnections#ConnectionList": { @@ -1045,26 +1045,30 @@ "min": 1, "max": 32 }, - "smithy.api#pattern": "[\\s\\S]*" + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.codestarconnections#ConnectionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "ERROR", - "name": "ERROR" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" } - ] + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } } }, "com.amazonaws.codestarconnections#CreateConnection": { @@ -1087,7 +1091,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a connection that can then be given to other AWS services like CodePipeline so\n that it can access third-party code repositories. The connection is in pending status until\n the third-party connection handshake is completed from the console.

" + "smithy.api#documentation": "

Creates a connection that can then be given to other Amazon Web Services services like CodePipeline so\n that it can access third-party code repositories. The connection is in pending status until\n the third-party connection handshake is completed from the console.

" } }, "com.amazonaws.codestarconnections#CreateConnectionInput": { @@ -1102,7 +1106,7 @@ "ConnectionName": { "target": "com.amazonaws.codestarconnections#ConnectionName", "traits": { - "smithy.api#documentation": "

The name of the connection to be created. The name must be unique in the calling AWS\n account.

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

The name of the connection to be created.

", "smithy.api#required": {} } }, @@ -1118,6 +1122,9 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the host associated with the connection to be created.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#CreateConnectionOutput": { @@ -1126,7 +1133,7 @@ "ConnectionArn": { "target": "com.amazonaws.codestarconnections#ConnectionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the connection to be created. The ARN is used as the\n connection reference when the connection is shared between AWS services.

\n \n

The ARN is never reused if the connection is deleted.

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

The Amazon Resource Name (ARN) of the connection to be created. The ARN is used as the\n connection reference when the connection is shared between Amazon Web Services services.

\n \n

The ARN is never reused if the connection is deleted.

\n ", "smithy.api#required": {} } }, @@ -1136,6 +1143,9 @@ "smithy.api#documentation": "

Specifies the tags applied to the resource.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codestarconnections#CreateHost": { @@ -1161,7 +1171,7 @@ "Name": { "target": "com.amazonaws.codestarconnections#HostName", "traits": { - "smithy.api#documentation": "

The name of the host to be created. The name must be unique in the calling AWS\n account.

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

The name of the host to be created.

", "smithy.api#required": {} } }, @@ -1188,6 +1198,9 @@ "Tags": { "target": "com.amazonaws.codestarconnections#TagList" } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#CreateHostOutput": { @@ -1202,6 +1215,9 @@ "Tags": { "target": "com.amazonaws.codestarconnections#TagList" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codestarconnections#DeleteConnection": { @@ -1231,11 +1247,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#DeleteConnectionOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.codestarconnections#DeleteHost": { "type": "operation", @@ -1267,11 +1289,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#DeleteHostOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.codestarconnections#ErrorMessage": { "type": "string", @@ -1312,6 +1340,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#GetConnectionOutput": { @@ -1323,6 +1354,9 @@ "smithy.api#documentation": "

The connection details, such as status, owner, and provider type.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codestarconnections#GetHost": { @@ -1355,6 +1389,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#GetHostOutput": { @@ -1390,6 +1427,9 @@ "smithy.api#documentation": "

The VPC configuration of the requested host.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codestarconnections#Host": { @@ -1449,7 +1489,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "arn:aws(-[\\w]+)*:codestar-connections:.+:[0-9]{12}:host\\/.+" + "smithy.api#pattern": "^arn:aws(-[\\w]+)*:codestar-connections:.+:[0-9]{12}:host\\/.+$" } }, "com.amazonaws.codestarconnections#HostList": { @@ -1502,6 +1542,11 @@ "output": { "target": "com.amazonaws.codestarconnections#ListConnectionsOutput" }, + "errors": [ + { + "target": "com.amazonaws.codestarconnections#ResourceNotFoundException" + } + ], "traits": { "smithy.api#documentation": "

Lists the connections associated with your account.

", "smithy.api#paginated": { @@ -1539,6 +1584,9 @@ "smithy.api#documentation": "

The token that was returned from the previous ListConnections call, which\n can be used to return the next set of connections in the list.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#ListConnectionsOutput": { @@ -1556,6 +1604,9 @@ "smithy.api#documentation": "

A token that can be used in the next ListConnections call. To view all\n items in the list, continue to call this operation with each subsequent token until no more\n nextToken values are returned.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codestarconnections#ListHosts": { @@ -1591,6 +1642,9 @@ "smithy.api#documentation": "

The token that was returned from the previous ListHosts call, which can be\n used to return the next set of hosts in the list.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#ListHostsOutput": { @@ -1608,6 +1662,9 @@ "smithy.api#documentation": "

A token that can be used in the next ListHosts call. To view all items in the\n list, continue to call this operation with each subsequent token until no more\n nextToken values are returned.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codestarconnections#ListTagsForResource": { @@ -1637,6 +1694,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#ListTagsForResourceOutput": { @@ -1648,6 +1708,9 @@ "smithy.api#documentation": "

A list of tag key and value pairs associated with the specified resource.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.codestarconnections#MaxResults": { @@ -1671,22 +1734,32 @@ } }, "com.amazonaws.codestarconnections#ProviderType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Bitbucket", - "name": "BITBUCKET" - }, - { - "value": "GitHub", - "name": "GITHUB" - }, - { - "value": "GitHubEnterpriseServer", - "name": "GITHUB_ENTERPRISE_SERVER" + "type": "enum", + "members": { + "BITBUCKET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bitbucket" } - ] + }, + "GITHUB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GitHub" + } + }, + "GITHUB_ENTERPRISE_SERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GitHubEnterpriseServer" + } + }, + "GITLAB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GitLab" + } + } } }, "com.amazonaws.codestarconnections#ResourceNotFoundException": { @@ -1722,7 +1795,7 @@ "min": 11, "max": 20 }, - "smithy.api#pattern": "sg-\\w{8}(\\w{9})?" + "smithy.api#pattern": "^sg-\\w{8}(\\w{9})?$" } }, "com.amazonaws.codestarconnections#SecurityGroupIds": { @@ -1744,7 +1817,7 @@ "min": 15, "max": 24 }, - "smithy.api#pattern": "subnet-\\w{8}(\\w{9})?" + "smithy.api#pattern": "^subnet-\\w{8}(\\w{9})?$" } }, "com.amazonaws.codestarconnections#SubnetIds": { @@ -1778,7 +1851,7 @@ } }, "traits": { - "smithy.api#documentation": "

A tag is a key-value pair that is used to manage the resource.

\n

This tag is available for use by AWS services that support tags.

" + "smithy.api#documentation": "

A tag is a key-value pair that is used to manage the resource.

\n

This tag is available for use by Amazon Web Services services that support tags.

" } }, "com.amazonaws.codestarconnections#TagKey": { @@ -1852,11 +1925,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#TagResourceOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.codestarconnections#TagValue": { "type": "string", @@ -1875,7 +1954,7 @@ "min": 1, "max": 16384 }, - "smithy.api#pattern": "[\\s\\S]*" + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.codestarconnections#UnsupportedOperationException": { @@ -1905,7 +1984,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes tags from an AWS resource.

" + "smithy.api#documentation": "

Removes tags from an Amazon Web Services resource.

" } }, "com.amazonaws.codestarconnections#UntagResourceInput": { @@ -1925,11 +2004,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#UntagResourceOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.codestarconnections#UpdateHost": { "type": "operation", @@ -1979,11 +2064,17 @@ "smithy.api#documentation": "

The VPC configuration of the host to be updated. A VPC must be configured and the\n infrastructure to be represented by the host must already be connected to the VPC.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.codestarconnections#UpdateHostOutput": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.codestarconnections#Url": { "type": "string", @@ -2037,7 +2128,7 @@ "min": 12, "max": 21 }, - "smithy.api#pattern": "vpc-\\w{8}(\\w{9})?" + "smithy.api#pattern": "^vpc-\\w{8}(\\w{9})?$" } } } diff --git a/codegen/sdk/aws-models/cognito-identity-provider.json b/codegen/sdk/aws-models/cognito-identity-provider.json index eaa43cb6e6ce..ad91599633fa 100644 --- a/codegen/sdk/aws-models/cognito-identity-provider.json +++ b/codegen/sdk/aws-models/cognito-identity-provider.json @@ -30,7 +30,14 @@ }, "shapes": { "com.amazonaws.cognitoidentityprovider#AWSAccountIdType": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]+$" + } }, "com.amazonaws.cognitoidentityprovider#AWSCognitoIdentityProviderService": { "type": "service", @@ -216,6 +223,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#GetIdentityProviderByIdentifier" }, + { + "target": "com.amazonaws.cognitoidentityprovider#GetLogDeliveryConfiguration" + }, { "target": "com.amazonaws.cognitoidentityprovider#GetSigningCertificate" }, @@ -276,6 +286,9 @@ { "target": "com.amazonaws.cognitoidentityprovider#RevokeToken" }, + { + "target": "com.amazonaws.cognitoidentityprovider#SetLogDeliveryConfiguration" + }, { "target": "com.amazonaws.cognitoidentityprovider#SetRiskConfiguration" }, @@ -352,7 +365,7 @@ "name": "cognito-idp" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Using the Amazon Cognito user pools API, you can create a user pool to manage directories and\n users. You can authenticate a user to obtain tokens related to user identity and access\n policies.

\n

This API reference provides information about user pools in Amazon Cognito user pools.

\n

For more information, see the Amazon Cognito\n Documentation.

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

With the Amazon Cognito user pools API, you can set up user pools and app clients, and\n authenticate users. To authenticate users from third-party identity providers (IdPs) in\n this API, you can link IdP users to native user profiles. Learn more\n about the authentication and authorization of federated users in the Using the Amazon Cognito user pools API and user pool endpoints.

\n

This API reference provides detailed information about API operations and object types\n in Amazon Cognito. At the bottom of the page for each API operation and object, under\n See Also, you can learn how to use it in an Amazon Web Services SDK in the\n language of your choice.

\n

Along with resource management operations, the Amazon Cognito user pools API includes classes\n of operations and authorization models for client-side and server-side user operations.\n For more information, see Using the Amazon Cognito native and OIDC APIs in the\n Amazon Cognito Developer Guide.

\n

You can also start reading about the CognitoIdentityProvider client in\n the following SDK guides.

\n \n

To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services. For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services\n SDKs.

", "smithy.api#title": "Amazon Cognito Identity Provider", "smithy.api#xmlNamespace": { "uri": "http://cognito-idp.amazonaws.com/doc/2016-04-18/" @@ -1453,7 +1466,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds additional user attributes to the user pool schema.

" + "smithy.api#documentation": "

Adds additional user attributes to the user pool schema.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AddCustomAttributesRequest": { @@ -1516,7 +1529,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds the specified user to the specified group.

\n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Adds the specified user to the specified group.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminAddUserToGroupRequest": { @@ -1592,7 +1605,7 @@ } ], "traits": { - "smithy.api#documentation": "

Confirms user registration as an admin without using a confirmation code. Works on any\n user.

\n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Confirms user registration as an admin without using a confirmation code. Works on any\n user.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminConfirmSignUpRequest": { @@ -1620,7 +1633,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the request to confirm user registration.

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

Confirm a user's registration as a user pool administrator.

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

Creates a new user in the specified user pool.

\n

If MessageAction isn't set, the default is to send a welcome message via\n email or phone (SMS).

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

This message is based on a template that you configured in your call to create or\n update a user pool. This template includes your custom sign-up instructions and\n placeholders for user name and temporary password.

\n

Alternatively, you can call AdminCreateUser with SUPPRESS\n for the MessageAction parameter, and Amazon Cognito won't send any email.

\n

In either case, the user will be in the FORCE_CHANGE_PASSWORD state until\n they sign in and change their password.

\n

\n AdminCreateUser requires developer credentials.

" + "smithy.api#documentation": "

Creates a new user in the specified user pool.

\n

If MessageAction isn't set, the default is to send a welcome message via\n email or phone (SMS).

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

This message is based on a template that you configured in your call to create or\n update a user pool. This template includes your custom sign-up instructions and\n placeholders for user name and temporary password.

\n

Alternatively, you can call AdminCreateUser with SUPPRESS\n for the MessageAction parameter, and Amazon Cognito won't send any email.

\n

In either case, the user will be in the FORCE_CHANGE_PASSWORD state until\n they sign in and change their password.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminCreateUserConfigType": { @@ -1754,7 +1767,7 @@ "TemporaryPassword": { "target": "com.amazonaws.cognitoidentityprovider#PasswordType", "traits": { - "smithy.api#documentation": "

The user's temporary password. This password must conform to the password policy that\n you specified when you created the user pool.

\n

The temporary password is valid only once. To complete the Admin Create User flow, the\n user must enter the temporary password in the sign-in page, along with a new password to\n be used in all future sign-ins.

\n

This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for\n you.

\n

The temporary password can only be used until the user account expiration limit that\n you specified when you created the user pool. To reset the account after that time\n limit, you must call AdminCreateUser again, specifying\n \"RESEND\" for the MessageAction parameter.

" + "smithy.api#documentation": "

The user's temporary password. This password must conform to the password policy that\n you specified when you created the user pool.

\n

The temporary password is valid only once. To complete the Admin Create User flow, the\n user must enter the temporary password in the sign-in page, along with a new password to\n be used in all future sign-ins.

\n

This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for\n you.

\n

The temporary password can only be used until the user account expiration limit that\n you set for your user pool. To reset the account after that time limit, you must call\n AdminCreateUser again and specify RESEND for the\n MessageAction parameter.

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

Deletes a user as an administrator. Works on any user.

\n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Deletes a user as an administrator. Works on any user.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminDeleteUserAttributes": { @@ -1874,7 +1887,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the user attributes in a user pool as an administrator. Works on any\n user.

\n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Deletes the user attributes in a user pool as an administrator. Works on any\n user.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminDeleteUserAttributesRequest": { @@ -1970,7 +1983,7 @@ } ], "traits": { - "smithy.api#documentation": "

Prevents the user from signing in with the specified external (SAML or social)\n identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools\n native username + password user, they can't use their password to sign in. If the user\n to deactivate is a linked external IdP user, any link between that user and an existing\n user is removed. When the external user signs in again, and the user is no longer\n attached to the previously linked DestinationUser, the user must create a\n new user account. See AdminLinkProviderForUser.

\n

This action is enabled only for admin access and requires developer\n credentials.

\n

The ProviderName must match the value specified when creating an IdP for\n the pool.

\n

To deactivate a native username + password user, the ProviderName value\n must be Cognito and the ProviderAttributeName must be\n Cognito_Subject. The ProviderAttributeValue must be the\n name that is used in the user pool for the user.

\n

The ProviderAttributeName must always be Cognito_Subject for\n social IdPs. The ProviderAttributeValue must always be the exact subject\n that was used when the user was originally linked as a source user.

\n

For de-linking a SAML identity, there are two scenarios. If the linked identity has\n not yet been used to sign in, the ProviderAttributeName and\n ProviderAttributeValue must be the same values that were used for the\n SourceUser when the identities were originally linked using \n AdminLinkProviderForUser call. (If the linking was done with\n ProviderAttributeName set to Cognito_Subject, the same\n applies here). However, if the user has already signed in, the\n ProviderAttributeName must be Cognito_Subject and\n ProviderAttributeValue must be the subject of the SAML\n assertion.

" + "smithy.api#documentation": "

Prevents the user from signing in with the specified external (SAML or social)\n identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools\n native username + password user, they can't use their password to sign in. If the user\n to deactivate is a linked external IdP user, any link between that user and an existing\n user is removed. When the external user signs in again, and the user is no longer\n attached to the previously linked DestinationUser, the user must create a\n new user account. See AdminLinkProviderForUser.

\n

The ProviderName must match the value specified when creating an IdP for\n the pool.

\n

To deactivate a native username + password user, the ProviderName value\n must be Cognito and the ProviderAttributeName must be\n Cognito_Subject. The ProviderAttributeValue must be the\n name that is used in the user pool for the user.

\n

The ProviderAttributeName must always be Cognito_Subject for\n social IdPs. The ProviderAttributeValue must always be the exact subject\n that was used when the user was originally linked as a source user.

\n

For de-linking a SAML identity, there are two scenarios. If the linked identity has\n not yet been used to sign in, the ProviderAttributeName and\n ProviderAttributeValue must be the same values that were used for the\n SourceUser when the identities were originally linked using \n AdminLinkProviderForUser call. (If the linking was done with\n ProviderAttributeName set to Cognito_Subject, the same\n applies here). However, if the user has already signed in, the\n ProviderAttributeName must be Cognito_Subject and\n ProviderAttributeValue must be the subject of the SAML\n assertion.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminDisableProviderForUserRequest": { @@ -2031,7 +2044,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deactivates a user and revokes all access tokens for the user. A deactivated user can't sign in, \n but still appears in the responses to GetUser and ListUsers API requests.

\n

You must make this API request with Amazon Web Services credentials that have cognito-idp:AdminDisableUser permissions.

" + "smithy.api#documentation": "

Deactivates a user and revokes all access tokens for the user. A deactivated user\n can't sign in, but still appears in the responses to GetUser and\n ListUsers API requests.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminDisableUserRequest": { @@ -2094,7 +2107,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables the specified user as an administrator. Works on any user.

\n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Enables the specified user as an administrator. Works on any user.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminEnableUserRequest": { @@ -2160,7 +2173,7 @@ } ], "traits": { - "smithy.api#documentation": "

Forgets the device, as an administrator.

\n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Forgets the device, as an administrator.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminForgetDeviceRequest": { @@ -2222,7 +2235,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the device, as an administrator.

\n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Gets the device, as an administrator.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminGetDeviceRequest": { @@ -2300,7 +2313,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the specified user by user name in a user pool as an administrator. Works on any\n user.

\n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Gets the specified user by user name in a user pool as an administrator. Works on any\n user.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminGetUserRequest": { @@ -2332,7 +2345,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The user name of the user about whom you're receiving information.

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

The username of the user that you requested.

", "smithy.api#required": {} } }, @@ -2351,7 +2364,7 @@ "UserLastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The date the user was last modified.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was modified.

" } }, "Enabled": { @@ -2364,7 +2377,7 @@ "UserStatus": { "target": "com.amazonaws.cognitoidentityprovider#UserStatusType", "traits": { - "smithy.api#documentation": "

The user status. Can be one of the following:

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

The user status. Can be one of the following:

\n " } }, "MFAOptions": { @@ -2447,7 +2460,7 @@ } ], "traits": { - "smithy.api#documentation": "

Initiates the authentication flow, as an administrator.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Initiates the authentication flow, as an administrator.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminInitiateAuthRequest": { @@ -2477,7 +2490,7 @@ "AuthParameters": { "target": "com.amazonaws.cognitoidentityprovider#AuthParametersType", "traits": { - "smithy.api#documentation": "

The authentication parameters. These are inputs corresponding to the\n AuthFlow that you're invoking. The required values depend on the value\n of AuthFlow:

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

The authentication parameters. These are inputs corresponding to the\n AuthFlow that you're invoking. The required values depend on the value\n of AuthFlow:

\n \n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

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

Links an existing user account in a user pool (DestinationUser) to an\n identity from an external IdP (SourceUser) based on a specified attribute\n name and value from the external IdP. This allows you to create a link from the existing\n user account to an external federated user identity that has not yet been used to sign\n in. You can then use the federated user identity to sign in as the existing user\n account.

\n

For example, if there is an existing user with a username and password, this API\n links that user to a federated user identity. When the user signs in with a federated\n user identity, they sign in as the existing user account.

\n \n

The maximum number of federated identities linked to a user is five.

\n \n \n

Because this API allows a user with an external federated identity to sign in as\n an existing user in the user pool, it is critical that it only be used with external\n IdPs and provider attributes that have been trusted by the application owner.

\n \n

This action is administrative and requires developer credentials.

" + "smithy.api#documentation": "

Links an existing user account in a user pool (DestinationUser) to an\n identity from an external IdP (SourceUser) based on a specified attribute\n name and value from the external IdP. This allows you to create a link from the existing\n user account to an external federated user identity that has not yet been used to sign\n in. You can then use the federated user identity to sign in as the existing user\n account.

\n

For example, if there is an existing user with a username and password, this API\n links that user to a federated user identity. When the user signs in with a federated\n user identity, they sign in as the existing user account.

\n \n

The maximum number of federated identities linked to a user is five.

\n \n \n

Because this API allows a user with an external federated identity to sign in as\n an existing user in the user pool, it is critical that it only be used with external\n IdPs and provider attributes that have been trusted by the application owner.

\n \n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminLinkProviderForUserRequest": { @@ -2588,14 +2601,14 @@ "DestinationUser": { "target": "com.amazonaws.cognitoidentityprovider#ProviderUserIdentifierType", "traits": { - "smithy.api#documentation": "

The existing user in the user pool that you want to assign to the external IdP user\n account. This user can be a native (Username + Password) Amazon Cognito user pools user or a\n federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito\n generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP\n attribute) signs in.

\n

For a native username + password user, the ProviderAttributeValue for the\n DestinationUser should be the username in the user pool. For a\n federated user, it should be the provider-specific user_id.

\n

The ProviderAttributeName of the DestinationUser is\n ignored.

\n

The ProviderName should be set to Cognito for users in\n Cognito user pools.

\n \n

All attributes in the DestinationUser profile must be mutable. If you have\n assigned the user any immutable custom attributes, the operation won't\n succeed.

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

The existing user in the user pool that you want to assign to the external IdP user\n account. This user can be a local (Username + Password) Amazon Cognito user pools user or a\n federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito\n generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP\n attribute) signs in.

\n

For a native username + password user, the ProviderAttributeValue for the\n DestinationUser should be the username in the user pool. For a\n federated user, it should be the provider-specific user_id.

\n

The ProviderAttributeName of the DestinationUser is\n ignored.

\n

The ProviderName should be set to Cognito for users in\n Cognito user pools.

\n \n

All attributes in the DestinationUser profile must be mutable. If you have\n assigned the user any immutable custom attributes, the operation won't\n succeed.

\n ", "smithy.api#required": {} } }, "SourceUser": { "target": "com.amazonaws.cognitoidentityprovider#ProviderUserIdentifierType", "traits": { - "smithy.api#documentation": "

An external IdP account for a user who doesn't exist yet in the user pool. This user\n must be a federated user (for example, a SAML or Facebook user), not another native\n user.

\n

If the SourceUser is using a federated social IdP, such as Facebook,\n Google, or Login with Amazon, you must set the ProviderAttributeName to\n Cognito_Subject. For social IdPs, the ProviderName will be\n Facebook, Google, or LoginWithAmazon, and\n Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for\n id, sub, and user_id, respectively. The\n ProviderAttributeValue for the user must be the same value as the\n id, sub, or user_id value found in the social\n IdP token.

\n

\n

For SAML, the ProviderAttributeName can be any value that matches a claim\n in the SAML assertion. If you want to link SAML users based on the subject of the SAML\n assertion, you should map the subject to a claim through the SAML IdP and submit that\n claim name as the ProviderAttributeName. If you set\n ProviderAttributeName to Cognito_Subject, Amazon Cognito will\n automatically parse the default unique identifier found in the subject from the SAML\n token.

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

An external IdP account for a user who doesn't exist yet in the user pool. This user\n must be a federated user (for example, a SAML or Facebook user), not another native\n user.

\n

If the SourceUser is using a federated social IdP, such as Facebook,\n Google, or Login with Amazon, you must set the ProviderAttributeName to\n Cognito_Subject. For social IdPs, the ProviderName will be\n Facebook, Google, or LoginWithAmazon, and\n Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for\n id, sub, and user_id, respectively. The\n ProviderAttributeValue for the user must be the same value as the\n id, sub, or user_id value found in the social\n IdP token.

\n

\n

For OIDC, the ProviderAttributeName can be any value that matches a claim\n in the ID token, or that your app retrieves from the userInfo endpoint. You\n must map the claim to a user pool attribute in your IdP configuration, and set the user\n pool attribute name as the value of ProviderAttributeName in your\n AdminLinkProviderForUser request.

\n

For SAML, the ProviderAttributeName can be any value that matches a claim\n in the SAML assertion. To link SAML users based on the subject of the SAML assertion,\n map the subject to a claim through the SAML IdP and set that claim name as the value of\n ProviderAttributeName in your AdminLinkProviderForUser\n request.

\n

For both OIDC and SAML users, when you set ProviderAttributeName to\n Cognito_Subject, Amazon Cognito will automatically parse the default unique\n identifier found in the subject from the IdP token.

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

Lists devices, as an administrator.

\n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Lists devices, as an administrator.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminListDevicesRequest": { @@ -2728,7 +2741,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the groups that the user belongs to.

\n

Calling this action requires developer credentials.

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

Lists the groups that the user belongs to.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2823,7 +2836,7 @@ } ], "traits": { - "smithy.api#documentation": "

A history of user activity and any risks detected as part of Amazon Cognito advanced\n security.

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

A history of user activity and any risks detected as part of Amazon Cognito advanced\n security.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2915,7 +2928,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the specified user from the specified group.

\n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Removes the specified user from the specified group.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminRemoveUserFromGroupRequest": { @@ -2997,7 +3010,7 @@ } ], "traits": { - "smithy.api#documentation": "

Resets the specified user's password in a user pool as an administrator. Works on any\n user.

\n

When a developer calls this API, the current password is invalidated, so it must be\n changed. If a user tries to sign in after the API is called, the app will get a\n PasswordResetRequiredException exception back and should direct the user down the flow\n to reset the password, which is the same as the forgot password flow. In addition, if\n the user pool has phone verification selected and a verified phone number exists for the\n user, or if email verification is selected and a verified email exists for the user,\n calling this API will also result in sending a message to the end user with the code to\n change their password.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Resets the specified user's password in a user pool as an administrator. Works on any\n user.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

Deactivates a user's password, requiring them to change it. If a user tries to sign in\n after the API is called, Amazon Cognito responds with a\n PasswordResetRequiredException error. Your app must then perform the\n actions that reset your user's password: the forgot-password flow. In addition, if the\n user pool has phone verification selected and a verified phone number exists for the\n user, or if email verification is selected and a verified email exists for the user,\n calling this API will also result in sending a message to the end user with the code to\n change their password.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminResetUserPasswordRequest": { @@ -3108,7 +3121,7 @@ } ], "traits": { - "smithy.api#documentation": "

Responds to an authentication challenge, as an administrator.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Responds to an authentication challenge, as an administrator.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminRespondToAuthChallengeRequest": { @@ -3138,7 +3151,7 @@ "ChallengeResponses": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeResponsesType", "traits": { - "smithy.api#documentation": "

The challenge responses. These are inputs corresponding to the value of\n ChallengeName, for example:

\n \n

The value of the USERNAME attribute must be the user's actual username,\n not an alias (such as an email address or phone number). To make this simpler, the\n AdminInitiateAuth response includes the actual username value in the\n USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified\n an alias in your call to AdminInitiateAuth.

" + "smithy.api#documentation": "

The challenge responses. These are inputs corresponding to the value of\n ChallengeName, for example:

\n \n

The value of the USERNAME attribute must be the user's actual username,\n not an alias (such as an email address or phone number). To make this simpler, the\n AdminInitiateAuth response includes the actual username value in the\n USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified\n an alias in your call to AdminInitiateAuth.

\n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

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

The user's multi-factor authentication (MFA) preference, including which MFA options\n are activated, and if any are preferred. Only one factor can be set as preferred. The\n preferred MFA factor will be used to authenticate a user if multiple factors are\n activated. If multiple options are activated and no preference is set, a challenge to\n choose an MFA option will be returned during sign-in.

" + "smithy.api#documentation": "

The user's multi-factor authentication (MFA) preference, including which MFA options\n are activated, and if any are preferred. Only one factor can be set as preferred. The\n preferred MFA factor will be used to authenticate a user if multiple factors are\n activated. If multiple options are activated and no preference is set, a challenge to\n choose an MFA option will be returned during sign-in.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminSetUserMFAPreferenceRequest": { @@ -3312,7 +3325,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the specified user's password in a user pool as an administrator. Works on any\n user.

\n

The password can be temporary or permanent. If it is temporary, the user status enters\n the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the\n InitiateAuth/AdminInitiateAuth response will contain the\n NEW_PASSWORD_REQUIRED challenge. If the user doesn't sign in before it\n expires, the user won't be able to sign in, and an administrator must reset their\n password.

\n

Once the user has set a new password, or the password is permanent, the user status is\n set to Confirmed.

" + "smithy.api#documentation": "

Sets the specified user's password in a user pool as an administrator. Works on any\n user.

\n

The password can be temporary or permanent. If it is temporary, the user status enters\n the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the\n InitiateAuth/AdminInitiateAuth response will contain the\n NEW_PASSWORD_REQUIRED challenge. If the user doesn't sign in before it\n expires, the user won't be able to sign in, and an administrator must reset their\n password.

\n

Once the user has set a new password, or the password is permanent, the user status is\n set to Confirmed.

\n

\n AdminSetUserPassword can set a password for the user profile that Amazon Cognito\n creates for third-party federated users. When you set a password, the federated user's\n status changes from EXTERNAL_PROVIDER to CONFIRMED. A user in\n this state can sign in as a federated user, and initiate authentication flows in the API\n like a linked native user. They can also modify their password and attributes in\n token-authenticated API requests like ChangePassword and\n UpdateUserAttributes. As a best security practice and to keep users in\n sync with your external IdP, don't set passwords on federated user profiles. To set up a\n federated user for native sign-in with a linked native user, refer to Linking federated users to an existing user\n profile.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminSetUserPasswordRequest": { @@ -3384,7 +3397,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n This action is no longer supported. You can use it to configure\n only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software\n token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.

" + "smithy.api#documentation": "

\n This action is no longer supported. You can use it to configure\n only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software\n token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminSetUserSettingsRequest": { @@ -3457,7 +3470,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides feedback for an authentication event indicating if it was from a valid user.\n This feedback is used for improving the risk evaluation decision for the user pool as\n part of Amazon Cognito advanced security.

" + "smithy.api#documentation": "

Provides feedback for an authentication event indicating if it was from a valid user.\n This feedback is used for improving the risk evaluation decision for the user pool as\n part of Amazon Cognito advanced security.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminUpdateAuthEventFeedbackRequest": { @@ -3487,7 +3500,7 @@ "FeedbackValue": { "target": "com.amazonaws.cognitoidentityprovider#FeedbackValueType", "traits": { - "smithy.api#documentation": "

The authentication event feedback value.

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

The authentication event feedback value. When you provide a FeedbackValue\n value of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito\n has evaluated some level of risk. When you provide a FeedbackValue value of\n invalid, you tell Amazon Cognito that you don't trust a user session, or you \n don't believe that Amazon Cognito evaluated a high-enough risk level.

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

Updates the device status as an administrator.

\n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Updates the device status as an administrator.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminUpdateDeviceStatusRequest": { @@ -3632,7 +3645,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified user's attributes, including developer attributes, as an\n administrator. Works on any user.

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

\n

In addition to updating user attributes, this API can also be used to mark phone and\n email as verified.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

Calling this action requires developer credentials.

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

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

Updates the specified user's attributes, including developer attributes, as an\n administrator. Works on any user.

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

\n

In addition to updating user attributes, this API can also be used to mark phone and\n email as verified.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminUpdateUserAttributesRequest": { @@ -3708,7 +3721,7 @@ } ], "traits": { - "smithy.api#documentation": "

Signs out a user from all devices. You must sign AdminUserGlobalSignOut requests\n with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to\n a user. The user's current access and ID tokens remain valid until they expire. By\n default, access and ID tokens expire one hour after they're issued. A user can still use\n a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period\n of 1 hour.

\n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Signs out a user from all devices. AdminUserGlobalSignOut invalidates all\n identity, access and refresh tokens that Amazon Cognito has issued to a user. A user can still\n use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie\n validity period.

\n

Your app isn't aware that a user's access token is revoked unless it attempts to\n authorize a user pools API request with an access token that contains the scope\n aws.cognito.signin.user.admin. Your app might otherwise accept access\n tokens until they expire.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#AdminUserGlobalSignOutRequest": { @@ -3800,12 +3813,12 @@ "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { - "smithy.api#documentation": "

The message that Amazon Cognito sends to the user when the value of an alias attribute is already linked to another user profile.

" + "smithy.api#documentation": "

The message that Amazon Cognito sends to the user when the value of an alias attribute is\n already linked to another user profile.

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

This exception is thrown when a user tries to confirm the account with an email\n address or phone number that has already been supplied as an alias for a different\n user profile. This exception indicates that an account with this email address or phone\n already exists in a user pool that you've configured to use email address or phone\n number as a sign-in alias.

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

This exception is thrown when a user tries to confirm the account with an email\n address or phone number that has already been supplied as an alias for a different user\n profile. This exception indicates that an account with this email address or phone\n already exists in a user pool that you've configured to use email address or phone\n number as a sign-in alias.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3846,7 +3859,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Amazon Pinpoint analytics configuration necessary to collect metrics for a user\n pool.

\n \n

In Regions where Amazon Pinpointisn't available, user pools only support sending events to\n Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools\n support sending events to Amazon Pinpoint projects within that same Region.

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

The Amazon Pinpoint analytics configuration necessary to collect metrics for a user\n pool.

\n \n

In Regions where Amazon Pinpoint isn't available, user pools only support sending\n events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user\n pools support sending events to Amazon Pinpoint projects within that same Region.

\n " } }, "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType": { @@ -3905,7 +3918,7 @@ } ], "traits": { - "smithy.api#documentation": "

Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA)\n for a user, with a unique private key that Amazon Cognito generates and returns in the API\n response. You can authorize an AssociateSoftwareToken request with either\n the user's access token, or a session string from a challenge response that you received\n from Amazon Cognito.

\n \n

Amazon Cognito disassociates an existing software token when you verify the new token in a\n VerifySoftwareToken API request. If you don't verify the software\n token and your user pool doesn't require MFA, the user can then authenticate with\n user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito\n generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge\n each time your user signs. Complete setup with AssociateSoftwareToken\n and VerifySoftwareToken.

\n

After you set up software token MFA for your user, Amazon Cognito generates a\n SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to\n this challenge with your user's TOTP.

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

Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA)\n for a user, with a unique private key that Amazon Cognito generates and returns in the API\n response. You can authorize an AssociateSoftwareToken request with either\n the user's access token, or a session string from a challenge response that you received\n from Amazon Cognito.

\n \n

Amazon Cognito disassociates an existing software token when you verify the new token in a\n VerifySoftwareToken API request. If you don't verify the software\n token and your user pool doesn't require MFA, the user can then authenticate with\n user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito\n generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge\n each time your user signs. Complete setup with AssociateSoftwareToken\n and VerifySoftwareToken.

\n

After you set up software token MFA for your user, Amazon Cognito generates a\n SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to\n this challenge with your user's TOTP.

\n \n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n " } }, "com.amazonaws.cognitoidentityprovider#AssociateSoftwareTokenRequest": { @@ -3934,7 +3947,7 @@ "SecretCode": { "target": "com.amazonaws.cognitoidentityprovider#SecretCodeType", "traits": { - "smithy.api#documentation": "

A unique generated shared secret code that is used in the\n TOTP algorithm to generate a one-time code.

" + "smithy.api#documentation": "

A unique generated shared secret code that is used in the TOTP algorithm to generate a\n one-time code.

" } }, "Session": { @@ -4072,7 +4085,7 @@ "CreationDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The creation date

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was created.

" } }, "EventResponse": { @@ -4248,7 +4261,13 @@ } }, "com.amazonaws.cognitoidentityprovider#CSSType": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 131072 + } + } }, "com.amazonaws.cognitoidentityprovider#CSSVersionType": { "type": "string" @@ -4406,9 +4425,6 @@ }, "value": { "target": "com.amazonaws.cognitoidentityprovider#StringType" - }, - "traits": { - "smithy.api#sensitive": {} } }, "com.amazonaws.cognitoidentityprovider#ChangePassword": { @@ -4456,7 +4472,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Changes the password for a specified user in a user pool.

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

Changes the password for a specified user in a user pool.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n ", "smithy.api#optionalAuth": {} } }, @@ -4554,6 +4570,20 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.cognitoidentityprovider#CloudWatchLogsConfigurationType": { + "type": "structure", + "members": { + "LogGroupArn": { + "target": "com.amazonaws.cognitoidentityprovider#ArnType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (arn) of a CloudWatch Logs log group where your user pool sends logs.\n The log group must not be encrypted with Key Management Service and must be in the same Amazon Web Services account\n as your user pool.

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

The CloudWatch logging destination of a user pool detailed activity logging configuration.

" + } + }, "com.amazonaws.cognitoidentityprovider#CodeDeliveryDetailsListType": { "type": "list", "member": { @@ -4747,7 +4777,7 @@ } ], "traits": { - "smithy.api#documentation": "

Confirms tracking of the device. This API call is the call that begins device\n tracking.

" + "smithy.api#documentation": "

Confirms tracking of the device. This API call is the call that begins device\n tracking.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n " } }, "com.amazonaws.cognitoidentityprovider#ConfirmDeviceRequest": { @@ -4861,7 +4891,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Allows a user to enter a confirmation code to reset a forgotten password.

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

Allows a user to enter a confirmation code to reset a forgotten password.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n ", "smithy.api#optionalAuth": {} } }, @@ -4878,7 +4908,7 @@ "SecretHash": { "target": "com.amazonaws.cognitoidentityprovider#SecretHashType", "traits": { - "smithy.api#documentation": "

A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message.

" + "smithy.api#documentation": "

A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message. For more information\n about SecretHash, see Computing secret hash values.

" } }, "Username": { @@ -4891,7 +4921,7 @@ "ConfirmationCode": { "target": "com.amazonaws.cognitoidentityprovider#ConfirmationCodeType", "traits": { - "smithy.api#documentation": "

The confirmation code from your user's request to reset their password. For\n more information, see ForgotPassword.

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

The confirmation code from your user's request to reset their password. For more\n information, see ForgotPassword.

", "smithy.api#required": {} } }, @@ -4991,7 +5021,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Confirms registration of a new user.

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

Confirms registration of a new user.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n ", "smithy.api#optionalAuth": {} } }, @@ -5148,7 +5178,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new group in the specified user pool.

\n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Creates a new group in the specified user pool.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#CreateGroupRequest": { @@ -5237,7 +5267,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an IdP for a user pool.

" + "smithy.api#documentation": "

Creates an IdP for a user pool.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#CreateIdentityProviderRequest": { @@ -5332,7 +5362,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new OAuth2.0 resource server and defines custom scopes within it.

" + "smithy.api#documentation": "

Creates a new OAuth2.0 resource server and defines custom scopes within it.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#CreateResourceServerRequest": { @@ -5417,7 +5447,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates the user import job.

" + "smithy.api#documentation": "

Creates a user import job.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#CreateUserImportJobRequest": { @@ -5503,7 +5533,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon Cognito user pool and sets the password policy for the\n pool.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

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

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

Creates a new Amazon Cognito user pool and sets the password policy for the\n pool.

\n \n

If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.

\n \n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#CreateUserPoolClient": { @@ -5541,7 +5571,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates the user pool client.

\n

When you create a new user pool client, token revocation is automatically activated.\n For more information about revoking tokens, see RevokeToken.

" + "smithy.api#documentation": "

Creates the user pool client.

\n

When you create a new user pool client, token revocation is automatically activated.\n For more information about revoking tokens, see RevokeToken.

\n \n

If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.

\n \n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#CreateUserPoolClientRequest": { @@ -5584,7 +5614,7 @@ "IdTokenValidity": { "target": "com.amazonaws.cognitoidentityprovider#IdTokenValidityType", "traits": { - "smithy.api#documentation": "

The ID token time limit. After this limit expires, your user can't use \n their ID token. To specify the time unit for IdTokenValidity as \n seconds, minutes, hours, or days, \n set a TokenValidityUnits value in your API request.

\n

For example, when you set IdTokenValidity as 10 and\n TokenValidityUnits as hours, your user can authenticate their \n session with their ID token for 10 hours.

\n

The default time unit for AccessTokenValidity in an API request is hours. \n Valid range is displayed below in seconds.

\n

If you don't specify otherwise in the configuration of your app client, your ID\n tokens are valid for one hour.

" + "smithy.api#documentation": "

The ID token time limit. After this limit expires, your user can't use \n their ID token. To specify the time unit for IdTokenValidity as \n seconds, minutes, hours, or days, \n set a TokenValidityUnits value in your API request.

\n

For example, when you set IdTokenValidity as 10 and\n TokenValidityUnits as hours, your user can authenticate their \n session with their ID token for 10 hours.

\n

The default time unit for IdTokenValidity in an API request is hours. \n Valid range is displayed below in seconds.

\n

If you don't specify otherwise in the configuration of your app client, your ID\n tokens are valid for one hour.

" } }, "TokenValidityUnits": { @@ -5614,7 +5644,7 @@ "SupportedIdentityProviders": { "target": "com.amazonaws.cognitoidentityprovider#SupportedIdentityProvidersListType", "traits": { - "smithy.api#documentation": "

A list of provider names for the identity providers (IdPs) that are supported on this\n client. The following are supported: COGNITO, Facebook,\n Google, SignInWithApple, and LoginWithAmazon. You can also specify the names\n that you configured for the SAML and OIDC IdPs in your user pool, for example\n MySAMLIdP or MyOIDCIdP.

" + "smithy.api#documentation": "

A list of provider names for the identity providers (IdPs) that are supported on this\n client. The following are supported: COGNITO, Facebook,\n Google, SignInWithApple, and LoginWithAmazon.\n You can also specify the names that you configured for the SAML and OIDC IdPs in your\n user pool, for example MySAMLIdP or MyOIDCIdP.

" } }, "CallbackURLs": { @@ -5651,7 +5681,7 @@ "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Set to true if the client is allowed to follow the OAuth protocol when interacting\n with Amazon Cognito user pools.

" + "smithy.api#documentation": "

Set to true to use OAuth 2.0 features in your user pool app client.

\n

\n AllowedOAuthFlowsUserPoolClient must be true before you can configure \n the following features in your app client.

\n \n

To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set \n AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or \n UpdateUserPoolClient API request. If you don't set a value for \n AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults \n to false.

" } }, "AnalyticsConfiguration": { @@ -5675,7 +5705,7 @@ "EnablePropagateAdditionalUserContextData": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { - "smithy.api#documentation": "

Activates the propagation of additional user context data. For more information about\n propagation of user context data, see Adding advanced security to a user pool. If you don’t include this\n parameter, you can't send device fingerprint information, including source IP address,\n to Amazon Cognito advanced security. You can only activate\n EnablePropagateAdditionalUserContextData in an app client that has a\n client secret.

" + "smithy.api#documentation": "

Activates the propagation of additional user context data. For more information about\n propagation of user context data, see Adding advanced security to a user pool. If you don’t include this\n parameter, you can't send device fingerprint information, including source IP address,\n to Amazon Cognito advanced security. You can only activate\n EnablePropagateAdditionalUserContextData in an app client that has a\n client secret.

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

Creates a new domain for a user pool.

" + "smithy.api#documentation": "

Creates a new domain for a user pool.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#CreateUserPoolDomainRequest": { @@ -5867,7 +5897,7 @@ "DeviceConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#DeviceConfigurationType", "traits": { - "smithy.api#documentation": "

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

\n \n

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

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

The device-remembering configuration for a user pool. A null value indicates that you\n have deactivated device remembering in your user pool.

\n \n

When you provide a value for any DeviceConfiguration field, you\n activate the Amazon Cognito device-remembering feature.

\n " } }, "EmailConfiguration": { @@ -5903,13 +5933,13 @@ "UserPoolAddOns": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolAddOnsType", "traits": { - "smithy.api#documentation": "

Enables advanced security risk detection. Set the key\n AdvancedSecurityMode to the value \"AUDIT\".

" + "smithy.api#documentation": "

User pool add-ons. Contains settings for activation of advanced security features. To\n log user security information but take no action, set to AUDIT. To\n configure automatic security responses to risky traffic to your user pool, set to\n ENFORCED.

\n

For more information, see Adding advanced security to a user pool.

" } }, "UsernameConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#UsernameConfigurationType", "traits": { - "smithy.api#documentation": "

Case sensitivity on the username input for the selected sign-in option. For example,\n when case sensitivity is set to False, users can sign in using either\n \"username\" or \"Username\". This configuration is immutable once it has been set. For more\n information, see UsernameConfigurationType.

" + "smithy.api#documentation": "

Case sensitivity on the username input for the selected sign-in option. When case\n sensitivity is set to False (case insensitive), users can sign in with any\n combination of capital and lowercase letters. For example, username,\n USERNAME, or UserName, or for email,\n email@example.com or EMaiL@eXamplE.Com. For most use\n cases, set case sensitivity to False (case insensitive) as a best practice.\n When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in\n case as the same user, and prevents a case variation from being assigned to the same\n attribute for a different user.

\n

This configuration is immutable after you set it. For more information, see UsernameConfigurationType.

" } }, "AccountRecoverySetting": { @@ -6260,7 +6290,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Allows a user to delete himself or herself.

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

Allows a user to delete their own user profile.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n ", "smithy.api#optionalAuth": {} } }, @@ -6303,7 +6333,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Deletes the attributes for a user.

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

Deletes the attributes for a user.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n ", "smithy.api#optionalAuth": {} } }, @@ -6848,7 +6878,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the configuration information and metadata of the specified user pool.

" + "smithy.api#documentation": "

Returns the configuration information and metadata of the specified user pool.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#DescribeUserPoolClient": { @@ -6877,7 +6907,7 @@ } ], "traits": { - "smithy.api#documentation": "

Client method for returning the configuration information and metadata of the\n specified user pool app client.

" + "smithy.api#documentation": "

Client method for returning the configuration information and metadata of the\n specified user pool app client.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#DescribeUserPoolClientRequest": { @@ -7020,14 +7050,14 @@ "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

When true, a remembered device can sign in with device authentication instead of SMS\n and time-based one-time password (TOTP) factors for multi-factor authentication\n (MFA).

\n \n

Whether or not ChallengeRequiredOnNewDevice is true, users who sign in\n with devices that have not been confirmed or remembered must still provide a second\n factor in a user pool that requires MFA.

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

When true, a remembered device can sign in with device authentication instead of SMS\n and time-based one-time password (TOTP) factors for multi-factor authentication\n (MFA).

\n \n

Whether or not ChallengeRequiredOnNewDevice is true, users who sign\n in with devices that have not been confirmed or remembered must still provide a\n second factor in a user pool that requires MFA.

\n " } }, "DeviceOnlyRememberedOnUserPrompt": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a\n \n ConfirmDevice API request. In your app, create a prompt for\n your user to choose whether they want to remember their device. Return the user's choice\n in an \n UpdateDeviceStatus API request.

\n

When DeviceOnlyRememberedOnUserPrompt is false, Amazon\n Cognito immediately remembers devices that you register in a ConfirmDevice\n API request.

" + "smithy.api#documentation": "

When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a\n \n ConfirmDevice API request. In your app, create a prompt for your user to\n choose whether they want to remember their device. Return the user's choice in an \n UpdateDeviceStatus API request.

\n

When DeviceOnlyRememberedOnUserPrompt is false, Amazon\n Cognito immediately remembers devices that you register in a ConfirmDevice\n API request.

" } } }, @@ -7121,7 +7151,7 @@ "DeviceLastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The last modified date of the device.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was modified.

" } }, "DeviceLastAuthenticatedDate": { @@ -7165,7 +7195,7 @@ "CloudFrontDistribution": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.

" + "smithy.api#documentation": "

The Amazon CloudFront endpoint that you use as the target of the alias that you set up with\n your Domain Name Service (DNS) provider.

" } }, "Version": { @@ -7270,7 +7300,7 @@ "SourceArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "

The ARN of a verified email address in Amazon SES. Amazon Cognito uses this email address in one of\n the following ways, depending on the value that you specify for the\n EmailSendingAccount parameter:

\n \n

The Region value of the SourceArn parameter must indicate a supported\n Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn and\n the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer\n Guide.

" + "smithy.api#documentation": "

The ARN of a verified email address or an address from a verified domain in Amazon SES. You\n can set a SourceArn email from a verified domain only with an API request.\n You can set a verified email address, but not an address in a verified domain, in the\n Amazon Cognito console. Amazon Cognito uses the email address that you provide in one of the following\n ways, depending on the value that you specify for the EmailSendingAccount\n parameter:

\n \n

The Region value of the SourceArn parameter must indicate a supported\n Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn and\n the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer\n Guide.

" } }, "ReplyToEmailAddress": { @@ -7282,7 +7312,7 @@ "EmailSendingAccount": { "target": "com.amazonaws.cognitoidentityprovider#EmailSendingAccountType", "traits": { - "smithy.api#documentation": "

Specifies whether Amazon Cognito uses its built-in functionality to send your users email\n messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following\n values:

\n
\n
COGNITO_DEFAULT
\n
\n

When Amazon Cognito emails your users, it uses its built-in email functionality.\n When you use the default option, Amazon Cognito allows only a limited number of\n emails each day for your user pool. For typical production environments, the\n default email limit is less than the required delivery volume. To achieve a\n higher delivery volume, specify DEVELOPER to use your Amazon SES email\n configuration.

\n

To look up the email delivery limit for the default option, see Limits in the Amazon Cognito Developer Guide.

\n

The default FROM address is no-reply@verificationemail.com.\n To customize the FROM address, provide the Amazon Resource Name (ARN) of an\n Amazon SES verified email address for the SourceArn\n parameter.

\n
\n
DEVELOPER
\n
\n

When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito\n calls Amazon SES on your behalf to send email from your verified email address.\n When you use this option, the email delivery limits are the same limits that\n apply to your Amazon SES verified email address in your Amazon Web Services account.

\n

If you use this option, provide the ARN of an Amazon SES verified email address\n for the SourceArn parameter.

\n

Before Amazon Cognito can email your users, it requires additional permissions to\n call Amazon SES on your behalf. When you update your user pool with this option,\n Amazon Cognito creates a service-linked role, which is a type of\n role in your Amazon Web Services account. This role contains the permissions\n that allow you to access Amazon SES and send email messages from your email address. For\n more information about the service-linked role that Amazon Cognito creates, see\n Using Service-Linked Roles for Amazon Cognito in the\n Amazon Cognito Developer Guide.

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

Specifies whether Amazon Cognito uses its built-in functionality to send your users email\n messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following\n values:

\n
\n
COGNITO_DEFAULT
\n
\n

When Amazon Cognito emails your users, it uses its built-in email functionality.\n When you use the default option, Amazon Cognito allows only a limited number of\n emails each day for your user pool. For typical production environments, the\n default email limit is less than the required delivery volume. To achieve a\n higher delivery volume, specify DEVELOPER to use your Amazon SES email\n configuration.

\n

To look up the email delivery limit for the default option, see Limits in the Amazon Cognito Developer\n Guide.

\n

The default FROM address is no-reply@verificationemail.com.\n To customize the FROM address, provide the Amazon Resource Name (ARN) of an\n Amazon SES verified email address for the SourceArn\n parameter.

\n
\n
DEVELOPER
\n
\n

When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito\n calls Amazon SES on your behalf to send email from your verified email address.\n When you use this option, the email delivery limits are the same limits that\n apply to your Amazon SES verified email address in your Amazon Web Services account.

\n

If you use this option, provide the ARN of an Amazon SES verified email address\n for the SourceArn parameter.

\n

Before Amazon Cognito can email your users, it requires additional permissions to\n call Amazon SES on your behalf. When you update your user pool with this option,\n Amazon Cognito creates a service-linked role, which is a type of\n role in your Amazon Web Services account. This role contains the permissions\n that allow you to access Amazon SES and send email messages from your email\n address. For more information about the service-linked role that Amazon Cognito\n creates, see Using Service-Linked Roles for Amazon Cognito in the\n Amazon Cognito Developer Guide.

\n
\n
" } }, "From": { @@ -7436,7 +7466,7 @@ "FeedbackValue": { "target": "com.amazonaws.cognitoidentityprovider#FeedbackValueType", "traits": { - "smithy.api#documentation": "

The event feedback value.

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

The authentication event feedback value. When you provide a FeedbackValue\n value of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito\n has evaluated some level of risk. When you provide a FeedbackValue value of\n invalid, you tell Amazon Cognito that you don't trust a user session, or you \n don't believe that Amazon Cognito evaluated a high-enough risk level.

", "smithy.api#required": {} } }, @@ -7546,6 +7576,17 @@ "smithy.api#documentation": "

The event risk type.

" } }, + "com.amazonaws.cognitoidentityprovider#EventSourceName": { + "type": "enum", + "members": { + "USER_NOTIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "userNotification" + } + } + } + }, "com.amazonaws.cognitoidentityprovider#EventType": { "type": "enum", "members": { @@ -7679,12 +7720,12 @@ "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { - "smithy.api#documentation": "

The message returned when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

" + "smithy.api#documentation": "

The message returned when WAF doesn't allow your request based on a web ACL\n that's associated with your user pool.

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

This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.

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

This exception is thrown when WAF doesn't allow your request based on a web\n ACL that's associated with your user pool.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -7736,7 +7777,7 @@ } ], "traits": { - "smithy.api#documentation": "

Forgets the specified device.

" + "smithy.api#documentation": "

Forgets the specified device.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n " } }, "com.amazonaws.cognitoidentityprovider#ForgetDeviceRequest": { @@ -7818,7 +7859,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Calling this API causes a message to be sent to the end user with a confirmation code\n that is required to change the user's password. For the Username parameter,\n you can use the username or user alias. The method used to send the confirmation code is\n sent according to the specified AccountRecoverySetting. For more information, see Recovering\n User Accounts in the Amazon Cognito Developer Guide. If\n neither a verified phone number nor a verified email exists, an\n InvalidParameterException is thrown. To use the confirmation code for\n resetting the password, call ConfirmForgotPassword.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

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

Calling this API causes a message to be sent to the end user with a confirmation code\n that is required to change the user's password. For the Username parameter,\n you can use the username or user alias. The method used to send the confirmation code is\n sent according to the specified AccountRecoverySetting. For more information, see Recovering\n User Accounts in the Amazon Cognito Developer Guide. To\n use the confirmation code for resetting the password, call ConfirmForgotPassword.

\n

If neither a verified phone number nor a verified email exists, this API returns\n InvalidParameterException. If your app client has a client secret and\n you don't provide a SECRET_HASH parameter, this API returns\n NotAuthorizedException.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -7997,7 +8038,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the device.

" + "smithy.api#documentation": "

Gets the device.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n " } }, "com.amazonaws.cognitoidentityprovider#GetDeviceRequest": { @@ -8169,6 +8210,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.cognitoidentityprovider#GetLogDeliveryConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentityprovider#GetLogDeliveryConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.cognitoidentityprovider#GetLogDeliveryConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the detailed activity logging configuration for a user pool.

" + } + }, + "com.amazonaws.cognitoidentityprovider#GetLogDeliveryConfigurationRequest": { + "type": "structure", + "members": { + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The ID of the user pool where you want to view detailed activity logging configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentityprovider#GetLogDeliveryConfigurationResponse": { + "type": "structure", + "members": { + "LogDeliveryConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#LogDeliveryConfigurationType", + "traits": { + "smithy.api#documentation": "

The detailed activity logging configuration of the requested user pool.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cognitoidentityprovider#GetSigningCertificate": { "type": "operation", "input": { @@ -8189,7 +8288,7 @@ } ], "traits": { - "smithy.api#documentation": "

This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 years from the date of issue.

\n

Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the response to GetSigningCertificate, \n but doesn't invalidate the original certificate.

" + "smithy.api#documentation": "

This method takes a user pool ID, and returns the signing certificate. The issued\n certificate is valid for 10 years from the date of issue.

\n

Amazon Cognito issues and assigns a new signing certificate annually. This process returns a\n new value in the response to GetSigningCertificate, but doesn't invalidate\n the original certificate.

" } }, "com.amazonaws.cognitoidentityprovider#GetSigningCertificateRequest": { @@ -8327,7 +8426,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Gets the user attributes and metadata for a user.

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

Gets the user attributes and metadata for a user.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n ", "smithy.api#optionalAuth": {} } }, @@ -8394,7 +8493,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Generates a user attribute verification code for the specified attribute name. Sends a\n message to a user with a code that they must return in a VerifyUserAttribute\n request.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

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

Generates a user attribute verification code for the specified attribute name. Sends a\n message to a user with a code that they must return in a VerifyUserAttribute\n request.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -8534,7 +8633,7 @@ "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "

The user name of the user you want to retrieve from the get user request.

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

The username of the user that you requested.

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

Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito\n has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens \n for the duration of the 1-hour cookie validity period.

" + "smithy.api#documentation": "

Signs out a user from all devices. GlobalSignOut invalidates all\n identity, access and refresh tokens that Amazon Cognito has issued to a user. A user can still\n use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie\n validity period.

\n

Your app isn't aware that a user's access token is revoked unless it attempts to\n authorize a user pools API request with an access token that contains the scope\n aws.cognito.signin.user.admin. Your app might otherwise accept access\n tokens until they expire.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n " } }, "com.amazonaws.cognitoidentityprovider#GlobalSignOutRequest": { @@ -8696,13 +8795,13 @@ "LastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The date the group was last modified.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was modified.

" } }, "CreationDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The date the group was created.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was created.

" } } }, @@ -8793,13 +8892,13 @@ "LastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The date the IdP was last modified.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was modified.

" } }, "CreationDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The date the IdP was created.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was created.

" } } }, @@ -8871,7 +8970,13 @@ } }, "com.amazonaws.cognitoidentityprovider#ImageFileType": { - "type": "blob" + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 131072 + } + } }, "com.amazonaws.cognitoidentityprovider#ImageUrlType": { "type": "string" @@ -8933,7 +9038,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user\n with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in through a third party.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

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

Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user\n with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in through a third party.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -8950,7 +9055,7 @@ "AuthParameters": { "target": "com.amazonaws.cognitoidentityprovider#AuthParametersType", "traits": { - "smithy.api#documentation": "

The authentication parameters. These are inputs corresponding to the\n AuthFlow that you're invoking. The required values depend on the value\n of AuthFlow:

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

The authentication parameters. These are inputs corresponding to the\n AuthFlow that you're invoking. The required values depend on the value\n of AuthFlow:

\n \n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

" } }, "ClientMetadata": { @@ -9142,7 +9247,7 @@ } }, "traits": { - "smithy.api#documentation": "

This exception is thrown when the trust relationship is not valid for the role\n provided for SMS configuration. This can happen if you don't trust\n cognito-idp.amazonaws.com or the external ID provided in the role does\n not match what is provided in the SMS configuration for the user pool.

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

This exception is thrown when the trust relationship is not valid for the role\n provided for SMS configuration. This can happen if you don't trust\n cognito-idp.amazonaws.com or the external ID provided in the role does\n not match what is provided in the SMS configuration for the user pool.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -9306,7 +9411,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the sign-in devices that Amazon Cognito has registered to the current user.

" + "smithy.api#documentation": "

Lists the sign-in devices that Amazon Cognito has registered to the current user.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n " } }, "com.amazonaws.cognitoidentityprovider#ListDevicesRequest": { @@ -9384,7 +9489,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the groups associated with a user pool.

\n

Calling this action requires developer credentials.

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

Lists the groups associated with a user pool.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -9466,7 +9571,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists information about all IdPs for a user pool.

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

Lists information about all IdPs for a user pool.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -9564,7 +9669,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the resource servers for a user pool.

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

Lists the resource servers for a user pool.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -9716,7 +9821,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the user import jobs.

" + "smithy.api#documentation": "

Lists user import jobs for a user pool.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#ListUserImportJobsRequest": { @@ -9796,7 +9901,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the clients that have been created for the specified user pool.

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

Lists the clients that have been created for the specified user pool.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -9878,7 +9983,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the user pools associated with an Amazon Web Services account.

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

Lists the user pools associated with an Amazon Web Services account.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -9957,7 +10062,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the users in the Amazon Cognito user pool.

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

Lists users and their basic details in a user pool.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n ", "smithy.api#paginated": { "inputToken": "PaginationToken", "outputToken": "PaginationToken", @@ -9992,7 +10097,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the users in the specified group.

\n

Calling this action requires developer credentials.

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

Lists the users in the specified group.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -10068,7 +10173,7 @@ "AttributesToGet": { "target": "com.amazonaws.cognitoidentityprovider#SearchedAttributeNamesListType", "traits": { - "smithy.api#documentation": "

An array of strings, where each string is the name of a user attribute to be returned\n for each user in the search results. If the array is null, all attributes are\n returned.

" + "smithy.api#documentation": "

A JSON array of user attribute names, for example given_name, that you\n want Amazon Cognito to include in the response for each user. When you don't provide an\n AttributesToGet parameter, Amazon Cognito returns all attributes for each\n user.

" } }, "Limit": { @@ -10101,7 +10206,7 @@ "Users": { "target": "com.amazonaws.cognitoidentityprovider#UsersListType", "traits": { - "smithy.api#documentation": "

The users returned in the request to list users.

" + "smithy.api#documentation": "

A list of the user pool users, and their attributes, that match your query.

\n \n

Amazon Cognito creates a profile in your user pool for each native user in your user pool,\n and each unique user ID from your third-party identity providers (IdPs). When you\n link users with the AdminLinkProviderForUser API operation, the output of\n ListUsers displays both the IdP user and the native user that you\n linked. You can identify IdP users in the Users object of this API\n response by the IdP prefix that Amazon Cognito appends to Username.

\n " } }, "PaginationToken": { @@ -10116,6 +10221,79 @@ "smithy.api#output": {} } }, + "com.amazonaws.cognitoidentityprovider#LogConfigurationListType": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentityprovider#LogConfigurationType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.cognitoidentityprovider#LogConfigurationType": { + "type": "structure", + "members": { + "LogLevel": { + "target": "com.amazonaws.cognitoidentityprovider#LogLevel", + "traits": { + "smithy.api#documentation": "

The errorlevel selection of logs that a user pool sends for detailed activity logging.

", + "smithy.api#required": {} + } + }, + "EventSource": { + "target": "com.amazonaws.cognitoidentityprovider#EventSourceName", + "traits": { + "smithy.api#documentation": "

The source of events that your user pool sends for detailed activity logging.

", + "smithy.api#required": {} + } + }, + "CloudWatchLogsConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#CloudWatchLogsConfigurationType", + "traits": { + "smithy.api#documentation": "

The CloudWatch logging destination of a user pool.

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

The logging parameters of a user pool.

" + } + }, + "com.amazonaws.cognitoidentityprovider#LogDeliveryConfigurationType": { + "type": "structure", + "members": { + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The ID of the user pool where you configured detailed activity logging.

", + "smithy.api#required": {} + } + }, + "LogConfigurations": { + "target": "com.amazonaws.cognitoidentityprovider#LogConfigurationListType", + "traits": { + "smithy.api#documentation": "

The detailed activity logging destination of a user pool.

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

The logging parameters of a user pool.

" + } + }, + "com.amazonaws.cognitoidentityprovider#LogLevel": { + "type": "enum", + "members": { + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } + } + }, "com.amazonaws.cognitoidentityprovider#LogoutURLsListType": { "type": "list", "member": { @@ -10584,7 +10762,7 @@ "CreationDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The date the provider was added to the user pool.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was created.

" } } }, @@ -10822,7 +11000,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Resends the confirmation (for confirmation of registration) to a specific user in the\n user pool.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

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

Resends the confirmation (for confirmation of registration) to a specific user in the\n user pool.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -11090,7 +11268,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Responds to the authentication challenge.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

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

Responds to the authentication challenge.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -11120,7 +11298,7 @@ "ChallengeResponses": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeResponsesType", "traits": { - "smithy.api#documentation": "

The challenge responses. These are inputs corresponding to the value of\n ChallengeName, for example:

\n \n

\n SECRET_HASH (if app client is configured with client secret) applies\n to all of the inputs that follow (including SOFTWARE_TOKEN_MFA).

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

The challenge responses. These are inputs corresponding to the value of\n ChallengeName, for example:

\n \n

\n SECRET_HASH (if app client is configured with client secret) applies\n to all of the inputs that follow (including SOFTWARE_TOKEN_MFA).

\n \n \n

For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.

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

Revokes all of the access tokens generated by, and at the same time as, the specified \n refresh token. After a token is revoked, you can't use the revoked token to access \n Amazon Cognito user APIs, or to authorize access to your resource server.

" + "smithy.api#documentation": "

Revokes all of the access tokens generated by, and at the same time as, the specified\n refresh token. After a token is revoked, you can't use the revoked token to access Amazon Cognito\n user APIs, or to authorize access to your resource server.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n " } }, "com.amazonaws.cognitoidentityprovider#RevokeTokenRequest": { @@ -11286,7 +11464,7 @@ "LastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The last modified date.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was modified.

" } } }, @@ -11408,13 +11586,13 @@ "Name": { "target": "com.amazonaws.cognitoidentityprovider#CustomAttributeNameType", "traits": { - "smithy.api#documentation": "

A schema attribute of the name type.

" + "smithy.api#documentation": "

The name of your user pool attribute, for example username or\n custom:costcenter.

" } }, "AttributeDataType": { "target": "com.amazonaws.cognitoidentityprovider#AttributeDataType", "traits": { - "smithy.api#documentation": "

The attribute data type.

" + "smithy.api#documentation": "

The data format of the values for your attribute.

" } }, "DeveloperOnlyAttribute": { @@ -11428,7 +11606,7 @@ "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Specifies whether the value of the attribute can be changed.

\n

For any user pool attribute that is mapped to an IdP attribute, you must set this\n parameter to true. Amazon Cognito updates mapped attributes when users sign in to\n your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error\n when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User\n Pool.

" + "smithy.api#documentation": "

Specifies whether the value of the attribute can be changed.

\n

Any user pool attribute whose value you map from an IdP attribute must be mutable,\n with a parameter value of true. Amazon Cognito updates mapped attributes when users\n sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws\n an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User\n Pool.

" } }, "Required": { @@ -11452,7 +11630,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about the schema attribute.

" + "smithy.api#documentation": "

A list of the user attributes and their properties in your user pool. The attribute\n schema contains standard attributes, custom attributes with a custom:\n prefix, and developer attributes with a dev: prefix. For more information,\n see User pool\n attributes.

\n

Developer-only attributes are a legacy feature of user pools, are read-only to all app\n clients. You can create and update developer-only attributes only with IAM-authenticated\n API operations. Use app client read/write permissions instead.

" } }, "com.amazonaws.cognitoidentityprovider#SchemaAttributesListType": { @@ -11544,8 +11722,72 @@ "smithy.api#length": { "min": 20, "max": 2048 + } + } + }, + "com.amazonaws.cognitoidentityprovider#SetLogDeliveryConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentityprovider#SetLogDeliveryConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.cognitoidentityprovider#SetLogDeliveryConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, - "smithy.api#sensitive": {} + { + "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets up or modifies the detailed activity logging configuration of a user pool.

" + } + }, + "com.amazonaws.cognitoidentityprovider#SetLogDeliveryConfigurationRequest": { + "type": "structure", + "members": { + "UserPoolId": { + "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", + "traits": { + "smithy.api#documentation": "

The ID of the user pool where you want to configure detailed activity logging .

", + "smithy.api#required": {} + } + }, + "LogConfigurations": { + "target": "com.amazonaws.cognitoidentityprovider#LogConfigurationListType", + "traits": { + "smithy.api#documentation": "

A collection of all of the detailed activity logging configurations for a user pool.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentityprovider#SetLogDeliveryConfigurationResponse": { + "type": "structure", + "members": { + "LogDeliveryConfiguration": { + "target": "com.amazonaws.cognitoidentityprovider#LogDeliveryConfigurationType", + "traits": { + "smithy.api#documentation": "

The detailed activity logging configuration that you applied to the requested user pool.

" + } + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#SetRiskConfiguration": { @@ -11752,7 +11994,7 @@ } ], "traits": { - "smithy.api#documentation": "

Set the user's multi-factor authentication (MFA) method preference, including which\n MFA factors are activated and if any are preferred. Only one factor can be set as\n preferred. The preferred MFA factor will be used to authenticate a user if multiple\n factors are activated. If multiple options are activated and no preference is set, a\n challenge to choose an MFA option will be returned during sign-in. If an MFA type is\n activated for a user, the user will be prompted for MFA during all sign-in attempts\n unless device tracking is turned on and the device has been trusted. If you want MFA to\n be applied selectively based on the assessed risk level of sign-in attempts, deactivate\n MFA for users and turn on Adaptive Authentication for the user pool.

" + "smithy.api#documentation": "

Set the user's multi-factor authentication (MFA) method preference, including which\n MFA factors are activated and if any are preferred. Only one factor can be set as\n preferred. The preferred MFA factor will be used to authenticate a user if multiple\n factors are activated. If multiple options are activated and no preference is set, a\n challenge to choose an MFA option will be returned during sign-in. If an MFA type is\n activated for a user, the user will be prompted for MFA during all sign-in attempts\n unless device tracking is turned on and the device has been trusted. If you want MFA to\n be applied selectively based on the assessed risk level of sign-in attempts, deactivate\n MFA for users and turn on Adaptive Authentication for the user pool.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n " } }, "com.amazonaws.cognitoidentityprovider#SetUserMFAPreferenceRequest": { @@ -11821,7 +12063,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the user pool multi-factor authentication (MFA) configuration.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

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

Sets the user pool multi-factor authentication (MFA) configuration.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n " } }, "com.amazonaws.cognitoidentityprovider#SetUserPoolMfaConfigRequest": { @@ -11919,7 +12161,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

\n This action is no longer supported. You can use it to configure\n only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software\n token MFA. To configure either type of MFA, use SetUserMFAPreference instead.

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

\n This action is no longer supported. You can use it to configure\n only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software\n token MFA. To configure either type of MFA, use SetUserMFAPreference instead.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n ", "smithy.api#optionalAuth": {} } }, @@ -12011,7 +12253,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Registers the user in the specified user pool and creates a user name, password, and\n user attributes.

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

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

Registers the user in the specified user pool and creates a user name, password, and\n user attributes.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -12200,8 +12442,7 @@ "min": 6, "max": 6 }, - "smithy.api#pattern": "^[0-9]+$", - "smithy.api#sensitive": {} + "smithy.api#pattern": "^[0-9]+$" } }, "com.amazonaws.cognitoidentityprovider#SoftwareTokenMfaConfigType": { @@ -12419,7 +12660,13 @@ } }, "com.amazonaws.cognitoidentityprovider#StringType": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 131072 + } + } }, "com.amazonaws.cognitoidentityprovider#SupportedIdentityProvidersListType": { "type": "list", @@ -12555,19 +12802,19 @@ "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TimeUnitsType", "traits": { - "smithy.api#documentation": "

A time unit of seconds, minutes, hours, or\n days for the value that you set in the AccessTokenValidity\n parameter. The default AccessTokenValidity time unit is hours.

" + "smithy.api#documentation": "

A time unit of seconds, minutes, hours, or\n days for the value that you set in the AccessTokenValidity\n parameter. The default AccessTokenValidity time unit is hours.\n AccessTokenValidity duration can range from five minutes to one\n day.

" } }, "IdToken": { "target": "com.amazonaws.cognitoidentityprovider#TimeUnitsType", "traits": { - "smithy.api#documentation": "

A time unit of seconds, minutes, hours, or\n days for the value that you set in the IdTokenValidity\n parameter. The default IdTokenValidity time unit is hours.

" + "smithy.api#documentation": "

A time unit of seconds, minutes, hours, or\n days for the value that you set in the IdTokenValidity\n parameter. The default IdTokenValidity time unit is hours.\n IdTokenValidity duration can range from five minutes to one day.

" } }, "RefreshToken": { "target": "com.amazonaws.cognitoidentityprovider#TimeUnitsType", "traits": { - "smithy.api#documentation": "

A time unit of seconds, minutes, hours, or\n days for the value that you set in the\n RefreshTokenValidity parameter. The default\n RefreshTokenValidity time unit is days.

" + "smithy.api#documentation": "

A time unit of seconds, minutes, hours, or\n days for the value that you set in the\n RefreshTokenValidity parameter. The default\n RefreshTokenValidity time unit is days.\n RefreshTokenValidity duration can range from 60 minutes to 10\n years.

" } } }, @@ -12643,13 +12890,13 @@ "LastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The last-modified date for the UI customization.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was modified.

" } }, "CreationDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The creation date for the UI customization.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was created.

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

Provides the feedback for an authentication event, whether it was from a valid user or\n not. This feedback is used for improving the risk evaluation decision for the user pool\n as part of Amazon Cognito advanced security.

" + "smithy.api#documentation": "

Provides the feedback for an authentication event, whether it was from a valid user or\n not. This feedback is used for improving the risk evaluation decision for the user pool\n as part of Amazon Cognito advanced security.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n " } }, "com.amazonaws.cognitoidentityprovider#UpdateAuthEventFeedbackRequest": { @@ -12868,7 +13115,7 @@ "FeedbackValue": { "target": "com.amazonaws.cognitoidentityprovider#FeedbackValueType", "traits": { - "smithy.api#documentation": "

The authentication event feedback value.

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

The authentication event feedback value. When you provide a FeedbackValue\n value of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito\n has evaluated some level of risk. When you provide a FeedbackValue value of\n invalid, you tell Amazon Cognito that you don't trust a user session, or you \n don't believe that Amazon Cognito evaluated a high-enough risk level.

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

Updates the device status.

" + "smithy.api#documentation": "

Updates the device status.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n " } }, "com.amazonaws.cognitoidentityprovider#UpdateDeviceStatusRequest": { @@ -12991,7 +13238,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified group with the specified attributes.

\n

Calling this action requires developer credentials.

" + "smithy.api#documentation": "

Updates the specified group with the specified attributes.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#UpdateGroupRequest": { @@ -13080,7 +13327,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates IdP information for a user pool.

" + "smithy.api#documentation": "

Updates IdP information for a user pool.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#UpdateIdentityProviderRequest": { @@ -13164,7 +13411,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the name and scopes of resource server. All other fields are read-only.

\n \n

If you don't provide a value for an attribute, it is set to the default\n value.

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

Updates the name and scopes of resource server. All other fields are read-only.

\n \n

If you don't provide a value for an attribute, it is set to the default\n value.

\n \n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#UpdateResourceServerRequest": { @@ -13286,7 +13533,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Allows a user to update a specific attribute (one at a time).

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

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

Allows a user to update a specific attribute (one at a time).

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n \n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n ", "smithy.api#optionalAuth": {} } }, @@ -13296,7 +13543,7 @@ "UserAttributes": { "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", "traits": { - "smithy.api#documentation": "

An array of name-value pairs representing user attributes.

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

\n

If you have set an attribute to require verification before Amazon Cognito updates its value,\n this request doesn’t immediately update the value of that attribute. After your user\n receives and responds to a verification message to verify the new value, Amazon Cognito updates\n the attribute value. Your user can sign in and receive messages with the original \n attribute value until they verify the new value.

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

An array of name-value pairs representing user attributes.

\n

For custom attributes, you must prepend the custom: prefix to the\n attribute name.

\n

If you have set an attribute to require verification before Amazon Cognito updates its value,\n this request doesn’t immediately update the value of that attribute. After your user\n receives and responds to a verification message to verify the new value, Amazon Cognito updates\n the attribute value. Your user can sign in and receive messages with the original\n attribute value until they verify the new value.

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

Updates the specified user pool with the specified attributes. You can get a list of\n the current user pool settings using DescribeUserPool. If you don't provide a value for an attribute, it will be\n set to the default value.\n

\n \n

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

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

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.

\n

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.

\n \n

Updates the specified user pool with the specified attributes. You can get a list of\n the current user pool settings using DescribeUserPool.

\n \n

If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.

\n \n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPoolClient": { @@ -13416,7 +13663,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified user pool app client with the specified attributes. You can get\n a list of the current user pool app client settings using DescribeUserPoolClient.

\n \n

If you don't provide a value for an attribute, it will be set to the default\n value.

\n \n

You can also use this operation to enable token revocation for user pool clients. For\n more information about revoking tokens, see RevokeToken.

" + "smithy.api#documentation": "

Updates the specified user pool app client with the specified attributes. You can get\n a list of the current user pool app client settings using DescribeUserPoolClient.

\n \n

If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.

\n \n

You can also use this operation to enable token revocation for user pool clients. For\n more information about revoking tokens, see RevokeToken.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPoolClientRequest": { @@ -13458,13 +13705,13 @@ "IdTokenValidity": { "target": "com.amazonaws.cognitoidentityprovider#IdTokenValidityType", "traits": { - "smithy.api#documentation": "

The ID token time limit. After this limit expires, your user can't use \n their ID token. To specify the time unit for IdTokenValidity as \n seconds, minutes, hours, or days, \n set a TokenValidityUnits value in your API request.

\n

For example, when you set IdTokenValidity as 10 and\n TokenValidityUnits as hours, your user can authenticate their \n session with their ID token for 10 hours.

\n

The default time unit for AccessTokenValidity in an API request is hours. \n Valid range is displayed below in seconds.

\n

If you don't specify otherwise in the configuration of your app client, your ID\n tokens are valid for one hour.

" + "smithy.api#documentation": "

The ID token time limit. After this limit expires, your user can't use \n their ID token. To specify the time unit for IdTokenValidity as \n seconds, minutes, hours, or days, \n set a TokenValidityUnits value in your API request.

\n

For example, when you set IdTokenValidity as 10 and\n TokenValidityUnits as hours, your user can authenticate their \n session with their ID token for 10 hours.

\n

The default time unit for IdTokenValidity in an API request is hours. \n Valid range is displayed below in seconds.

\n

If you don't specify otherwise in the configuration of your app client, your ID\n tokens are valid for one hour.

" } }, "TokenValidityUnits": { "target": "com.amazonaws.cognitoidentityprovider#TokenValidityUnitsType", "traits": { - "smithy.api#documentation": "

The units in which the validity times are represented. The default unit for\n RefreshToken is days, and the default for ID and access tokens is hours.

" + "smithy.api#documentation": "

The time units you use when you set the duration of ID, access, and refresh tokens.\n The default unit for RefreshToken is days, and the default for ID and access tokens is\n hours.

" } }, "ReadAttributes": { @@ -13488,7 +13735,7 @@ "SupportedIdentityProviders": { "target": "com.amazonaws.cognitoidentityprovider#SupportedIdentityProvidersListType", "traits": { - "smithy.api#documentation": "

A list of provider names for the IdPs that this client supports. The following are\n supported: COGNITO, Facebook, Google, SignInWithApple,\n LoginWithAmazon, and the names of your own SAML and OIDC providers.

" + "smithy.api#documentation": "

A list of provider names for the IdPs that this client supports. The following are\n supported: COGNITO, Facebook, Google,\n SignInWithApple, LoginWithAmazon, and the names of your\n own SAML and OIDC providers.

" } }, "CallbackURLs": { @@ -13525,7 +13772,7 @@ "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Set to true if the client is allowed to follow the OAuth protocol when interacting\n with Amazon Cognito user pools.

" + "smithy.api#documentation": "

Set to true to use OAuth 2.0 features in your user pool app client.

\n

\n AllowedOAuthFlowsUserPoolClient must be true before you can configure \n the following features in your app client.

\n \n

To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set \n AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or \n UpdateUserPoolClient API request. If you don't set a value for \n AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults \n to false.

" } }, "AnalyticsConfiguration": { @@ -13549,7 +13796,7 @@ "EnablePropagateAdditionalUserContextData": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { - "smithy.api#documentation": "

Activates the propagation of additional user context data. For more information about\n propagation of user context data, see Adding advanced security to a user pool. If you don’t include this\n parameter, you can't send device fingerprint information, including source IP address,\n to Amazon Cognito advanced security. You can only activate\n EnablePropagateAdditionalUserContextData in an app client that has a\n client secret.

" + "smithy.api#documentation": "

Activates the propagation of additional user context data. For more information about\n propagation of user context data, see Adding advanced security to a user pool. If you don’t include this\n parameter, you can't send device fingerprint information, including source IP address,\n to Amazon Cognito advanced security. You can only activate\n EnablePropagateAdditionalUserContextData in an app client that has a\n client secret.

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

Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user\n pool.

\n

You can use this operation to provide the Amazon Resource Name (ARN) of a new\n certificate to Amazon Cognito. You can't use it to change the domain for a user pool.

\n

A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and\n sign-in pages for your application. When you set up a custom domain, you provide a\n certificate that you manage with Certificate Manager (ACM). When necessary, you can use this\n operation to change the certificate that you applied to your custom domain.

\n

Usually, this is unnecessary following routine certificate renewal with ACM. When\n you renew your existing certificate in ACM, the ARN for your certificate remains the\n same, and your custom domain uses the new certificate automatically.

\n

However, if you replace your existing certificate with a new one, ACM gives the new\n certificate a new ARN. To apply the new certificate to your custom domain, you must\n provide this ARN to Amazon Cognito.

\n

When you add your new certificate in ACM, you must choose US East (N. Virginia) as\n the Amazon Web Services Region.

\n

After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new\n certificate to your custom domain.

\n

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

" + "smithy.api#documentation": "

Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user\n pool.

\n

You can use this operation to provide the Amazon Resource Name (ARN) of a new\n certificate to Amazon Cognito. You can't use it to change the domain for a user pool.

\n

A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and\n sign-in pages for your application. When you set up a custom domain, you provide a\n certificate that you manage with Certificate Manager (ACM). When necessary, you can use this\n operation to change the certificate that you applied to your custom domain.

\n

Usually, this is unnecessary following routine certificate renewal with ACM. When\n you renew your existing certificate in ACM, the ARN for your certificate remains the\n same, and your custom domain uses the new certificate automatically.

\n

However, if you replace your existing certificate with a new one, ACM gives the new\n certificate a new ARN. To apply the new certificate to your custom domain, you must\n provide this ARN to Amazon Cognito.

\n

When you add your new certificate in ACM, you must choose US East (N. Virginia) as\n the Amazon Web Services Region.

\n

After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new\n certificate to your custom domain.

\n

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

\n \n

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.

\n

\n Learn more\n

\n \n " } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPoolDomainRequest": { @@ -13732,7 +13979,7 @@ "DeviceConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#DeviceConfigurationType", "traits": { - "smithy.api#documentation": "

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

\n \n

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

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

The device-remembering configuration for a user pool. A null value indicates that you\n have deactivated device remembering in your user pool.

\n \n

When you provide a value for any DeviceConfiguration field, you\n activate the Amazon Cognito device-remembering feature.

\n " } }, "EmailConfiguration": { @@ -13762,7 +14009,7 @@ "UserPoolAddOns": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolAddOnsType", "traits": { - "smithy.api#documentation": "

Enables advanced security risk detection. Set the key\n AdvancedSecurityMode to the value \"AUDIT\".

" + "smithy.api#documentation": "

User pool add-ons. Contains settings for activation of advanced security features. To\n log user security information but take no action, set to AUDIT. To\n configure automatic security responses to risky traffic to your user pool, set to\n ENFORCED.

\n

For more information, see Adding advanced security to a user pool.

" } }, "AccountRecoverySetting": { @@ -13791,7 +14038,7 @@ "AttributesRequireVerificationBeforeUpdate": { "target": "com.amazonaws.cognitoidentityprovider#AttributesRequireVerificationBeforeUpdateType", "traits": { - "smithy.api#documentation": "

Requires that your user verifies their email address, phone number, or both before \n Amazon Cognito updates the value of that attribute. When you update a user attribute that has \n this option activated, Amazon Cognito sends a verification message to the new phone number or \n email address. Amazon Cognito doesn’t change the value of the attribute until your user responds \n to the verification message and confirms the new value.

\n

You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the UpdateUserAttributes or AdminUpdateUserAttributes API and set email_verified or\n phone_number_verified to true.

\n

When AttributesRequireVerificationBeforeUpdate is false, your user pool\n doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a\n user pool where AttributesRequireVerificationBeforeUpdate is false, API\n operations that change attribute values can immediately update a user’s\n email or phone_number attribute.

" + "smithy.api#documentation": "

Requires that your user verifies their email address, phone number, or both before\n Amazon Cognito updates the value of that attribute. When you update a user attribute that has\n this option activated, Amazon Cognito sends a verification message to the new phone number or\n email address. Amazon Cognito doesn’t change the value of the attribute until your user responds\n to the verification message and confirms the new value.

\n

You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the AdminUpdateUserAttributes API and set email_verified or\n phone_number_verified to true.

\n

When AttributesRequireVerificationBeforeUpdate is false, your user pool\n doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a\n user pool where AttributesRequireVerificationBeforeUpdate is false, API\n operations that change attribute values can immediately update a user’s\n email or phone_number attribute.

" } } }, @@ -13816,8 +14063,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contextual data, such as the user's device fingerprint, IP address, or location, used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced\n security.

", - "smithy.api#sensitive": {} + "smithy.api#documentation": "

Contextual data, such as the user's device fingerprint, IP address, or location, used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" } }, "com.amazonaws.cognitoidentityprovider#UserFilterType": { @@ -13948,7 +14194,7 @@ "CreationDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The date the user import job was created.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was created.

" } }, "StartDate": { @@ -14092,13 +14338,13 @@ "AdvancedSecurityMode": { "target": "com.amazonaws.cognitoidentityprovider#AdvancedSecurityModeType", "traits": { - "smithy.api#documentation": "

The advanced security mode.

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

The operating mode of advanced security features in your user pool.

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

The user pool add-ons type.

" + "smithy.api#documentation": "

User pool add-ons. Contains settings for activation of advanced security features. To\n log user security information but take no action, set to AUDIT. To\n configure automatic security responses to risky traffic to your user pool, set to\n ENFORCED.

\n

For more information, see Adding advanced security to a user pool.

" } }, "com.amazonaws.cognitoidentityprovider#UserPoolClientDescription": { @@ -14163,13 +14409,13 @@ "LastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The date the user pool client was last modified.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was modified.

" } }, "CreationDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The date the user pool client was created.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was created.

" } }, "RefreshTokenValidity": { @@ -14188,7 +14434,7 @@ "IdTokenValidity": { "target": "com.amazonaws.cognitoidentityprovider#IdTokenValidityType", "traits": { - "smithy.api#documentation": "

The ID token time limit. After this limit expires, your user can't use \n their ID token. To specify the time unit for IdTokenValidity as \n seconds, minutes, hours, or days, \n set a TokenValidityUnits value in your API request.

\n

For example, when you set IdTokenValidity as 10 and\n TokenValidityUnits as hours, your user can authenticate their \n session with their ID token for 10 hours.

\n

The default time unit for AccessTokenValidity in an API request is hours. \n Valid range is displayed below in seconds.

\n

If you don't specify otherwise in the configuration of your app client, your ID\n tokens are valid for one hour.

" + "smithy.api#documentation": "

The ID token time limit. After this limit expires, your user can't use \n their ID token. To specify the time unit for IdTokenValidity as \n seconds, minutes, hours, or days, \n set a TokenValidityUnits value in your API request.

\n

For example, when you set IdTokenValidity as 10 and\n TokenValidityUnits as hours, your user can authenticate their \n session with their ID token for 10 hours.

\n

The default time unit for IdTokenValidity in an API request is hours. \n Valid range is displayed below in seconds.

\n

If you don't specify otherwise in the configuration of your app client, your ID\n tokens are valid for one hour.

" } }, "TokenValidityUnits": { @@ -14218,7 +14464,7 @@ "SupportedIdentityProviders": { "target": "com.amazonaws.cognitoidentityprovider#SupportedIdentityProvidersListType", "traits": { - "smithy.api#documentation": "

A list of provider names for the IdPs that this client supports. The following are\n supported: COGNITO, Facebook, Google, SignInWithApple,\n LoginWithAmazon, and the names of your own SAML and OIDC providers.

" + "smithy.api#documentation": "

A list of provider names for the IdPs that this client supports. The following are\n supported: COGNITO, Facebook, Google,\n SignInWithApple, LoginWithAmazon, and the names of your\n own SAML and OIDC providers.

" } }, "CallbackURLs": { @@ -14255,7 +14501,7 @@ "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Set to true if the client is allowed to follow the OAuth protocol when interacting\n with Amazon Cognito user pools.

" + "smithy.api#documentation": "

Set to true to use OAuth 2.0 features in your user pool app client.

\n

\n AllowedOAuthFlowsUserPoolClient must be true before you can configure \n the following features in your app client.

\n \n

To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set \n AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or \n UpdateUserPoolClient API request. If you don't set a value for \n AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults \n to false.

" } }, "AnalyticsConfiguration": { @@ -14323,13 +14569,13 @@ "LastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The date the user pool description was last modified.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was modified.

" } }, "CreationDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The date the user pool description was created.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was created.

" } } }, @@ -14470,19 +14716,19 @@ "LastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The date the user pool was last modified.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was modified.

" } }, "CreationDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The date the user pool was created.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was created.

" } }, "SchemaAttributes": { "target": "com.amazonaws.cognitoidentityprovider#SchemaAttributesListType", "traits": { - "smithy.api#documentation": "

A container with the schema attributes of a user pool.

" + "smithy.api#documentation": "

A list of the user attributes and their properties in your user pool. The attribute\n schema contains standard attributes, custom attributes with a custom:\n prefix, and developer attributes with a dev: prefix. For more information,\n see User pool\n attributes.

\n

Developer-only attributes are a legacy feature of user pools, are read-only to all app\n clients. You can create and update developer-only attributes only with IAM-authenticated\n API operations. Use app client read/write permissions instead.

" } }, "AutoVerifiedAttributes": { @@ -14548,7 +14794,7 @@ "DeviceConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#DeviceConfigurationType", "traits": { - "smithy.api#documentation": "

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

\n \n

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

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

The device-remembering configuration for a user pool. A null value indicates that you\n have deactivated device remembering in your user pool.

\n \n

When you provide a value for any DeviceConfiguration field, you\n activate the Amazon Cognito device-remembering feature.

\n " } }, "EstimatedNumberOfUsers": { @@ -14561,7 +14807,7 @@ "EmailConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#EmailConfigurationType", "traits": { - "smithy.api#documentation": "

The email configuration of your user pool. The email configuration type sets your\n preferred sending method, Amazon Web Services Region, and sender for messages tfrom your user\n pool.

" + "smithy.api#documentation": "

The email configuration of your user pool. The email configuration type sets your\n preferred sending method, Amazon Web Services Region, and sender for messages from your user\n pool.

" } }, "SmsConfiguration": { @@ -14579,7 +14825,7 @@ "SmsConfigurationFailure": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The reason why the SMS configuration can't send the messages to your users.

\n

This message might include comma-separated values to describe why your SMS\n configuration can't send messages to user pool end users.

\n
\n
InvalidSmsRoleAccessPolicyException
\n
\n

The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly\n configured. For more information, see SmsConfigurationType.

\n
\n
SNSSandbox
\n
\n

The Amazon Web Services account is in the SNS SMS Sandbox and messages will\n only reach verified end users. This parameter won’t get populated with\n SNSSandbox if the IAM user creating the user pool doesn’t have SNS\n permissions. To learn how to move your Amazon Web Services account out of the\n sandbox, see Moving out\n of the SMS sandbox.

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

The reason why the SMS configuration can't send the messages to your users.

\n

This message might include comma-separated values to describe why your SMS\n configuration can't send messages to user pool end users.

\n
\n
InvalidSmsRoleAccessPolicyException
\n
\n

The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly\n configured. For more information, see SmsConfigurationType.

\n
\n
SNSSandbox
\n
\n

The Amazon Web Services account is in the SNS SMS Sandbox and messages will\n only reach verified end users. This parameter won’t get populated with\n SNSSandbox if the user creating the user pool doesn’t have SNS permissions.\n To learn how to move your Amazon Web Services account out of the sandbox, see\n Moving out\n of the SMS sandbox.

\n
\n
" } }, "EmailConfigurationFailure": { @@ -14609,7 +14855,7 @@ "UserPoolAddOns": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolAddOnsType", "traits": { - "smithy.api#documentation": "

The user pool add-ons.

" + "smithy.api#documentation": "

User pool add-ons. Contains settings for activation of advanced security features. To\n log user security information but take no action, set to AUDIT. To\n configure automatic security responses to risky traffic to your user pool, set to\n ENFORCED.

\n

For more information, see Adding advanced security to a user pool.

" } }, "UsernameConfiguration": { @@ -14706,7 +14952,7 @@ "UserLastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "

The last modified date of the user.

" + "smithy.api#documentation": "

The date and time, in ISO 8601 format, when the item was modified.

" } }, "Enabled": { @@ -14719,7 +14965,7 @@ "UserStatus": { "target": "com.amazonaws.cognitoidentityprovider#UserStatusType", "traits": { - "smithy.api#documentation": "

The user status. This can be one of the following:

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

The user status. This can be one of the following:

\n " } }, "MFAOptions": { @@ -14762,7 +15008,7 @@ "CaseSensitive": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { - "smithy.api#documentation": "

Specifies whether user name case sensitivity will be applied for all users in the user\n pool through Amazon Cognito APIs.

\n

Valid values include:

\n
\n
True
\n
\n

Enables case sensitivity for all username input. When this option is set\n to True, users must sign in using the exact capitalization of\n their given username, such as “UserName”. This is the default value.

\n
\n
False
\n
\n

Enables case insensitivity for all username input. For example, when this\n option is set to False, users can sign in using either\n \"username\" or \"Username\". This option also enables both\n preferred_username and email alias to be case\n insensitive, in addition to the username attribute.

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

Specifies whether user name case sensitivity will be applied for all users in the user\n pool through Amazon Cognito APIs. For most use cases, set case sensitivity to False\n (case insensitive) as a best practice. When usernames and email addresses are case\n insensitive, users can sign in as the same user when they enter a different\n capitalization of their user name.

\n

Valid values include:

\n
\n
True
\n
\n

Enables case sensitivity for all username input. When this option is set\n to True, users must sign in using the exact capitalization of\n their given username, such as “UserName”. This is the default value.

\n
\n
False
\n
\n

Enables case insensitivity for all username input. For example, when this\n option is set to False, users can sign in using\n username, USERNAME, or UserName.\n This option also enables both preferred_username and\n email alias to be case insensitive, in addition to the\n username attribute.

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

Use this API to register a user's entered time-based one-time password (TOTP) code and\n mark the user's software token MFA status as \"verified\" if successful. The request takes\n an access token or a session string, but not both.

" + "smithy.api#documentation": "

Use this API to register a user's entered time-based one-time password (TOTP) code and\n mark the user's software token MFA status as \"verified\" if successful. The request takes\n an access token or a session string, but not both.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n " } }, "com.amazonaws.cognitoidentityprovider#VerifySoftwareTokenRequest": { @@ -15045,7 +15291,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "

Verifies the specified user attributes in the user pool.

\n

\n If your user pool requires verification before Amazon Cognito updates the attribute value, \n VerifyUserAttribute updates the affected attribute to its pending value. For more information, \n see \n UserAttributeUpdateSettingsType.\n

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

Verifies the specified user attributes in the user pool.

\n

If your user pool requires verification before Amazon Cognito updates the attribute value,\n VerifyUserAttribute updates the affected attribute to its pending value. For more\n information, see UserAttributeUpdateSettingsType.

\n \n

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

\n ", "smithy.api#optionalAuth": {} } }, diff --git a/codegen/sdk/aws-models/connect.json b/codegen/sdk/aws-models/connect.json index 750216dd748b..d485f544cd55 100644 --- a/codegen/sdk/aws-models/connect.json +++ b/codegen/sdk/aws-models/connect.json @@ -202,6 +202,38 @@ } } }, + "com.amazonaws.connect#AgentAvailabilityTimer": { + "type": "enum", + "members": { + "TIME_SINCE_LAST_ACTIVITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIME_SINCE_LAST_ACTIVITY" + } + }, + "TIME_SINCE_LAST_INBOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIME_SINCE_LAST_INBOUND" + } + } + } + }, + "com.amazonaws.connect#AgentConfig": { + "type": "structure", + "members": { + "Distributions": { + "target": "com.amazonaws.connect#DistributionList", + "traits": { + "smithy.api#documentation": "

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", - "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://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": {} } @@ -9956,16 +10045,86 @@ "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#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#DisassociateTrafficDistributionGroupUserRequest" + }, + "output": { + "target": "com.amazonaws.connect#DisassociateTrafficDistributionGroupUserResponse" + }, + "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": "

Disassociates an agent from a traffic distribution group.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/traffic-distribution-group/{TrafficDistributionGroupId}/user", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connect#DisassociateTrafficDistributionGroupUserRequest": { + "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": {} } }, - "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.

\n
\n
AGENT_ADHERENT_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_NON_RESPONSE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_OCCUPANCY
\n
\n

Unit: Percentage

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_SCHEDULE_ADHERENCE
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_SCHEDULED_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_ABANDON_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_AGENT_CONNECTING_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_AGENT_CONNECTING_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_CONTACT_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_CONVERSATION_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_GREETING_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_HANDLE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_HOLDS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_INTERRUPTIONS_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_INTERRUPTION_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_NON_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_QUEUE_ANSWER_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_TALK_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_TALK_TIME_CUSTOMER
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_CREATED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_HANDLED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_TRANSFERRED_OUT_BY_AGENT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
MAX_QUEUED_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
SUM_CONTACTS_ANSWERED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
SUM_CONTACTS_ABANDONED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
SUM_CONTACTS_DISCONNECTED
\n
\n

Valid metric filter key: DISCONNECT_REASON\n

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n
\n
SUM_RETRY_CALLBACK_ATTEMPTS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n
\n
", + "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.

\n
\n
AGENT_ADHERENT_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_NON_RESPONSE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_OCCUPANCY
\n
\n

Unit: Percentage

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_SCHEDULE_ADHERENCE
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_SCHEDULED_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_ABANDON_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_AGENT_CONNECTING_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_AGENT_CONNECTING_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_CONTACT_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_CONVERSATION_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_GREETING_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_HANDLE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_HOLDS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_INTERRUPTIONS_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_INTERRUPTION_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_NON_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_QUEUE_ANSWER_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_TALK_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_TALK_TIME_CUSTOMER
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_CREATED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_HANDLED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_TRANSFERRED_OUT_BY_AGENT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
MAX_QUEUED_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
SUM_CONTACTS_ANSWERED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
SUM_CONTACTS_ABANDONED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
SUM_CONTACTS_DISCONNECTED
\n
\n

Valid metric filter key: DISCONNECT_REASON\n

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n
\n
SUM_RETRY_CALLBACK_ATTEMPTS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n
\n
", "smithy.api#required": {} } }, @@ -12510,7 +12676,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": { @@ -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.

\n

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.

\n

For more information about phone numbers, see Set Up Phone Numbers for Your\n Contact Center in the Amazon Connect Administrator\n Guide.

\n \n \n ", "smithy.api#http": { "method": "POST", "uri": "/phone-number/list", @@ -17242,6 +17420,97 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#ListTrafficDistributionGroupUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListTrafficDistributionGroupUsersRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListTrafficDistributionGroupUsersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

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": { @@ -20040,6 +20309,30 @@ "traits": { "smithy.api#enumValue": "DID" } + }, + "UIFN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UIFN" + } + }, + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED" + } + }, + "THIRD_PARTY_TF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THIRD_PARTY_TF" + } + }, + "THIRD_PARTY_DID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THIRD_PARTY_DID" + } } } }, @@ -20051,7 +20344,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 2 + "max": 6 } } }, @@ -21690,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": { @@ -23642,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": { @@ -25653,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": { @@ -25691,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.

\n \n

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.

\n " + } } }, "traits": { @@ -25762,7 +26112,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": { @@ -25788,6 +26138,13 @@ "traits": { "smithy.api#documentation": "

The status of the traffic distribution group.

\n " } + }, + "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.

" + } } }, "traits": { @@ -25806,6 +26163,32 @@ } } }, + "com.amazonaws.connect#TrafficDistributionGroupUserSummary": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "

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": { @@ -25889,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": { @@ -27965,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": { @@ -28616,7 +29064,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the traffic distribution for a given traffic distribution group.

\n

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#documentation": "

Updates the traffic distribution for a given traffic distribution group.

\n \n

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.

\n \n

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}", @@ -28630,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": {} } @@ -28640,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/aws-models/database-migration-service.json b/codegen/sdk/aws-models/database-migration-service.json index 27ac2b8e4703..bcd6926bc868 100644 --- a/codegen/sdk/aws-models/database-migration-service.json +++ b/codegen/sdk/aws-models/database-migration-service.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.

" + "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.

", + "smithy.api#examples": [ + { + "title": "Add tags to resource", + "documentation": "Adds metadata tags to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with AWS DMS resources, or used in a Condition statement in an IAM policy for AWS DMS.", + "input": { + "ResourceArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E", + "Tags": [ + { + "Key": "Acount", + "Value": "1633456" + } + ] + }, + "output": {} + } + ] } }, "com.amazonaws.databasemigrationservice#AddTagsToResourceMessage": { @@ -117,7 +133,8 @@ } }, "traits": { - "smithy.api#documentation": "

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" }, @@ -219,6 +260,9 @@ { "target": "com.amazonaws.databasemigrationservice#DescribeEndpointTypes" }, + { + "target": "com.amazonaws.databasemigrationservice#DescribeEngineVersions" + }, { "target": "com.amazonaws.databasemigrationservice#DescribeEventCategories" }, @@ -228,6 +272,9 @@ { "target": "com.amazonaws.databasemigrationservice#DescribeEventSubscriptions" }, + { + "target": "com.amazonaws.databasemigrationservice#DescribeExtensionPackAssociations" + }, { "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorCollectors" }, @@ -243,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" }, @@ -294,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" }, @@ -339,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" }, @@ -444,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", @@ -497,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", @@ -513,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" + ] + } ] } ], @@ -607,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", + "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" } ] }, @@ -1545,7 +1610,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#ApplyPendingMaintenanceActionResponse": { @@ -1569,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": { @@ -1629,6 +1723,12 @@ "target": "com.amazonaws.databasemigrationservice#String" } }, + "com.amazonaws.databasemigrationservice#AvailableUpgradesList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#String" + } + }, "com.amazonaws.databasemigrationservice#BatchStartRecommendations": { "type": "operation", "input": { @@ -1756,7 +1856,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#CancelReplicationTaskAssessmentRunResponse": { @@ -2236,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.

", + "smithy.api#required": {} + } + }, + "Settings": { + "target": "com.amazonaws.databasemigrationservice#DataProviderSettings", + "traits": { + "smithy.api#documentation": "

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": { @@ -2268,7 +2446,46 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an endpoint using the provided settings.

\n \n

For 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.

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

Creates an endpoint using the provided settings.

\n \n

For 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.

\n ", + "smithy.api#examples": [ + { + "title": "Create endpoint", + "documentation": "Creates an endpoint using the provided settings.", + "input": { + "EndpointIdentifier": "test-endpoint-1", + "EndpointType": "source", + "EngineName": "mysql", + "Username": "username", + "Password": "pasword", + "ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com", + "Port": 3306, + "DatabaseName": "testdb", + "ExtraConnectionAttributes": "", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "Tags": [ + { + "Key": "Acount", + "Value": "143327655" + } + ], + "CertificateArn": "", + "SslMode": "require" + }, + "output": { + "Endpoint": { + "Username": "username", + "Status": "active", + "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM", + "ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com", + "EndpointType": "source", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "EngineName": "mysql", + "EndpointIdentifier": "test-endpoint-1", + "Port": 3306 + } + } + } + ] } }, "com.amazonaws.databasemigrationservice#CreateEndpointMessage": { @@ -2483,7 +2700,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#CreateEndpointResponse": { @@ -2594,7 +2812,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#CreateEventSubscriptionResponse": { @@ -2714,13 +2933,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#CreateReplicationConfig": { + "com.amazonaws.databasemigrationservice#CreateInstanceProfile": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#CreateReplicationConfigMessage" + "target": "com.amazonaws.databasemigrationservice#CreateInstanceProfileMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#CreateReplicationConfigResponse" + "target": "com.amazonaws.databasemigrationservice#CreateInstanceProfileResponse" }, "errors": [ { @@ -2729,15 +2948,9 @@ { "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" }, @@ -2746,128 +2959,106 @@ }, { "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#S3AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#S3ResourceNotFoundFault" } ], "traits": { - "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.

" + "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.

", - "smithy.api#required": {} - } - }, - "SourceEndpointArn": { + "AvailabilityZone": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

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.

" } }, - "TargetEndpointArn": { + "KmsKeyArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

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.

\n

If you don't specify a value for the KmsKeyArn parameter, then\n DMS uses your default encryption key.

\n

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a\n different default encryption key for each Amazon Web Services Region.

" } }, - "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.

" } }, - "ReplicationType": { - "target": "com.amazonaws.databasemigrationservice#MigrationTypeValue", + "Tags": { + "target": "com.amazonaws.databasemigrationservice#TagList", "traits": { - "smithy.api#documentation": "

The type of DMS Serverless replication to provision\n using this replication configuration.

\n

Possible values:

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

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.

" } }, - "ReplicationSettings": { + "InstanceProfileName": { "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.

" + "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" }, @@ -2878,40 +3069,365 @@ "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.

\n

DMS 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.

\n

You 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.

\n

Constraints:

\n \n

Example: myrepinstance\n

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

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\".

\n

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.

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

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 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#input": {} + } + }, + "com.amazonaws.databasemigrationservice#CreateMigrationProjectResponse": { + "type": "structure", + "members": { + "MigrationProject": { + "target": "com.amazonaws.databasemigrationservice#MigrationProject", + "traits": { + "smithy.api#documentation": "

The migration project that was created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#CreateReplicationConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#CreateReplicationConfigMessage" + }, + "output": { + "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" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" + } + ], + "traits": { + "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#CreateReplicationConfigMessage": { + "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.

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

The Amazon Resource Name (ARN) of the source endpoint for\n this DMS Serverless replication configuration.

", + "smithy.api#required": {} + } + }, + "TargetEndpointArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "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.

\n

Possible values:

\n ", + "smithy.api#required": {} + } + }, + "TableMappings": { + "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": {} + } + }, + "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 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#input": {} + } + }, + "com.amazonaws.databasemigrationservice#CreateReplicationConfigResponse": { + "type": "structure", + "members": { + "ReplicationConfig": { + "target": "com.amazonaws.databasemigrationservice#ReplicationConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters returned from the DMS Serverless replication after it is created.

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

", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#CreateReplicationInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#CreateReplicationInstanceMessage" + }, + "output": { + "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" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#StorageQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates the replication instance using the specified parameters.

\n

DMS 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#CreateReplicationInstanceMessage": { + "type": "structure", + "members": { + "ReplicationInstanceIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The replication instance identifier. This parameter is stored as a lowercase\n string.

\n

Constraints:

\n \n

Example: myrepinstance\n

", + "smithy.api#required": {} + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage (in gigabytes) to be initially allocated for the replication\n instance.

" + } + }, + "ReplicationInstanceClass": { + "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\".

\n

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": {} + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.databasemigrationservice#VpcSecurityGroupIdList", + "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.

" } }, "AvailabilityZone": { @@ -2988,7 +3504,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#CreateReplicationInstanceResponse": { @@ -3035,7 +3552,30 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a replication subnet group given a list of the subnet IDs in a VPC.

\n

The 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.

\n

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 replication subnet group given a list of the subnet IDs in a VPC.

\n

The 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.

\n

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#CreateReplicationSubnetGroupMessage": { @@ -3070,7 +3610,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#CreateReplicationSubnetGroupResponse": { @@ -3117,7 +3658,43 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a replication task using the specified parameters.

" + "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#CreateReplicationTaskMessage": { @@ -3209,7 +3786,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#CreateReplicationTaskResponse": { @@ -3244,6 +3822,150 @@ } } }, + "com.amazonaws.databasemigrationservice#DataProvider": { + "type": "structure", + "members": { + "DataProviderName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The name of the data provider.

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

The Amazon Resource Name (ARN) string that uniquely identifies the data provider.

" + } + }, + "DataProviderCreationTime": { + "target": "com.amazonaws.databasemigrationservice#Iso8601DateTime", + "traits": { + "smithy.api#documentation": "

The time the data provider was created.

" + } + }, + "Description": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "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.

" + } + }, + "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.

" + } + }, + "Settings": { + "target": "com.amazonaws.databasemigrationservice#DataProviderSettings", + "traits": { + "smithy.api#documentation": "

The settings in JSON format for a data provider.

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

Provides information that defines a data provider.

" + } + }, + "com.amazonaws.databasemigrationservice#DataProviderDescriptor": { + "type": "structure", + "members": { + "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.

" + } + }, + "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#documentation": "

Information about a data provider.

" + } + }, + "com.amazonaws.databasemigrationservice#DataProviderDescriptorDefinition": { + "type": "structure", + "members": { + "DataProviderIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "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#documentation": "

Information about a data provider.

" + } + }, + "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" + }, + "MySqlSettings": { + "target": "com.amazonaws.databasemigrationservice#MySqlDataProviderSettings" + }, + "OracleSettings": { + "target": "com.amazonaws.databasemigrationservice#OracleDataProviderSettings" + }, + "MicrosoftSqlServerSettings": { + "target": "com.amazonaws.databasemigrationservice#MicrosoftSqlServerDataProviderSettings" + } + }, + "traits": { + "smithy.api#documentation": "

Provides information that defines a data provider.

" + } + }, "com.amazonaws.databasemigrationservice#DatabaseInstanceSoftwareDetailsResponse": { "type": "structure", "members": { @@ -3463,6 +4185,20 @@ } } }, + "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": { @@ -3480,7 +4216,19 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified certificate.

" + "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#DeleteCertificateMessage": { @@ -3493,6 +4241,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#DeleteCertificateResponse": { @@ -3544,7 +4295,20 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the connection between a replication instance and an endpoint.

" + "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#DeleteConnectionMessage": { @@ -3566,7 +4330,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#DeleteConnectionResponse": { @@ -3584,6 +4349,58 @@ "smithy.api#output": {} } }, + "com.amazonaws.databasemigrationservice#DeleteDataProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DeleteDataProviderMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DeleteDataProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified data provider.

\n \n

All migration projects associated with the data provider must be deleted or modified \n before you can delete the data provider.

\n " + } + }, + "com.amazonaws.databasemigrationservice#DeleteDataProviderMessage": { + "type": "structure", + "members": { + "DataProviderIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The identifier of the data provider to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#DeleteDataProviderResponse": { + "type": "structure", + "members": { + "DataProvider": { + "target": "com.amazonaws.databasemigrationservice#DataProvider", + "traits": { + "smithy.api#documentation": "

The data provider that was deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.databasemigrationservice#DeleteEndpoint": { "type": "operation", "input": { @@ -3601,7 +4418,29 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified endpoint.

\n \n

All tasks associated with the endpoint must be deleted before you can delete the\n endpoint.

\n \n

" + "smithy.api#documentation": "

Deletes the specified endpoint.

\n \n

All tasks associated with the endpoint must be deleted before you can delete the\n endpoint.

\n \n

", + "smithy.api#examples": [ + { + "title": "Delete Endpoint", + "documentation": "Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint.\n", + "input": { + "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM" + }, + "output": { + "Endpoint": { + "Username": "username", + "Status": "active", + "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM", + "ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com", + "EndpointType": "source", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "EngineName": "mysql", + "EndpointIdentifier": "test-endpoint-1", + "Port": 3306 + } + } + } + ] } }, "com.amazonaws.databasemigrationservice#DeleteEndpointMessage": { @@ -3616,7 +4455,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#DeleteEndpointResponse": { @@ -3666,7 +4506,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#DeleteEventSubscriptionResponse": { @@ -3753,13 +4594,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationConfig": { + "com.amazonaws.databasemigrationservice#DeleteInstanceProfile": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationConfigMessage" + "target": "com.amazonaws.databasemigrationservice#DeleteInstanceProfileMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationConfigResponse" + "target": "com.amazonaws.databasemigrationservice#DeleteInstanceProfileResponse" }, "errors": [ { @@ -3773,48 +4614,50 @@ } ], "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 instance profile.

\n \n

All migration projects associated with the instance profile must be deleted or modified \n before you can delete the instance profile.

\n " } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationConfigMessage": { + "com.amazonaws.databasemigrationservice#DeleteInstanceProfileMessage": { "type": "structure", "members": { - "ReplicationConfigArn": { + "InstanceProfileIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The replication config to delete.

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

The identifier of the instance profile to delete.

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

" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationConfigResponse": { + "com.amazonaws.databasemigrationservice#DeleteInstanceProfileResponse": { "type": "structure", "members": { - "ReplicationConfig": { - "target": "com.amazonaws.databasemigrationservice#ReplicationConfig", + "InstanceProfile": { + "target": "com.amazonaws.databasemigrationservice#InstanceProfile", "traits": { - "smithy.api#documentation": "

Configuration parameters returned for the DMS Serverless replication after it is deleted.

" + "smithy.api#documentation": "

The instance profile that was deleted.

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

", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationInstance": { + "com.amazonaws.databasemigrationservice#DeleteMigrationProject": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationInstanceMessage" + "target": "com.amazonaws.databasemigrationservice#DeleteMigrationProjectMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationInstanceResponse" + "target": "com.amazonaws.databasemigrationservice#DeleteMigrationProjectResponse" }, "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, { "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, @@ -3823,48 +4666,50 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified replication instance.

\n \n

You must delete any migration tasks that are associated with the replication instance\n before you can delete it.

\n \n

" + "smithy.api#documentation": "

Deletes the specified migration project.

\n \n

The migration project must be closed before you can delete it.

\n " } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationInstanceMessage": { + "com.amazonaws.databasemigrationservice#DeleteMigrationProjectMessage": { "type": "structure", "members": { - "ReplicationInstanceArn": { + "MigrationProjectIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication instance to be deleted.

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

The 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#DeleteReplicationInstanceResponse": { + "com.amazonaws.databasemigrationservice#DeleteMigrationProjectResponse": { "type": "structure", "members": { - "ReplicationInstance": { - "target": "com.amazonaws.databasemigrationservice#ReplicationInstance", + "MigrationProject": { + "target": "com.amazonaws.databasemigrationservice#MigrationProject", "traits": { - "smithy.api#documentation": "

The replication instance that was deleted.

" + "smithy.api#documentation": "

The migration project that was deleted.

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

", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroup": { + "com.amazonaws.databasemigrationservice#DeleteReplicationConfig": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroupMessage" + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationConfigMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroupResponse" + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationConfigResponse" }, "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, { "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, @@ -3873,39 +4718,47 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a subnet group.

" + "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#DeleteReplicationSubnetGroupMessage": { + "com.amazonaws.databasemigrationservice#DeleteReplicationConfigMessage": { "type": "structure", "members": { - "ReplicationSubnetGroupIdentifier": { + "ReplicationConfigArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The subnet group name of the replication instance.

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

The replication config to delete.

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

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroupResponse": { + "com.amazonaws.databasemigrationservice#DeleteReplicationConfigResponse": { "type": "structure", - "members": {}, + "members": { + "ReplicationConfig": { + "target": "com.amazonaws.databasemigrationservice#ReplicationConfig", + "traits": { + "smithy.api#documentation": "

Configuration parameters returned for the DMS Serverless replication after it is deleted.

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

", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DeleteReplicationTask": { + "com.amazonaws.databasemigrationservice#DeleteReplicationInstance": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationTaskMessage" + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationInstanceMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationTaskResponse" + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationInstanceResponse" }, "errors": [ { @@ -3916,20 +4769,208 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified replication task.

" - } - }, - "com.amazonaws.databasemigrationservice#DeleteReplicationTaskAssessmentRun": { - "type": "operation", - "input": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationTaskAssessmentRunMessage" - }, - "output": { - "target": "com.amazonaws.databasemigrationservice#DeleteReplicationTaskAssessmentRunResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + "smithy.api#documentation": "

Deletes the specified replication instance.

\n \n

You must delete any migration tasks that are associated with the replication instance\n before you can delete it.

\n \n

", + "smithy.api#examples": [ + { + "title": "Delete Replication Instance", + "documentation": "Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.\n\n", + "input": { + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ" + }, + "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#DeleteReplicationInstanceMessage": { + "type": "structure", + "members": { + "ReplicationInstanceArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

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#DeleteReplicationInstanceResponse": { + "type": "structure", + "members": { + "ReplicationInstance": { + "target": "com.amazonaws.databasemigrationservice#ReplicationInstance", + "traits": { + "smithy.api#documentation": "

The replication instance that was deleted.

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

", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroupMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "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#DeleteReplicationSubnetGroupMessage": { + "type": "structure", + "members": { + "ReplicationSubnetGroupIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The subnet group name of the replication instance.

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

", + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#DeleteReplicationSubnetGroupResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DeleteReplicationTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationTaskMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DeleteReplicationTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "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" @@ -3954,7 +4995,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#DeleteReplicationTaskAssessmentRunResponse": { @@ -3984,7 +5026,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#DeleteReplicationTaskResponse": { @@ -4011,14 +5054,40 @@ "target": "com.amazonaws.databasemigrationservice#DescribeAccountAttributesResponse" }, "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.

\n

This command does not take any parameters.

" + "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.

\n

This 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 + } + ] + } + } + ] } }, "com.amazonaws.databasemigrationservice#DescribeAccountAttributesMessage": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#DescribeAccountAttributesResponse": { @@ -4117,7 +5186,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#DescribeApplicableIndividualAssessmentsResponse": { @@ -4156,6 +5226,29 @@ ], "traits": { "smithy.api#documentation": "

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", @@ -4184,6 +5277,9 @@ "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.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#DescribeCertificatesResponse": { @@ -4221,6 +5317,37 @@ ], "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#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", @@ -4279,7 +5406,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#DescribeConnectionsResponse": { @@ -4303,60 +5431,51 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeEndpointSettings": { + "com.amazonaws.databasemigrationservice#DescribeConversionConfiguration": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeEndpointSettingsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeConversionConfigurationMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeEndpointSettingsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeConversionConfigurationResponse" }, - "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" + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } + ], + "traits": { + "smithy.api#documentation": "

Returns configuration parameters for a schema conversion project.

" } }, - "com.amazonaws.databasemigrationservice#DescribeEndpointSettingsMessage": { + "com.amazonaws.databasemigrationservice#DescribeConversionConfigurationMessage": { "type": "structure", "members": { - "EngineName": { + "MigrationProjectIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The database engine used for your source or target endpoint.

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

The name or Amazon Resource Name (ARN) for the schema conversion project 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 \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.

" - } - }, - "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.

" - } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeEndpointSettingsResponse": { + "com.amazonaws.databasemigrationservice#DescribeConversionConfigurationResponse": { "type": "structure", "members": { - "Marker": { + "MigrationProjectIdentifier": { "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.

" + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) for the schema conversion project.

" } }, - "EndpointSettings": { - "target": "com.amazonaws.databasemigrationservice#EndpointSettingsList", + "ConversionConfiguration": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Descriptions of the endpoint settings available for your source or target database engine.

" + "smithy.api#documentation": "

The configuration parameters for the schema conversion project.

" } } }, @@ -4364,16 +5483,24 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeEndpointTypes": { + "com.amazonaws.databasemigrationservice#DescribeDataProviders": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeEndpointTypesMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeDataProvidersMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeEndpointTypesResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeDataProvidersResponse" }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], "traits": { - "smithy.api#documentation": "

Returns information about the type of endpoints available.

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

Returns a paginated list of data providers for your account in the current region.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -4381,77 +5508,251 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeEndpointTypesMessage": { + "com.amazonaws.databasemigrationservice#DescribeDataProvidersMessage": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "

Filters applied to the endpoint types.

\n

Valid filter names: engine-name | endpoint-type

" + "smithy.api#documentation": "

Filters applied to the data providers 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, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: 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, DMS includes a pagination token \n in the response so that you can retrieve the remaining results.

" } }, "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.

" + "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.

\n

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.

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

" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeEndpointTypesResponse": { + "com.amazonaws.databasemigrationservice#DescribeDataProvidersResponse": { "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.

" + "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.

\n

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.

" } }, - "SupportedEndpointTypes": { - "target": "com.amazonaws.databasemigrationservice#SupportedEndpointTypeList", + "DataProviders": { + "target": "com.amazonaws.databasemigrationservice#DataProviderList", "traits": { - "smithy.api#documentation": "

The types of endpoints that are supported.

" + "smithy.api#documentation": "

A description of data providers.

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

", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeEndpoints": { + "com.amazonaws.databasemigrationservice#DescribeEndpointSettings": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeEndpointsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeEndpointSettingsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeEndpointsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeEndpointSettingsResponse" }, - "errors": [ - { - "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" - } - ], "traits": { - "smithy.api#documentation": "

Returns information about the endpoints for your account in the current region.

", + "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" + } + } + }, + "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": {} + } }, - "smithy.waiters#waitable": { - "EndpointDeleted": { - "documentation": "Wait until testing endpoint is deleted.", - "acceptors": [ + "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.

" + } + }, + "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.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeEndpointSettingsResponse": { + "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 specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "EndpointSettings": { + "target": "com.amazonaws.databasemigrationservice#EndpointSettingsList", + "traits": { + "smithy.api#documentation": "

Descriptions of the endpoint settings available for your source or target database engine.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeEndpointTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeEndpointTypesMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeEndpointTypesResponse" + }, + "traits": { + "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": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeEndpointTypesMessage": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "

Filters applied to the endpoint types.

\n

Valid 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.

\n

Default: 100

\n

Constraints: 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.

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

", + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeEndpointTypesResponse": { + "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.

" + } + }, + "SupportedEndpointTypes": { + "target": "com.amazonaws.databasemigrationservice#SupportedEndpointTypeList", + "traits": { + "smithy.api#documentation": "

The types of endpoints that are supported.

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

", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeEndpointsMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeEndpointsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "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": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + }, + "smithy.waiters#waitable": { + "EndpointDeleted": { + "documentation": "Wait until testing endpoint is deleted.", + "acceptors": [ { "state": "success", "matcher": { @@ -4507,7 +5808,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#DescribeEndpointsResponse": { @@ -4531,6 +5833,63 @@ "smithy.api#output": {} } }, + "com.amazonaws.databasemigrationservice#DescribeEngineVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeEngineVersionsMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeEngineVersionsResponse" + }, + "traits": { + "smithy.api#documentation": "

Returns information about the replication instance versions used in the project.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "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 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.

" + } + }, + "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.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeEngineVersionsResponse": { + "type": "structure", + "members": { + "EngineVersions": { + "target": "com.amazonaws.databasemigrationservice#EngineVersionList", + "traits": { + "smithy.api#documentation": "

Returned EngineVersion objects that describe the replication instance engine versions used in the project.

" + } + }, + "Marker": { + "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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.databasemigrationservice#DescribeEventCategories": { "type": "operation", "input": { @@ -4560,7 +5919,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#DescribeEventCategoriesResponse": { @@ -4629,7 +5989,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#DescribeEventSubscriptionsResponse": { @@ -4729,7 +6090,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#DescribeEventsResponse": { @@ -4753,6 +6115,76 @@ "smithy.api#output": {} } }, + "com.amazonaws.databasemigrationservice#DescribeExtensionPackAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeExtensionPackAssociationsMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeExtensionPackAssociationsResponse" + }, + "traits": { + "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#DescribeExtensionPackAssociationsMessage": { + "type": "structure", + "members": { + "MigrationProjectIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "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.

\n

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.

" + } + }, + "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.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeExtensionPackAssociationsResponse": { + "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.

\n

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.

" + } + }, + "Requests": { + "target": "com.amazonaws.databasemigrationservice#SchemaConversionRequestList", + "traits": { + "smithy.api#documentation": "

A paginated list of extension pack associations for the specified migration project.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorCollectors": { "type": "operation", "input": { @@ -5087,16 +6519,24 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstances": { + "com.amazonaws.databasemigrationservice#DescribeInstanceProfiles": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstancesMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeInstanceProfilesMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstancesResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeInstanceProfilesResponse" }, - "traits": { - "smithy.api#documentation": "

Returns information about the replication instance types that can be created in the\n specified region.

", + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a paginated list of instance profiles for your account in the current region.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5104,54 +6544,59 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstancesMessage": { + "com.amazonaws.databasemigrationservice#DescribeInstanceProfilesMessage": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "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\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.

\n

Default: 100

\n

Constraints: 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, DMS includes a pagination token \n in the response so that you can retrieve the remaining results.

" } }, "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.

" + "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.

\n

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.

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

" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstancesResponse": { + "com.amazonaws.databasemigrationservice#DescribeInstanceProfilesResponse": { "type": "structure", "members": { - "OrderableReplicationInstances": { - "target": "com.amazonaws.databasemigrationservice#OrderableReplicationInstanceList", + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The order-able replication instances available.

" + "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.

\n

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.

" } }, - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", + "InstanceProfiles": { + "target": "com.amazonaws.databasemigrationservice#InstanceProfileList", "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.

" + "smithy.api#documentation": "

A description of instance profiles.

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

", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribePendingMaintenanceActions": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelAssessments": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribePendingMaintenanceActionsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelAssessmentsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribePendingMaintenanceActionsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelAssessmentsResponse" }, "errors": [ { @@ -5159,7 +6604,7 @@ } ], "traits": { - "smithy.api#documentation": "

For internal use only

", + "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", @@ -5167,103 +6612,107 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribePendingMaintenanceActionsMessage": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelAssessmentsMessage": { "type": "structure", "members": { - "ReplicationInstanceArn": { + "MigrationProjectIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication instance.

" + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the migration project.

", + "smithy.api#required": {} } }, "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "

" + "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.

" + "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.

\n

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.

" } }, "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.

\n

Default: 100

\n

Constraints: 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, DMS includes a pagination token \n in the response so that you can retrieve the remaining results.

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

" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribePendingMaintenanceActionsResponse": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelAssessmentsResponse": { "type": "structure", "members": { - "PendingMaintenanceActions": { - "target": "com.amazonaws.databasemigrationservice#PendingMaintenanceActions", + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The pending maintenance action.

" + "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.

\n

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.

" } }, - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", + "Requests": { + "target": "com.amazonaws.databasemigrationservice#SchemaConversionRequestList", "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.

" + "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#DescribeRecommendationLimitations": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelConversions": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeRecommendationLimitationsRequest" + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelConversionsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeRecommendationLimitationsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelConversionsResponse" }, "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": "

Returns a paginated list of metadata model conversions for a migration project.

", "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", + "inputToken": "Marker", + "outputToken": "Marker", "pageSize": "MaxRecords" } } }, - "com.amazonaws.databasemigrationservice#DescribeRecommendationLimitationsRequest": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelConversionsMessage": { "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 limitations described in the form of key-value pairs.

" + "smithy.api#documentation": "

Filters applied to the metadata model conversions described in the form of key-value pairs.

" } }, - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", "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.

" + "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.

\n

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.

" } }, - "NextToken": { - "target": "com.amazonaws.databasemigrationservice#String", + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "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.

\n

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.

" + "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.

" } } }, @@ -5271,19 +6720,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeRecommendationLimitationsResponse": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelConversionsResponse": { "type": "structure", "members": { - "NextToken": { + "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "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.

" + "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.

\n

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.

" } }, - "Limitations": { - "target": "com.amazonaws.databasemigrationservice#LimitationList", + "Requests": { + "target": "com.amazonaws.databasemigrationservice#SchemaConversionRequestList", "traits": { - "smithy.api#documentation": "

The list of limitations for recommendations of target Amazon Web Services engines.

" + "smithy.api#documentation": "

A paginated list of metadata model conversions.

" } } }, @@ -5291,50 +6740,54 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeRecommendations": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsAsScript": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeRecommendationsRequest" + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsAsScriptMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeRecommendationsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsAsScriptResponse" }, "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 target engine recommendations for your source\n databases.

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

Returns a paginated list of metadata model exports.

", "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", + "inputToken": "Marker", + "outputToken": "Marker", "pageSize": "MaxRecords" } } }, - "com.amazonaws.databasemigrationservice#DescribeRecommendationsRequest": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsAsScriptMessage": { "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 target engine recommendations described in the form of\n key-value pairs.

" + "smithy.api#documentation": "

Filters applied to the metadata model exports described in the form of key-value pairs.

" } }, - "MaxRecords": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", "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.

" + "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.

\n

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.

" } }, - "NextToken": { - "target": "com.amazonaws.databasemigrationservice#String", + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "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.

\n

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.

" + "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.

" } } }, @@ -5342,19 +6795,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeRecommendationsResponse": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsAsScriptResponse": { "type": "structure", "members": { - "NextToken": { + "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "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.

" + "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.

\n

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.

" } }, - "Recommendations": { - "target": "com.amazonaws.databasemigrationservice#RecommendationList", + "Requests": { + "target": "com.amazonaws.databasemigrationservice#SchemaConversionRequestList", "traits": { - "smithy.api#documentation": "

The list of recommendations of target engines that Fleet Advisor created for the\n source database.

" + "smithy.api#documentation": "

A paginated list of metadata model exports.

" } } }, @@ -5362,63 +6815,88 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeRefreshSchemasStatus": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsToTarget": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeRefreshSchemasStatusMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsToTargetMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeRefreshSchemasStatusResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsToTargetResponse" }, "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 metadata model exports.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } } }, - "com.amazonaws.databasemigrationservice#DescribeRefreshSchemasStatusMessage": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsToTargetMessage": { "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 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.

\n

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.

" + } + }, + "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.

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

" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeRefreshSchemasStatusResponse": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelExportsToTargetResponse": { "type": "structure", "members": { - "RefreshSchemasStatus": { - "target": "com.amazonaws.databasemigrationservice#RefreshSchemasStatus", + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

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.

\n

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.

" + } + }, + "Requests": { + "target": "com.amazonaws.databasemigrationservice#SchemaConversionRequestList", + "traits": { + "smithy.api#documentation": "

A paginated list of metadata model exports.

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

", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationConfigs": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelImports": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationConfigsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelImportsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationConfigsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeMetadataModelImportsResponse" }, "errors": [ { @@ -5426,7 +6904,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns one or more existing DMS Serverless replication configurations as a list of structures.

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

Returns a paginated list of metadata model imports.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5434,71 +6912,77 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationConfigsMessage": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelImportsMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", + "MigrationProjectIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Filters applied to the replication configs.

" + "smithy.api#documentation": "

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 specified \n MaxRecords value, a pagination token called a marker is included in the response so that \n the remaining results can be retrieved.

" + "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": "

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.

" + "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.

\n

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.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

A paginated list of metadata model imports.

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

" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationConfigsResponse": { + "com.amazonaws.databasemigrationservice#DescribeMetadataModelImportsResponse": { "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 specified, the response \n includes only records beyond the marker, up to the value specified by MaxRecords.

" + "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.

\n

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.

" } }, - "ReplicationConfigs": { - "target": "com.amazonaws.databasemigrationservice#ReplicationConfigList", + "Requests": { + "target": "com.amazonaws.databasemigrationservice#SchemaConversionRequestList", "traits": { - "smithy.api#documentation": "

Returned configuration parameters that describe each provisioned DMS Serverless replication.

" + "smithy.api#documentation": "

A paginated list of metadata model imports.

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

", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationInstanceTaskLogs": { + "com.amazonaws.databasemigrationservice#DescribeMigrationProjects": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationInstanceTaskLogsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeMigrationProjectsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationInstanceTaskLogsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeMigrationProjectsResponse" }, "errors": [ { - "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, { "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } ], "traits": { - "smithy.api#documentation": "

Returns information about the task logs for the specified task.

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

Returns a paginated list of migration projects for your account in the current region.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5506,49 +6990,45 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationInstanceTaskLogsMessage": { + "com.amazonaws.databasemigrationservice#DescribeMigrationProjectsMessage": { "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": "

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, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: 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, DMS includes a pagination token \n in the response so that you can retrieve the remaining results.

" } }, "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.

" + "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.

\n

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.

" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationInstanceTaskLogsResponse": { + "com.amazonaws.databasemigrationservice#DescribeMigrationProjectsResponse": { "type": "structure", "members": { - "ReplicationInstanceArn": { + "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

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).

" + "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.

\n

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.

" } }, - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", + "MigrationProjects": { + "target": "com.amazonaws.databasemigrationservice#MigrationProjectList", "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.

" + "smithy.api#documentation": "

A description of migration projects.

" } } }, @@ -5556,122 +7036,45 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationInstances": { + "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstances": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationInstancesMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstancesMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationInstancesResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstancesResponse" }, - "errors": [ - { - "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" - } - ], "traits": { - "smithy.api#documentation": "

Returns information about replication instances for your account in the current\n region.

", + "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" - }, - "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.

\n

Valid 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.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } + } + } + }, + "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.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } }, "Marker": { "target": "com.amazonaws.databasemigrationservice#String", @@ -5681,22 +7084,23 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationInstancesResponse": { + "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstancesResponse": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", + "OrderableReplicationInstances": { + "target": "com.amazonaws.databasemigrationservice#OrderableReplicationInstanceList", "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.

" + "smithy.api#documentation": "

The order-able replication instances available.

" } }, - "ReplicationInstances": { - "target": "com.amazonaws.databasemigrationservice#ReplicationInstanceList", + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The replication instances described.

" + "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.

" } } }, @@ -5705,13 +7109,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationSubnetGroups": { + "com.amazonaws.databasemigrationservice#DescribePendingMaintenanceActions": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationSubnetGroupsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribePendingMaintenanceActionsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationSubnetGroupsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribePendingMaintenanceActionsResponse" }, "errors": [ { @@ -5719,7 +7123,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about the replication subnet groups.

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

For internal use only

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5727,19 +7131,19 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationSubnetGroupsMessage": { + "com.amazonaws.databasemigrationservice#DescribePendingMaintenanceActionsMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", + "ReplicationInstanceArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Filters applied to replication subnet groups.

\n

Valid filter names: replication-subnet-group-id

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication instance.

" } }, - "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.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

" } }, "Marker": { @@ -5747,25 +7151,32 @@ "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.

" } + }, + "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.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

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

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationSubnetGroupsResponse": { + "com.amazonaws.databasemigrationservice#DescribePendingMaintenanceActionsResponse": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", + "PendingMaintenanceActions": { + "target": "com.amazonaws.databasemigrationservice#PendingMaintenanceActions", "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.

" + "smithy.api#documentation": "

The pending maintenance action.

" } }, - "ReplicationSubnetGroups": { - "target": "com.amazonaws.databasemigrationservice#ReplicationSubnetGroups", + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

A description of the replication subnet groups.

" + "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.

" } } }, @@ -5774,158 +7185,203 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatistics": { + "com.amazonaws.databasemigrationservice#DescribeRecommendationLimitations": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatisticsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeRecommendationLimitationsRequest" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatisticsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeRecommendationLimitationsResponse" }, "errors": [ { - "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, { - "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" } ], "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#documentation": "

Returns a paginated list of limitations for recommendations of target Amazon Web Services\n engines.

", "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", + "inputToken": "NextToken", + "outputToken": "NextToken", "pageSize": "MaxRecords" } } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatisticsMessage": { + "com.amazonaws.databasemigrationservice#DescribeRecommendationLimitationsRequest": { "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 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 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.

" + "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.

" } }, - "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.

" - } - }, - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", - "traits": { - "smithy.api#documentation": "

Filters applied to the replication table statistics.

" + "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.

\n

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.

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

" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatisticsResponse": { + "com.amazonaws.databasemigrationservice#DescribeRecommendationLimitationsResponse": { "type": "structure", "members": { - "ReplicationConfigArn": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name of the replication config.

" - } - }, - "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.

" + "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.

" } }, - "ReplicationTableStatistics": { - "target": "com.amazonaws.databasemigrationservice#ReplicationTableStatisticsList", + "Limitations": { + "target": "com.amazonaws.databasemigrationservice#LimitationList", "traits": { - "smithy.api#documentation": "

Returns table statistics on the replication, including table name, rows inserted, rows updated, and rows deleted.

" + "smithy.api#documentation": "

The list of limitations for recommendations of target Amazon Web Services engines.

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

", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResults": { + "com.amazonaws.databasemigrationservice#DescribeRecommendations": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeRecommendationsRequest" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeRecommendationsResponse" }, "errors": [ { - "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" } ], "traits": { - "smithy.api#documentation": "

Returns the task assessment results from the Amazon S3 bucket that DMS creates in your\n Amazon Web Services account. This action always returns the\n latest results.

\n

For more information about DMS task assessments, see \n Creating a task assessment report\n in the Database Migration Service User Guide.

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

Returns a paginated list of target engine recommendations for your source\n databases.

", "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", + "inputToken": "NextToken", + "outputToken": "NextToken", "pageSize": "MaxRecords" } } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsMessage": { + "com.amazonaws.databasemigrationservice#DescribeRecommendationsRequest": { "type": "structure", "members": { - "ReplicationTaskArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", "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.

" + "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, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: 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, Fleet Advisor includes a pagination token\n in the response so that you can retrieve the remaining results.

" } }, - "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.

" + "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.

\n

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.

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

" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsResponse": { + "com.amazonaws.databasemigrationservice#DescribeRecommendationsResponse": { "type": "structure", "members": { - "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.

" + "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.

" } }, - "BucketName": { - "target": "com.amazonaws.databasemigrationservice#String", + "Recommendations": { + "target": "com.amazonaws.databasemigrationservice#RecommendationList", "traits": { - "smithy.api#documentation": "

- The Amazon S3 bucket where the task assessment report is located.

" + "smithy.api#documentation": "

The list of recommendations of target engines that Fleet Advisor created for the\n source database.

" } - }, - "ReplicationTaskAssessmentResults": { - "target": "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentResultList", - "traits": { - "smithy.api#documentation": "

The task assessment report.

" + } + }, + "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.

" } } }, @@ -5934,13 +7390,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentRuns": { + "com.amazonaws.databasemigrationservice#DescribeReplicationConfigs": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentRunsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationConfigsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentRunsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationConfigsResponse" }, "errors": [ { @@ -5948,7 +7404,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a paginated list of premigration assessment runs based on filter\n settings.

\n

These filter settings can specify a combination of premigration assessment runs,\n migration tasks, replication instances, and assessment run status values.

\n \n

This operation doesn't return information about individual assessments. For this\n information, see the DescribeReplicationTaskIndividualAssessments\n operation.

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

Returns one or more existing DMS Serverless replication configurations as a list of structures.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5956,45 +7412,46 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentRunsMessage": { + "com.amazonaws.databasemigrationservice#DescribeReplicationConfigsMessage": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "

Filters applied to the premigration assessment runs described in the form of key-value pairs.

\n

Valid filter names: replication-task-assessment-run-arn, replication-task-arn,\n replication-instance-arn, status\n

" + "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\n specified MaxRecords value, a pagination token called a marker is included in\n 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 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.

" } }, "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.

" + "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.

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

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentRunsResponse": { + "com.amazonaws.databasemigrationservice#DescribeReplicationConfigsResponse": { "type": "structure", "members": { "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

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.

" + "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.

" } }, - "ReplicationTaskAssessmentRuns": { - "target": "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentRunList", + "ReplicationConfigs": { + "target": "com.amazonaws.databasemigrationservice#ReplicationConfigList", "traits": { - "smithy.api#documentation": "

One or more premigration assessment runs as specified by Filters.

" + "smithy.api#documentation": "

Returned configuration parameters that describe each provisioned DMS Serverless replication.

" } } }, @@ -6003,21 +7460,24 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTaskIndividualAssessments": { + "com.amazonaws.databasemigrationservice#DescribeReplicationInstanceTaskLogs": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskIndividualAssessmentsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationInstanceTaskLogsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskIndividualAssessmentsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationInstanceTaskLogsResponse" }, "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, { "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } ], "traits": { - "smithy.api#documentation": "

Returns a paginated list of individual assessments based on filter settings.

\n

These filter settings can specify a combination of premigration assessment runs,\n migration tasks, and assessment status values.

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

Returns information about the task logs for the specified task.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -6025,60 +7485,66 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTaskIndividualAssessmentsMessage": { + "com.amazonaws.databasemigrationservice#DescribeReplicationInstanceTaskLogsMessage": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", + "ReplicationInstanceArn": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Filters applied to the individual assessments described in the form of key-value\n pairs.

\n

Valid filter names: replication-task-assessment-run-arn,\n replication-task-arn, status\n

" + "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 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.

" + "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.

\n

Default: 100

\n

Constraints: 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.

" + "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.

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

" + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTaskIndividualAssessmentsResponse": { + "com.amazonaws.databasemigrationservice#DescribeReplicationInstanceTaskLogsResponse": { "type": "structure", "members": { - "Marker": { + "ReplicationInstanceArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication instance.

" } }, - "ReplicationTaskIndividualAssessments": { - "target": "com.amazonaws.databasemigrationservice#ReplicationTaskIndividualAssessmentList", + "ReplicationInstanceTaskLogs": { + "target": "com.amazonaws.databasemigrationservice#ReplicationInstanceTaskLogsList", "traits": { - "smithy.api#documentation": "

One or more individual assessments as specified by Filters.

" + "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.

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

", "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTasks": { + "com.amazonaws.databasemigrationservice#DescribeReplicationInstances": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTasksMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationInstancesMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTasksResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationInstancesResponse" }, "errors": [ { @@ -6086,23 +7552,46 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about replication tasks for your account in the current\n region.

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

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": { - "ReplicationTaskDeleted": { - "documentation": "Wait until DMS replication task is deleted.", + "ReplicationInstanceAvailable": { + "documentation": "Wait until DMS replication instance is available.", "acceptors": [ { - "state": "failure", + "state": "success", "matcher": { "output": { - "path": "ReplicationTasks[].Status", - "expected": "ready", - "comparator": "anyStringEquals" + "path": "ReplicationInstances[].ReplicationInstanceStatus", + "expected": "available", + "comparator": "allStringEquals" } } }, @@ -6110,8 +7599,8 @@ "state": "failure", "matcher": { "output": { - "path": "ReplicationTasks[].Status", - "expected": "creating", + "path": "ReplicationInstances[].ReplicationInstanceStatus", + "expected": "deleting", "comparator": "anyStringEquals" } } @@ -6120,8 +7609,8 @@ "state": "failure", "matcher": { "output": { - "path": "ReplicationTasks[].Status", - "expected": "stopped", + "path": "ReplicationInstances[].ReplicationInstanceStatus", + "expected": "incompatible-credentials", "comparator": "anyStringEquals" } } @@ -6130,8 +7619,8 @@ "state": "failure", "matcher": { "output": { - "path": "ReplicationTasks[].Status", - "expected": "running", + "path": "ReplicationInstances[].ReplicationInstanceStatus", + "expected": "incompatible-network", "comparator": "anyStringEquals" } } @@ -6140,294 +7629,32 @@ "state": "failure", "matcher": { "output": { - "path": "ReplicationTasks[].Status", - "expected": "failed", + "path": "ReplicationInstances[].ReplicationInstanceStatus", + "expected": "inaccessible-encryption-credentials", "comparator": "anyStringEquals" } } - }, - { - "state": "success", - "matcher": { - "errorType": "ResourceNotFoundFault" - } } ], - "minDelay": 15 + "minDelay": 60 }, - "ReplicationTaskReady": { - "documentation": "Wait until DMS replication task is ready.", + "ReplicationInstanceDeleted": { + "documentation": "Wait until DMS replication instance is deleted.", "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "ready", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "starting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "running", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "stopping", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "stopped", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "failed", - "comparator": "anyStringEquals" - } - } - }, { "state": "failure", "matcher": { "output": { - "path": "ReplicationTasks[].Status", - "expected": "modifying", + "path": "ReplicationInstances[].ReplicationInstanceStatus", + "expected": "available", "comparator": "anyStringEquals" } } }, { - "state": "failure", + "state": "success", "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "testing", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "deleting", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - }, - "ReplicationTaskRunning": { - "documentation": "Wait until DMS replication task is running.", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "running", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "ready", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "creating", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "stopping", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "stopped", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "modifying", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "testing", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "deleting", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - }, - "ReplicationTaskStopped": { - "documentation": "Wait until DMS replication task is stopped.", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "stopped", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "ready", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "creating", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "starting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "modifying", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "testing", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ReplicationTasks[].Status", - "expected": "deleting", - "comparator": "anyStringEquals" - } + "errorType": "ResourceNotFoundFault" } } ], @@ -6436,13 +7663,13 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTasksMessage": { + "com.amazonaws.databasemigrationservice#DescribeReplicationInstancesMessage": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "

Filters applied to replication tasks.

\n

Valid filter names: replication-task-arn | replication-task-id | migration-type |\n endpoint-arn | replication-instance-arn

" + "smithy.api#documentation": "

Filters applied to replication instances.

\n

Valid filter names: replication-instance-arn | replication-instance-id |\n replication-instance-class | engine-version

" } }, "MaxRecords": { @@ -6456,19 +7683,14 @@ "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.

" } - }, - "WithoutSettings": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": "

An option to set to avoid returning information about settings. Use this to reduce\n overhead when setting information is too large. To use this option, choose\n true; otherwise, choose false (the default).

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

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationTasksResponse": { + "com.amazonaws.databasemigrationservice#DescribeReplicationInstancesResponse": { "type": "structure", "members": { "Marker": { @@ -6477,10 +7699,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.

" } }, - "ReplicationTasks": { - "target": "com.amazonaws.databasemigrationservice#ReplicationTaskList", + "ReplicationInstances": { + "target": "com.amazonaws.databasemigrationservice#ReplicationInstanceList", "traits": { - "smithy.api#documentation": "

A description of the replication tasks.

" + "smithy.api#documentation": "

The replication instances described.

" } } }, @@ -6489,13 +7711,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplications": { + "com.amazonaws.databasemigrationservice#DescribeReplicationSubnetGroups": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationSubnetGroupsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeReplicationsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationSubnetGroupsResponse" }, "errors": [ { @@ -6503,7 +7725,30 @@ } ], "traits": { - "smithy.api#documentation": "

Provides details on replication progress by returning status information for one or more\n provisioned DMS Serverless replications.

", + "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", @@ -6511,45 +7756,46 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationsMessage": { + "com.amazonaws.databasemigrationservice#DescribeReplicationSubnetGroupsMessage": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "

Filters applied to the replications.

" + "smithy.api#documentation": "

Filters applied to replication subnet groups.

\n

Valid 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 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.

" + "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.

\n

Default: 100

\n

Constraints: 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 specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + "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.

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

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeReplicationsResponse": { + "com.amazonaws.databasemigrationservice#DescribeReplicationSubnetGroupsResponse": { "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 specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + "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.

" } }, - "Replications": { - "target": "com.amazonaws.databasemigrationservice#ReplicationList", + "ReplicationSubnetGroups": { + "target": "com.amazonaws.databasemigrationservice#ReplicationSubnetGroups", "traits": { - "smithy.api#documentation": "

The replication descriptions.

" + "smithy.api#documentation": "

A description of the replication subnet groups.

" } } }, @@ -6558,13 +7804,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeSchemas": { + "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatistics": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeSchemasMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatisticsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeSchemasResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatisticsResponse" }, "errors": [ { @@ -6575,7 +7821,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about the schema for the specified endpoint.

\n

", + "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", @@ -6583,46 +7829,59 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeSchemasMessage": { + "com.amazonaws.databasemigrationservice#DescribeReplicationTableStatisticsMessage": { "type": "structure", "members": { - "EndpointArn": { + "ReplicationConfigArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

", + "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\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.

\n

Default: 100

\n

Constraints: 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.

" } }, "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.

" + "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.

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

Filters applied to the replication table statistics.

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

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeSchemasResponse": { + "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\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" + "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.

" } }, - "Schemas": { - "target": "com.amazonaws.databasemigrationservice#SchemaList", + "ReplicationTableStatistics": { + "target": "com.amazonaws.databasemigrationservice#ReplicationTableStatisticsList", "traits": { - "smithy.api#documentation": "

The described schema.

" + "smithy.api#documentation": "

Returns table statistics on the replication, including table name, rows inserted, rows updated, and rows deleted.

" } } }, @@ -6631,24 +7890,21 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DescribeTableStatistics": { + "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResults": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#DescribeTableStatisticsMessage" + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#DescribeTableStatisticsResponse" + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsResponse" }, "errors": [ - { - "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" - }, { "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } ], "traits": { - "smithy.api#documentation": "

Returns table statistics on the database migration task, including table name, rows\n inserted, rows updated, and rows deleted.

\n

Note 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#documentation": "

Returns the task assessment results from the Amazon S3 bucket that DMS creates in your\n Amazon Web Services account. This action always returns the\n latest results.

\n

For more information about DMS task assessments, see \n Creating a task assessment report\n in the Database Migration Service User Guide.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -6656,20 +7912,19 @@ } } }, - "com.amazonaws.databasemigrationservice#DescribeTableStatisticsMessage": { + "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsMessage": { "type": "structure", "members": { "ReplicationTaskArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication task.

", - "smithy.api#required": {} + "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.

" } }, "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.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 500.

" + "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.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" } }, "Marker": { @@ -6677,37 +7932,32 @@ "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.

" } - }, - "Filters": { - "target": "com.amazonaws.databasemigrationservice#FilterList", - "traits": { - "smithy.api#documentation": "

Filters applied to table statistics.

\n

Valid filter names: schema-name | table-name | table-state

\n

A combination of filters creates an AND condition where each record matches all\n specified filters.

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

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DescribeTableStatisticsResponse": { + "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentResultsResponse": { "type": "structure", "members": { - "ReplicationTaskArn": { + "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication task.

" + "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.

" } }, - "TableStatistics": { - "target": "com.amazonaws.databasemigrationservice#TableStatisticsList", + "BucketName": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The table statistics.

" + "smithy.api#documentation": "

- The Amazon S3 bucket where the task assessment report is located.

" } }, - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", + "ReplicationTaskAssessmentResults": { + "target": "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentResultList", "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.

" + "smithy.api#documentation": "

The task assessment report.

" } } }, @@ -6716,146 +7966,988 @@ "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DmsSslModeValue": { - "type": "enum", + "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.

\n

These filter settings can specify a combination of premigration assessment runs,\n migration tasks, replication instances, and assessment run status values.

\n \n

This operation doesn't return information about individual assessments. For this\n information, see the DescribeReplicationTaskIndividualAssessments\n operation.

\n ", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentRunsMessage": { + "type": "structure", "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "none" - } - }, - "REQUIRE": { - "target": "smithy.api#Unit", + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#enumValue": "require" + "smithy.api#documentation": "

Filters applied to the premigration assessment runs described in the form of key-value pairs.

\n

Valid filter names: replication-task-assessment-run-arn, replication-task-arn,\n replication-instance-arn, status\n

" } }, - "VERIFY_CA": { - "target": "smithy.api#Unit", + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#enumValue": "verify-ca" + "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.

" } }, - "VERIFY_FULL": { - "target": "smithy.api#Unit", + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#enumValue": "verify-full" + "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.

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

", + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#DmsTransferSettings": { + "com.amazonaws.databasemigrationservice#DescribeReplicationTaskAssessmentRunsResponse": { "type": "structure", "members": { - "ServiceAccessRoleArn": { + "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.

" + "smithy.api#documentation": "

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.

" } }, - "BucketName": { - "target": "com.amazonaws.databasemigrationservice#String", + "ReplicationTaskAssessmentRuns": { + "target": "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentRunList", "traits": { - "smithy.api#documentation": "

The name of the S3 bucket to use.

" + "smithy.api#documentation": "

One or more premigration assessment runs as specified by Filters.

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

The settings in JSON format for the DMS Transfer type source endpoint.

" + "smithy.api#documentation": "

", + "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DocDbSettings": { + "com.amazonaws.databasemigrationservice#DescribeReplicationTaskIndividualAssessments": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskIndividualAssessmentsMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTaskIndividualAssessmentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a paginated list of individual assessments based on filter settings.

\n

These 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": { - "Username": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

The user name you use to access the DocumentDB source endpoint.

" - } - }, - "Password": { - "target": "com.amazonaws.databasemigrationservice#SecretString", - "traits": { - "smithy.api#documentation": "

The password for the user account you use to access the DocumentDB source endpoint.\n

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

The name of the server on the DocumentDB source endpoint.

" - } - }, - "Port": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port value for the DocumentDB source endpoint.

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

The database name on the DocumentDB source endpoint.

" - } - }, - "NestingLevel": { - "target": "com.amazonaws.databasemigrationservice#NestingLevelValue", - "traits": { - "smithy.api#documentation": "

Specifies either document or table mode.

\n

Default value is \"none\". Specify \"none\" to use document mode.\n Specify \"one\" to use table mode.

" - } - }, - "ExtractDocId": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "

Specifies the document ID. Use this setting when NestingLevel is set to\n \"none\".

\n

Default value is \"false\".

" + "smithy.api#documentation": "

Filters applied to the individual assessments described in the form of key-value\n pairs.

\n

Valid filter names: replication-task-assessment-run-arn,\n replication-task-arn, status\n

" } }, - "DocsToInvestigate": { + "MaxRecords": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

Indicates the number of documents to preview to determine the document organization.\n Use this setting when NestingLevel is set to \"one\".

\n

Must be a positive value greater than 0. Default value is\n 1000.

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

The KMS key identifier that is used to encrypt the content on the replication\n instance. If you don't specify a value for the KmsKeyId parameter, then\n DMS uses your default encryption key. KMS creates the default encryption key for\n your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

" + "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.

" } }, - "SecretsManagerAccessRoleArn": { + "Marker": { "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 secret that allows access to the DocumentDB endpoint.

\n \n

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.

\n " + "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.

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

", + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationTaskIndividualAssessmentsResponse": { + "type": "structure", + "members": { + "Marker": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret\n that contains the DocumentDB endpoint connection details.

" - } - }, - "UseUpdateLookUp": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": "

If true, DMS retrieves the entire document from the DocumentDB source during migration.\n This may cause a migration failure if the server response exceeds bandwidth limits. To fetch only updates\n and deletes during migration, set this parameter to false.

" + "smithy.api#documentation": "

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.

" } }, - "ReplicateShardCollections": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "ReplicationTaskIndividualAssessments": { + "target": "com.amazonaws.databasemigrationservice#ReplicationTaskIndividualAssessmentList", "traits": { - "smithy.api#documentation": "

If true, DMS replicates data to shard collections. DMS only uses this setting if\n the target endpoint is a DocumentDB elastic cluster.

\n

When this setting is true, note the following:

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

One or more individual assessments as specified by Filters.

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

Provides information that defines a DocumentDB endpoint.

" + "smithy.api#documentation": "

", + "smithy.api#output": {} } }, - "com.amazonaws.databasemigrationservice#DoubleOptional": { - "type": "double" - }, - "com.amazonaws.databasemigrationservice#DynamoDbSettings": { - "type": "structure", + "com.amazonaws.databasemigrationservice#DescribeReplicationTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTasksMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationTasksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

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", + "pageSize": "MaxRecords" + }, + "smithy.waiters#waitable": { + "ReplicationTaskDeleted": { + "documentation": "Wait until DMS replication task is deleted.", + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "ready", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "creating", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "stopped", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "running", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundFault" + } + } + ], + "minDelay": 15 + }, + "ReplicationTaskReady": { + "documentation": "Wait until DMS replication task is ready.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "ready", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "starting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "running", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "stopping", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "stopped", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "modifying", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "testing", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "ReplicationTaskRunning": { + "documentation": "Wait until DMS replication task is running.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "running", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "ready", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "creating", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "stopping", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "stopped", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "modifying", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "testing", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + }, + "ReplicationTaskStopped": { + "documentation": "Wait until DMS replication task is stopped.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "stopped", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "ready", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "creating", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "starting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "modifying", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "testing", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ReplicationTasks[].Status", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationTasksMessage": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "

Filters applied to replication tasks.

\n

Valid filter names: replication-task-arn | replication-task-id | migration-type |\n 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.

\n

Default: 100

\n

Constraints: 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.

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

An option to set to avoid returning information about settings. Use this to reduce\n overhead when setting information is too large. To use this option, choose\n true; otherwise, choose false (the default).

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

", + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationTasksResponse": { + "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.

" + } + }, + "ReplicationTasks": { + "target": "com.amazonaws.databasemigrationservice#ReplicationTaskList", + "traits": { + "smithy.api#documentation": "

A description of the replication tasks.

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

", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationsMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeReplicationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Provides details on replication progress by returning status information for one or more\n provisioned DMS Serverless replications.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationsMessage": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "

Filters applied to the replications.

" + } + }, + "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.

" + } + }, + "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.

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

", + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeReplicationsResponse": { + "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 specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "Replications": { + "target": "com.amazonaws.databasemigrationservice#ReplicationList", + "traits": { + "smithy.api#documentation": "

The replication descriptions.

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

", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeSchemas": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeSchemasMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeSchemasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "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", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeSchemasMessage": { + "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": {} + } + }, + "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.

\n

Default: 100

\n

Constraints: 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.

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

", + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeSchemasResponse": { + "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.

" + } + }, + "Schemas": { + "target": "com.amazonaws.databasemigrationservice#SchemaList", + "traits": { + "smithy.api#documentation": "

The described schema.

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

", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeTableStatistics": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeTableStatisticsMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeTableStatisticsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns table statistics on the database migration task, including table name, rows\n inserted, rows updated, and rows deleted.

\n

Note 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", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeTableStatisticsMessage": { + "type": "structure", + "members": { + "ReplicationTaskArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication task.

", + "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.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 500.

" + } + }, + "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.

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

Filters applied to table statistics.

\n

Valid filter names: schema-name | table-name | table-state

\n

A combination of filters creates an AND condition where each record matches all\n specified filters.

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

", + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeTableStatisticsResponse": { + "type": "structure", + "members": { + "ReplicationTaskArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replication task.

" + } + }, + "TableStatistics": { + "target": "com.amazonaws.databasemigrationservice#TableStatisticsList", + "traits": { + "smithy.api#documentation": "

The table statistics.

" + } + }, + "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.

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

", + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#DmsSslModeValue": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "none" + } + }, + "REQUIRE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "require" + } + }, + "VERIFY_CA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "verify-ca" + } + }, + "VERIFY_FULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "verify-full" + } + } + } + }, + "com.amazonaws.databasemigrationservice#DmsTransferSettings": { + "type": "structure", + "members": { + "ServiceAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.

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

The name of the S3 bucket to use.

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

The settings in JSON format for the DMS Transfer type source endpoint.

" + } + }, + "com.amazonaws.databasemigrationservice#DocDbSettings": { + "type": "structure", + "members": { + "Username": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The user name you use to access the DocumentDB source endpoint.

" + } + }, + "Password": { + "target": "com.amazonaws.databasemigrationservice#SecretString", + "traits": { + "smithy.api#documentation": "

The password for the user account you use to access the DocumentDB source endpoint.\n

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

The name of the server on the DocumentDB source endpoint.

" + } + }, + "Port": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port value for the DocumentDB source endpoint.

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

The database name on the DocumentDB source endpoint.

" + } + }, + "NestingLevel": { + "target": "com.amazonaws.databasemigrationservice#NestingLevelValue", + "traits": { + "smithy.api#documentation": "

Specifies either document or table mode.

\n

Default value is \"none\". Specify \"none\" to use document mode.\n Specify \"one\" to use table mode.

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

Specifies the document ID. Use this setting when NestingLevel is set to\n \"none\".

\n

Default value is \"false\".

" + } + }, + "DocsToInvestigate": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Indicates the number of documents to preview to determine the document organization.\n Use this setting when NestingLevel is set to \"one\".

\n

Must be a positive value greater than 0. Default value is\n 1000.

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

The KMS key identifier that is used to encrypt the content on the replication\n instance. If you don't specify a value for the KmsKeyId parameter, then\n DMS uses your default encryption key. KMS creates the default encryption key for\n your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

" + } + }, + "SecretsManagerAccessRoleArn": { + "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 secret that allows access to the DocumentDB endpoint.

\n \n

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.

\n " + } + }, + "SecretsManagerSecretId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret\n that contains the DocumentDB endpoint connection details.

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

If true, DMS retrieves the entire document from the DocumentDB source during migration.\n This may cause a migration failure if the server response exceeds bandwidth limits. To fetch only updates\n and deletes during migration, set this parameter to false.

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

If true, DMS replicates data to shard collections. DMS only uses this setting if\n the target endpoint is a DocumentDB elastic cluster.

\n

When this setting is true, note the following:

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

Provides information that defines a DocumentDB endpoint.

" + } + }, + "com.amazonaws.databasemigrationservice#DoubleOptional": { + "type": "double" + }, + "com.amazonaws.databasemigrationservice#DynamoDbSettings": { + "type": "structure", "members": { "ServiceAccessRoleArn": { "target": "com.amazonaws.databasemigrationservice#String", @@ -7282,6 +9374,85 @@ "target": "com.amazonaws.databasemigrationservice#EndpointSetting" } }, + "com.amazonaws.databasemigrationservice#EngineVersion": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The version number of the replication instance.

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

The lifecycle status of the replication instance version. Valid values are DEPRECATED, \n DEFAULT_VERSION, and ACTIVE.

" + } + }, + "ReleaseStatus": { + "target": "com.amazonaws.databasemigrationservice#ReleaseStatusValues", + "traits": { + "smithy.api#documentation": "

The release status of the replication instance version.

" + } + }, + "LaunchDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "

The date when the replication instance version became publicly available.

" + } + }, + "AutoUpgradeDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "

The date when the replication instance will be automatically upgraded. This setting only applies \n if the auto-minor-version setting is enabled.

" + } + }, + "DeprecationDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "

The date when the replication instance version will be deprecated and can no longer be requested.

" + } + }, + "ForceUpgradeDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "

The date when the replication instance will have a version upgrade forced.

" + } + }, + "AvailableUpgrades": { + "target": "com.amazonaws.databasemigrationservice#AvailableUpgradesList", + "traits": { + "smithy.api#documentation": "

The list of valid replication instance versions that you can upgrade to.

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

Provides information about a replication instance version.

" + } + }, + "com.amazonaws.databasemigrationservice#EngineVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#EngineVersion", + "traits": { + "smithy.api#xmlName": "EngineVersion" + } + } + }, + "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": { @@ -7448,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": { @@ -7744,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": { @@ -7774,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.

\n

If you don't specify a value for the KmsKeyArn parameter, then\n DMS uses your default encryption key.

\n

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account \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.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "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.

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

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": { @@ -7907,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": { @@ -8323,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.

" + "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.

", + "smithy.api#examples": [ + { + "title": "List tags for resource", + "documentation": "Lists all tags for an AWS DMS resource.", + "input": { + "ResourceArn": "" + }, + "output": { + "TagList": [] + } + } + ] } }, "com.amazonaws.databasemigrationservice#ListTagsForResourceMessage": { @@ -8343,7 +10736,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#ListTagsForResourceResponse": { @@ -8464,83 +10858,336 @@ "ServerName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" + } + }, + "Username": { + "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.

" + } + }, + "SecretsManagerAccessRoleArn": { + "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.

\n \n

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.

\n " + } + }, + "SecretsManagerSecretId": { + "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.

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

Use the TrimSpaceInChar source endpoint setting to trim data \n on CHAR and NCHAR data types during migration. The default value is true.

" + } + }, + "TlogAccessMode": { + "target": "com.amazonaws.databasemigrationservice#TlogAccessMode", + "traits": { + "smithy.api#documentation": "

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.

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

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.

\n \n

You must remove the data provider from all migration projects before you can modify it.

\n " + } + }, + "com.amazonaws.databasemigrationservice#ModifyDataProviderMessage": { + "type": "structure", + "members": { + "DataProviderIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The 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.

" + "smithy.api#documentation": "

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.

\n \n

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.

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

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.

" + "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.

" } }, - "TrimSpaceInChar": { + "ExactSettings": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

Use the TrimSpaceInChar source endpoint setting to trim data \n on CHAR and NCHAR data types during migration. The default value is true.

" - } - }, - "TlogAccessMode": { - "target": "com.amazonaws.databasemigrationservice#TlogAccessMode", - "traits": { - "smithy.api#documentation": "

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:

\n " } }, - "ForceLobLookup": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "Settings": { + "target": "com.amazonaws.databasemigrationservice#DataProviderSettings", "traits": { - "smithy.api#documentation": "

Forces 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": { @@ -8569,7 +11216,30 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the specified endpoint.

\n \n

For 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.

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

Modifies the specified endpoint.

\n \n

For 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.

\n ", + "smithy.api#examples": [ + { + "title": "Modify endpoint", + "documentation": "Modifies the specified endpoint.", + "input": { + "EndpointArn": "", + "EndpointIdentifier": "", + "EndpointType": "source", + "EngineName": "", + "Username": "", + "Password": "", + "ServerName": "", + "Port": 123, + "DatabaseName": "", + "ExtraConnectionAttributes": "", + "CertificateArn": "", + "SslMode": "require" + }, + "output": { + "Endpoint": {} + } + } + ] } }, "com.amazonaws.databasemigrationservice#ModifyEndpointMessage": { @@ -8717,178 +11387,389 @@ "smithy.api#documentation": "

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:

\n \n

For example, if you call create-endpoint ... --endpoint-settings '{\"a\":1}'\n ..., the endpoint has the following endpoint settings: '{\"a\":1}'. If\n you then call modify-endpoint ... --endpoint-settings '{\"b\":2}' ... for the\n same endpoint, the endpoint has the following settings: '{\"a\":1,\"b\":2}'.

\n

However, suppose that you follow this with a call to modify-endpoint ...\n --endpoint-settings '{\"b\":2}' --exact-settings ... for that same endpoint again.\n Then the endpoint has the following settings: '{\"b\":2}'. All existing settings\n are replaced with the exact settings that you specify.

" + } + }, + "GcpMySQLSettings": { + "target": "com.amazonaws.databasemigrationservice#GcpMySQLSettings", + "traits": { + "smithy.api#documentation": "

Settings in JSON format for the source GCP MySQL endpoint.

" + } + }, + "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.

\n

Valid 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.

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

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.

\n \n

All migration projects associated with the instance profile must be deleted \n or modified before you can modify the instance profile.

\n " + } + }, + "com.amazonaws.databasemigrationservice#ModifyInstanceProfileMessage": { + "type": "structure", + "members": { + "InstanceProfileIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "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

" + "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.

\n

If you don't specify a value for the KmsKeyArn parameter, then\n DMS uses your default encryption key.

\n

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a\n different default encryption key for each Amazon Web Services Region.

" } }, - "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.

" } }, - "DocDbSettings": { - "target": "com.amazonaws.databasemigrationservice#DocDbSettings", + "NetworkType": { + "target": "com.amazonaws.databasemigrationservice#String", "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

" + "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.

" } }, - "RedisSettings": { - "target": "com.amazonaws.databasemigrationservice#RedisSettings", + "InstanceProfileName": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

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:

\n \n

For example, if you call create-endpoint ... --endpoint-settings '{\"a\":1}'\n ..., the endpoint has the following endpoint settings: '{\"a\":1}'. If\n you then call modify-endpoint ... --endpoint-settings '{\"b\":2}' ... for the\n same endpoint, the endpoint has the following settings: '{\"a\":1,\"b\":2}'.

\n

However, suppose that you follow this with a call to modify-endpoint ...\n --endpoint-settings '{\"b\":2}' --exact-settings ... for that same endpoint again.\n Then the endpoint has the following settings: '{\"b\":2}'. All existing settings\n are replaced with the exact settings that you specify.

" + "smithy.api#documentation": "

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.

\n \n

The migration project must be closed before you can modify it.

\n " } }, - "com.amazonaws.databasemigrationservice#ModifyEventSubscriptionMessage": { + "com.amazonaws.databasemigrationservice#ModifyMigrationProjectMessage": { "type": "structure", "members": { - "SubscriptionName": { + "MigrationProjectIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The 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.

\n

Valid 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.

" + "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.

" } }, - "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": {} } }, @@ -8984,7 +11865,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#ModifyReplicationConfigResponse": { @@ -9033,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.

\n

Some 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.

\n

Some 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": { @@ -9116,7 +12068,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#ModifyReplicationInstanceResponse": { @@ -9163,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": { @@ -9191,7 +12158,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#ModifyReplicationSubnetGroupResponse": { @@ -9295,7 +12263,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#ModifyReplicationTaskResponse": { @@ -9465,7 +12434,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#MoveReplicationTaskResponse": { @@ -9575,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.

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

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": { @@ -9644,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.

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

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.

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

The identifier of the secret in Secrets Manager that contains the Oracle ASM connection details.

\n

Required 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": { @@ -9971,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.

\n \n

DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.

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

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.

" - } - }, - "com.amazonaws.databasemigrationservice#OrderableReplicationInstanceList": { - "type": "list", - "member": { - "target": "com.amazonaws.databasemigrationservice#OrderableReplicationInstance", - "traits": { - "smithy.api#xmlName": "OrderableReplicationInstance" - } + }, + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "com.amazonaws.databasemigrationservice#OrderableReplicationInstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#OrderableReplicationInstance", + "traits": { + "smithy.api#xmlName": "OrderableReplicationInstance" + } + } + }, + "com.amazonaws.databasemigrationservice#OriginTypeValue": { + "type": "enum", + "members": { + "SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE" + } + }, + "TARGET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TARGET" + } + } } }, "com.amazonaws.databasemigrationservice#ParquetVersionValue": { @@ -10225,7 +13312,7 @@ "DatabaseMode": { "target": "com.amazonaws.databasemigrationservice#DatabaseMode", "traits": { - "smithy.api#documentation": "

Specifies whether to use default or custom replication behavior for \n PostgreSQL-compatible endpoints. You can use this setting to specify replication \n behavior for endpoints that require additional configuration, such as Babelfish endpoints.

" + "smithy.api#documentation": "

Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints.

" } }, "BabelfishDatabaseName": { @@ -10239,6 +13326,44 @@ "smithy.api#documentation": "

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.

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

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": { @@ -10459,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.)

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#RebootReplicationInstanceResponse": { @@ -10860,7 +13988,20 @@ } ], "traits": { - "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#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": { @@ -10882,7 +14023,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#RefreshSchemasResponse": { @@ -11040,7 +14182,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#ReloadReplicationTablesResponse": { @@ -11101,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.

\n

Valid values: data-reload, validate-only

\n

Default value is data-reload.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#ReloadTablesResponse": { @@ -11131,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.

" + "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.

", + "smithy.api#examples": [ + { + "title": "Remove tags from resource", + "documentation": "Removes metadata tags from an AWS DMS resource.", + "input": { + "ResourceArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E", + "TagKeys": [] + }, + "output": {} + } + ] } }, "com.amazonaws.databasemigrationservice#RemoveTagsFromResourceMessage": { @@ -11153,7 +14310,8 @@ } }, "traits": { - "smithy.api#documentation": "

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": { @@ -11723,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.

" + } + }, + "com.amazonaws.databasemigrationservice#ReplicationSubnetGroupDoesNotCoverEnoughAZs": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.databasemigrationservice#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "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" + } + }, + "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.

\n

Constraints:

\n " + } + }, + "SourceEndpointArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The 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 " + } + }, + "LastFailureMessage": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

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 " + } + }, + "ReplicationTaskCreationDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "

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.

\n

The value can be in date, checkpoint, or LSN/SCN format.

\n

Date Example: --cdc-start-position “2018-03-08T12:12:12”

\n

Checkpoint 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\"

\n

LSN 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.

\n

Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”

\n

Commit 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.

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

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.

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

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.

" } }, - "com.amazonaws.databasemigrationservice#ReplicationSubnetGroup": { + "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentResult": { "type": "structure", "members": { - "ReplicationSubnetGroupIdentifier": { + "ReplicationTaskIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

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.

\n

The 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.

" - } - }, - "com.amazonaws.databasemigrationservice#ReplicationSubnetGroupDoesNotCoverEnoughAZs": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.databasemigrationservice#ExceptionMessage", + }, + "S3ObjectUrl": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The URL of the S3 object containing the task assessment results.

\n

The 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.

\n

Constraints:

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

Amazon 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.

\n

This status can have one of the following values:

\n " } }, - "ReplicationInstanceArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "ReplicationTaskAssessmentRunCreationDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", "traits": { - "smithy.api#documentation": "

The ARN of the replication instance.

" + "smithy.api#documentation": "

Date on which the assessment run was created using the\n StartReplicationTaskAssessmentRun operation.

" } }, - "MigrationType": { - "target": "com.amazonaws.databasemigrationservice#MigrationTypeValue", + "AssessmentProgress": { + "target": "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentRunProgress", "traits": { - "smithy.api#documentation": "

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.

" } }, - "Status": { + "ResultLocationBucket": { "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 " + "smithy.api#documentation": "

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 " + "smithy.api#documentation": "

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.

\n

Some of the information appears based on other operations that can return the\n ReplicationTaskAssessmentRun object.

" + } + }, + "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentRunList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentRun" + } + }, + "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentRunProgress": { + "type": "structure", + "members": { + "IndividualAssessmentCount": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

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.

" + } + }, + "com.amazonaws.databasemigrationservice#ReplicationTaskIndividualAssessment": { + "type": "structure", + "members": { + "ReplicationTaskIndividualAssessmentArn": { "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.

\n

The value can be in date, checkpoint, or LSN/SCN format.

\n

Date Example: --cdc-start-position “2018-03-08T12:12:12”

\n

Checkpoint 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\"

\n

LSN 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.

\n

Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”

\n

Commit 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.

" + "smithy.api#documentation": "

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.

\n

This status can have one of the following values:

\n " + } + }, + "ReplicationTaskIndividualAssessmentStartDate": { + "target": "com.amazonaws.databasemigrationservice#TStamp", + "traits": { + "smithy.api#documentation": "

Date when this individual assessment was started as part of running the\n StartReplicationTaskAssessmentRun operation.

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

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.

" + "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

In response to a request by the DescribeReplicationTasks operation, this object provides\n a collection of statistics about a replication task.

" } }, - "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentResult": { + "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault": { "type": "structure", "members": { - "ReplicationTaskIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", + "message": { + "target": "com.amazonaws.databasemigrationservice#ExceptionMessage", "traits": { - "smithy.api#documentation": "

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.

\n

The 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.

\n

The 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.

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

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.

" } }, - "ReplicationTaskArn": { + "ExternalTableDefinition": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

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.

\n

This status can have one of the following values:

\n " + "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).

" } }, - "ReplicationTaskAssessmentRunCreationDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "CsvDelimiter": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Date on which the assessment run was created using the\n StartReplicationTaskAssessmentRun operation.

" + "smithy.api#documentation": "

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/.

" } }, - "LastFailureMessage": { + "BucketName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

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.

" + "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.

" } }, - "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.

\n \n

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.

\n \n

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 " } }, - "ResultLocationFolder": { + "ServerSideEncryptionKmsKeyId": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

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.

\n

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

" } }, - "ResultEncryptionMode": { - "target": "com.amazonaws.databasemigrationservice#String", + "DataFormat": { + "target": "com.amazonaws.databasemigrationservice#DataFormatValue", "traits": { - "smithy.api#documentation": "

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 " } }, - "ResultKmsKeyArn": { - "target": "com.amazonaws.databasemigrationservice#String", + "EncodingType": { + "target": "com.amazonaws.databasemigrationservice#EncodingTypeValue", "traits": { - "smithy.api#documentation": "

ARN of the KMS encryption key used to encrypt the assessment run results.

" + "smithy.api#documentation": "

The type of encoding you are using:

\n " } }, - "AssessmentRunName": { - "target": "com.amazonaws.databasemigrationservice#String", + "DictPageSizeLimit": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

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.

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

Provides information that describes a premigration assessment run that you have started\n using the StartReplicationTaskAssessmentRun operation.

\n

Some of the information appears based on other operations that can return the\n ReplicationTaskAssessmentRun object.

" - } - }, - "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentRunList": { - "type": "list", - "member": { - "target": "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentRun" - } - }, - "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentRunProgress": { - "type": "structure", - "members": { - "IndividualAssessmentCount": { - "target": "com.amazonaws.databasemigrationservice#Integer", + }, + "RowGroupLength": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "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.

\n

If you choose a value larger than the maximum, RowGroupLength is set to the\n max row group length in bytes (64 * 1024 * 1024).

" + } + }, + "DataPageSize": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "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.

" + } + }, + "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.

" + } + }, + "EnableStatistics": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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.

" } }, - "IndividualAssessmentCompletedCount": { - "target": "com.amazonaws.databasemigrationservice#Integer", + "IncludeOpForFullLoad": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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.

\n \n

DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 and\n later.

\n

DMS supports the use of the .parquet files with the IncludeOpForFullLoad \n parameter in versions 3.4.7 and later.

\n \n

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.

\n \n

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..

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

The progress values reported by the AssessmentProgress response\n element.

" - } - }, - "com.amazonaws.databasemigrationservice#ReplicationTaskIndividualAssessment": { - "type": "structure", - "members": { - "ReplicationTaskIndividualAssessmentArn": { - "target": "com.amazonaws.databasemigrationservice#String", + }, + "CdcInsertsOnly": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

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.

\n

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..

\n \n

DMS supports the interaction described preceding between the\n CdcInsertsOnly and IncludeOpForFullLoad parameters in\n versions 3.1.4 and later.

\n

\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.

\n " } }, - "ReplicationTaskAssessmentRunArn": { + "TimestampColumnName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

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.

\n \n

DMS supports the TimestampColumnName parameter in versions 3.1.4 and later.

\n \n

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.

\n

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.

\n

For 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.

\n

The 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.

\n

When the AddColumnName parameter is set to true, DMS also\n includes a name for the timestamp column that you set with\n TimestampColumnName.

" } }, - "IndividualAssessmentName": { - "target": "com.amazonaws.databasemigrationservice#String", + "ParquetTimestampInMillisecond": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

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.

\n \n

DMS supports the ParquetTimestampInMillisecond parameter in versions\n 3.1.4 and later.

\n \n

When ParquetTimestampInMillisecond is set to true or\n y, DMS writes all TIMESTAMP columns in a .parquet\n formatted file with millisecond precision. Otherwise, DMS writes them with microsecond\n precision.

\n

Currently, Amazon Athena and Glue can handle only\n millisecond precision for TIMESTAMP values. Set\n this parameter to true for S3 endpoint object\n files that are .parquet formatted only if you plan to query or process the data with Athena or Glue.

\n \n

DMS writes any TIMESTAMP column\n values written to an S3 file in .csv format with\n microsecond precision.

\n

Setting ParquetTimestampInMillisecond has no effect on the string\n format of the timestamp column value that is inserted by setting the\n TimestampColumnName parameter.

\n " } }, - "Status": { - "target": "com.amazonaws.databasemigrationservice#String", + "CdcInsertsAndUpdates": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

Individual assessment status.

\n

This status can have one of the following values:

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

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.

\n \n

DMS supports the use of the .parquet files in versions 3.4.7 and later.

\n \n

How 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..

\n \n

DMS supports the use of the CdcInsertsAndUpdates parameter in\n versions 3.3.1 and later.

\n

\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.

\n " } }, - "ReplicationTaskIndividualAssessmentStartDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "DatePartitionEnabled": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

Date when this individual assessment was started as part of running the\n StartReplicationTaskAssessmentRun operation.

" + "smithy.api#documentation": "

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.

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

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.

" } }, - "ElapsedTimeMillis": { - "target": "com.amazonaws.databasemigrationservice#Long", + "DatePartitionDelimiter": { + "target": "com.amazonaws.databasemigrationservice#DatePartitionDelimiterValue", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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.

" } }, - "TablesLoaded": { - "target": "com.amazonaws.databasemigrationservice#Integer", + "UseCsvNoSupValue": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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.

\n \n

This setting is supported in DMS versions 3.4.1 and later.

\n " } }, - "TablesLoading": { - "target": "com.amazonaws.databasemigrationservice#Integer", + "CsvNoSupValue": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The 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.

\n \n

This setting is supported in DMS versions 3.4.1 and later.

\n " } }, - "TablesQueued": { - "target": "com.amazonaws.databasemigrationservice#Integer", + "PreserveTransactions": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The 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.

\n \n

This setting is supported in DMS versions 3.4.2 and later.

\n " } }, - "TablesErrored": { - "target": "com.amazonaws.databasemigrationservice#Integer", + "CdcPath": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The 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 .

\n

For example, if you specify CdcPath as MyChangedData, and you\n specify BucketName as MyTargetBucket but do not specify\n BucketFolder, DMS creates the CDC folder path following:\n MyTargetBucket/MyChangedData.

\n

If you specify the same CdcPath, and you specify BucketName as\n MyTargetBucket and BucketFolder as MyTargetData,\n DMS creates the CDC folder path following:\n MyTargetBucket/MyTargetData/MyChangedData.

\n

For more information on CDC including transaction order on an S3 target, see Capturing data changes (CDC) including transaction order on the S3\n target.

\n \n

This setting is supported in DMS versions 3.4.2 and later.

\n " } }, - "FreshStartDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "UseTaskStartTimeForFullLoadTimestamp": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

The 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.

\n

When useTaskStartTimeForFullLoadTimestamp is set to false, the full load timestamp \n in the timestamp column increments with the time data arrives at the target.

" } }, - "StartDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "CannedAclForObjects": { + "target": "com.amazonaws.databasemigrationservice#CannedAclForObjectsValue", "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.

" + "smithy.api#documentation": "

A value that enables DMS to specify a predefined (canned) access control list for\n objects created in an Amazon S3 bucket as .csv or .parquet files. For more information\n about Amazon S3 canned ACLs, see Canned\n ACL in the Amazon S3 Developer Guide.\n

\n

The default value is NONE. Valid values include NONE, PRIVATE,\n PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ,\n AWS_EXEC_READ, BUCKET_OWNER_READ, and\n BUCKET_OWNER_FULL_CONTROL.

" } }, - "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.

\n

The default value is false. Valid values are true, false,\n y, and n.

" } }, - "FullLoadStartDate": { - "target": "com.amazonaws.databasemigrationservice#TStamp", + "CdcMaxBatchInterval": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

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.

\n

When CdcMaxBatchInterval and CdcMinFileSize are both specified, the\n file write is triggered by whichever parameter condition is met first within an DMS\n CloudFormation template.

\n

The default value is 60 seconds.

" } }, - "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.

\n

When CdcMinFileSize and CdcMaxBatchInterval are both specified, the file \n write is triggered by whichever parameter condition is met first within an DMS \n CloudFormation template.

\n

The default value is 32 MB.

" } - } - }, - "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.

" - } - }, - "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.databasemigrationservice#ExceptionMessage", + }, + "CsvNullValue": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

An optional parameter that specifies how DMS treats null\n values. While handling the null value, you can use this\n parameter to pass a user-defined string as null when writing to\n the target. For example, when target columns are not nullable,\n you can use this option to differentiate between the empty\n string value and the null value. So, if you set this parameter\n value to the empty string (\"\" or ''), DMS treats the empty\n string as the null value instead of NULL.

\n

The default value is NULL. Valid values include any valid string.

" } }, - "resourceArn": { - "target": "com.amazonaws.databasemigrationservice#ResourceArn", + "IgnoreHeaderRows": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

When this value is set to 1, DMS ignores the first row header in a .csv file. A value\n of 1 turns on the feature; a value of 0 turns off the feature.

\n

The default is 0.

" } - } - }, - "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.

\n

The 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.

\n

For an S3 target, an optional parameter used to set behavior to comply with RFC\n 4180 for data migrated to Amazon S3 using .csv file format only. When this\n value is set to true or y using Amazon\n S3 as a target, if the data has quotation marks or newline\n characters in it, DMS encloses the entire column with an\n additional pair of double quotation marks (\"). Every quotation\n mark within the data is repeated twice.

\n

The default value is true. Valid values include true, false,\n y, and n.

" } }, - "PendingMaintenanceActionDetails": { - "target": "com.amazonaws.databasemigrationservice#PendingMaintenanceActionDetails", + "DatePartitionTimezone": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

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

\n s3-settings='{\"DatePartitionEnabled\": true, \"DatePartitionSequence\": \"YYYYMMDDHH\",\n \"DatePartitionDelimiter\": \"SLASH\",\n \"DatePartitionTimezone\":\"Asia/Seoul\", \"BucketName\":\n \"dms-nattarat-test\"}'\n

" } - } - }, - "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", + }, + "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.

" } - } - }, - "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" }, - { - "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.

\n

Example: --s3-settings='{\"ExpectedBucketOwner\": \"AWS_Account_ID\"}'\n

\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.

" + "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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).

" + "smithy.api#documentation": "

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/.

" + "smithy.api#documentation": "

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.

\n \n

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.

\n \n

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 " + "smithy.api#documentation": "

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.

\n

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

" + "smithy.api#documentation": "

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 " + "smithy.api#documentation": "

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 " + "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.

" } - }, - "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.

" + "smithy.api#documentation": "

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.

\n

If you choose a value larger than the maximum, RowGroupLength is set to the\n max row group length in bytes (64 * 1024 * 1024).

" + "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

\n \n

DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 and\n later.

\n

DMS supports the use of the .parquet files with the IncludeOpForFullLoad \n parameter in versions 3.4.7 and later.

\n \n

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.

\n \n

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..

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

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.

\n

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..

\n \n

DMS supports the interaction described preceding between the\n CdcInsertsOnly and IncludeOpForFullLoad parameters in\n versions 3.1.4 and later.

\n

\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.

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

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.

\n \n

DMS supports the TimestampColumnName parameter in versions 3.1.4 and later.

\n \n

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.

\n

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.

\n

For 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.

\n

The 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.

\n

When the AddColumnName parameter is set to true, DMS also\n includes a name for the timestamp column that you set with\n TimestampColumnName.

" + "smithy.api#documentation": "

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.

\n \n

DMS supports the ParquetTimestampInMillisecond parameter in versions\n 3.1.4 and later.

\n \n

When ParquetTimestampInMillisecond is set to true or\n y, DMS writes all TIMESTAMP columns in a .parquet\n formatted file with millisecond precision. Otherwise, DMS writes them with microsecond\n precision.

\n

Currently, Amazon Athena and Glue can handle only\n millisecond precision for TIMESTAMP values. Set\n this parameter to true for S3 endpoint object\n files that are .parquet formatted only if you plan to query or process the data with Athena or Glue.

\n \n

DMS writes any TIMESTAMP column\n values written to an S3 file in .csv format with\n microsecond precision.

\n

Setting ParquetTimestampInMillisecond has no effect on the string\n format of the timestamp column value that is inserted by setting the\n TimestampColumnName parameter.

\n " - } + { + "target": "com.amazonaws.databasemigrationservice#KMSKeyNotAccessibleFault" }, - "CdcInsertsAndUpdates": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": "

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.

\n \n

DMS supports the use of the .parquet files in versions 3.4.7 and later.

\n \n

How 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..

\n \n

DMS supports the use of the CdcInsertsAndUpdates parameter in\n versions 3.3.1 and later.

\n

\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.

\n " - } + { + "target": "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault" }, - "DatePartitionEnabled": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": "

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.

" - } + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" }, - "DatePartitionSequence": { - "target": "com.amazonaws.databasemigrationservice#DatePartitionSequenceValue", - "traits": { - "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.

" - } + { + "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" }, - "DatePartitionDelimiter": { - "target": "com.amazonaws.databasemigrationservice#DatePartitionDelimiterValue", - "traits": { - "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.

" - } + { + "target": "com.amazonaws.databasemigrationservice#S3AccessDeniedFault" }, - "UseCsvNoSupValue": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + { + "target": "com.amazonaws.databasemigrationservice#S3ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

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.

\n \n

This setting is supported in DMS versions 3.4.1 and later.

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

The 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.

\n \n

This setting is supported in DMS versions 3.4.1 and later.

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

The 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.

\n \n

This setting is supported in DMS versions 3.4.2 and later.

\n " - } + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, - "CdcPath": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "smithy.api#documentation": "

Specifies the folder path of CDC files. For an S3 source, this setting is required if a\n task captures change data; otherwise, it's optional. If CdcPath is set, DMS\n reads CDC files from this path and replicates the data changes to the target endpoint.\n For an S3 target if you set \n PreserveTransactions\n to true, DMS\n verifies that you have set this parameter to a folder path on your S3 target where DMS\n can save the transaction order for the CDC load. DMS creates this CDC folder path\n in either your S3 target working directory or the S3 target location specified by \n BucketFolder\n and \n BucketName\n .

\n

For example, if you specify CdcPath as MyChangedData, and you\n specify BucketName as MyTargetBucket but do not specify\n BucketFolder, DMS creates the CDC folder path following:\n MyTargetBucket/MyChangedData.

\n

If you specify the same CdcPath, and you specify BucketName as\n MyTargetBucket and BucketFolder as MyTargetData,\n DMS creates the CDC folder path following:\n MyTargetBucket/MyTargetData/MyChangedData.

\n

For more information on CDC including transaction order on an S3 target, see Capturing data changes (CDC) including transaction order on the S3\n target.

\n \n

This setting is supported in DMS versions 3.4.2 and later.

\n " - } + { + "target": "com.amazonaws.databasemigrationservice#KMSKeyNotAccessibleFault" }, - "UseTaskStartTimeForFullLoadTimestamp": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": "

When set to true, this parameter uses the task start time as the timestamp column value instead of \n the time data is written to target. For full load, when useTaskStartTimeForFullLoadTimestamp\n is set to true, each row of the timestamp column contains the task start time. For CDC loads, \n each row of the timestamp column contains the transaction commit time.

\n

When useTaskStartTimeForFullLoadTimestamp is set to false, the full load timestamp \n in the timestamp column increments with the time data arrives at the target.

" - } + { + "target": "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault" }, - "CannedAclForObjects": { - "target": "com.amazonaws.databasemigrationservice#CannedAclForObjectsValue", - "traits": { - "smithy.api#documentation": "

A value that enables DMS to specify a predefined (canned) access control list for\n objects created in an Amazon S3 bucket as .csv or .parquet files. For more information\n about Amazon S3 canned ACLs, see Canned\n ACL in the Amazon S3 Developer Guide.\n

\n

The default value is NONE. Valid values include NONE, PRIVATE,\n PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ,\n AWS_EXEC_READ, BUCKET_OWNER_READ, and\n BUCKET_OWNER_FULL_CONTROL.

" - } + { + "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.

\n

The default value is false. Valid values are true, false,\n y, and n.

" - } + { + "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" }, - "CdcMaxBatchInterval": { - "target": "com.amazonaws.databasemigrationservice#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.

\n

When CdcMaxBatchInterval and CdcMinFileSize are both specified, the\n file write is triggered by whichever parameter condition is met first within an DMS\n CloudFormation template.

\n

The default value is 60 seconds.

" - } + { + "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.

\n

When CdcMinFileSize and CdcMaxBatchInterval are both specified, the file \n write is triggered by whichever parameter condition is met first within an DMS \n CloudFormation template.

\n

The default value is 32 MB.

" + "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.

\n

The default value is NULL. Valid values include any valid string.

" + "smithy.api#documentation": "

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.

\n

The 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.

\n

The 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.

\n

For an S3 target, an optional parameter used to set behavior to comply with RFC\n 4180 for data migrated to Amazon S3 using .csv file format only. When this\n value is set to true or y using Amazon\n S3 as a target, if the data has quotation marks or newline\n characters in it, DMS encloses the entire column with an\n additional pair of double quotation marks (\"). Every quotation\n mark within the data is repeated twice.

\n

The default value is true. Valid values include true, false,\n y, and n.

" - } + { + "target": "com.amazonaws.databasemigrationservice#KMSKeyNotAccessibleFault" }, - "DatePartitionTimezone": { - "target": "com.amazonaws.databasemigrationservice#String", - "traits": { - "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

\n s3-settings='{\"DatePartitionEnabled\": true, \"DatePartitionSequence\": \"YYYYMMDDHH\",\n \"DatePartitionDelimiter\": \"SLASH\",\n \"DatePartitionTimezone\":\"Asia/Seoul\", \"BucketName\":\n \"dms-nattarat-test\"}'\n

" - } + { + "target": "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault" }, - "AddTrailingPaddingCharacter": { - "target": "com.amazonaws.databasemigrationservice#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Use the S3 target endpoint setting AddTrailingPaddingCharacter to add \n padding on string data. The default value is false.

" - } + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" }, - "ExpectedBucketOwner": { + { + "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#S3AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#S3ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

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.

\n

Example: --s3-settings='{\"ExpectedBucketOwner\": \"AWS_Account_ID\"}'\n

\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.

\n

This 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.

" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#SslSecurityProtocolValue": { - "type": "enum", + "com.amazonaws.databasemigrationservice#StartMetadataModelImportResponse": { + "type": "structure", "members": { - "PLAINTEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "plaintext" - } - }, - "SSL_ENCRYPTION": { - "target": "smithy.api#Unit", + "RequestIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#enumValue": "ssl-encryption" + "smithy.api#documentation": "

The identifier for the import operation.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.databasemigrationservice#StartRecommendations": { @@ -12977,7 +16663,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#StartReplicationResponse": { @@ -13015,7 +16702,32 @@ } ], "traits": { - "smithy.api#documentation": "

Starts the replication task.

\n

For 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.

\n

For 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": { @@ -13050,7 +16762,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#StartReplicationTaskAssessmentResponse": { @@ -13181,7 +16894,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#StartReplicationTaskAssessmentRunResponse": { @@ -13236,7 +16950,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#StartReplicationTaskResponse": { @@ -13312,7 +17027,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#StopReplicationResponse": { @@ -13346,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": { @@ -13361,7 +17100,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#StopReplicationTaskResponse": { @@ -13831,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": { @@ -13853,7 +17606,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#TestConnectionResponse": { @@ -13972,7 +17726,8 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

", + "smithy.api#input": {} } }, "com.amazonaws.databasemigrationservice#UpdateSubscriptionsToEventBridgeResponse": { diff --git a/codegen/sdk/aws-models/datasync.json b/codegen/sdk/aws-models/datasync.json index f55a5c90c9ce..d054e08b2522 100644 --- a/codegen/sdk/aws-models/datasync.json +++ b/codegen/sdk/aws-models/datasync.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.

\n

For more information, see Configuring transfers to or from an NFS file\n server.

\n \n

If 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.

\n " } }, "com.amazonaws.datasync#CreateLocationNfsRequest": { @@ -1120,28 +1126,28 @@ "Subdirectory": { "target": "com.amazonaws.datasync#NfsSubdirectory", "traits": { - "smithy.api#documentation": "

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.

\n

To see all the paths exported by your NFS server, run \"showmount -e\n nfs-server-name\" from an NFS client that has access to your server. You can specify\n any directory that appears in the results, and any subdirectory of that directory. Ensure that\n the NFS export is accessible without Kerberos authentication.

\n

To transfer all the data in the folder you specified, DataSync needs to have\n permissions to read all the data. To ensure this, either configure the NFS export with\n no_root_squash, or ensure that the permissions for all of the files that you\n want DataSync allow read access for all users. Doing either enables the agent to\n read the files. For the agent to access directories, you must additionally enable all execute\n access.

\n

If you are copying data to or from your Snowcone device, see NFS Server on\n Snowcone for more information.

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

Specifies the export path in your NFS file server that you want DataSync to\n mount.

\n

This 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.

\n

If you are copying data to or from your Snowcone device, see NFS Server on\n Snowcone for more information.

\n \n

You must specify be an IP version 4 address or Domain Name System (DNS)-compliant\n name.

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

Specifies 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.

\n

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 Amazon Resource Name (ARN) of the DataSync agent that want to\n connect to your NFS file server.

\n

You 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.

\n

For 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.

\n

To see all the paths exported by your NFS server, run \"showmount -e\n nfs-server-name\" from an NFS client that has access to your server. You can specify\n any directory that appears in the results, and any subdirectory of that directory. Ensure that\n the NFS export is accessible without Kerberos authentication.

\n

To transfer all the data in the folder that you specified, DataSync must have\n permissions to read all the data. To ensure this, either configure the NFS export with\n no_root_squash, or ensure that the files you want DataSync to 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.

\n

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.

\n

This 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/aws-models/detective.json b/codegen/sdk/aws-models/detective.json index 1867234c9c50..9ec12357bb01 100644 --- a/codegen/sdk/aws-models/detective.json +++ b/codegen/sdk/aws-models/detective.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/aws-models/drs.json b/codegen/sdk/aws-models/drs.json index bab16cabee29..2c7b97c6f5c7 100644 --- a/codegen/sdk/aws-models/drs.json +++ b/codegen/sdk/aws-models/drs.json @@ -7943,6 +7943,10 @@ { "name": "BASIC", "value": "BASIC" + }, + { + "name": "IN_AWS", + "value": "IN_AWS" } ] } diff --git a/codegen/sdk/aws-models/ebs.json b/codegen/sdk/aws-models/ebs.json index 2f795bfee31e..a310cbbd5e80 100644 --- a/codegen/sdk/aws-models/ebs.json +++ b/codegen/sdk/aws-models/ebs.json @@ -50,18 +50,20 @@ } }, "com.amazonaws.ebs#AccessDeniedExceptionReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNAUTHORIZED_ACCOUNT", - "name": "UNAUTHORIZED_ACCOUNT" - }, - { - "value": "DEPENDENCY_ACCESS_DENIED", - "name": "DEPENDENCY_ACCESS_DENIED" + "type": "enum", + "members": { + "UNAUTHORIZED_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAUTHORIZED_ACCOUNT" } - ] + }, + "DEPENDENCY_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPENDENCY_ACCESS_DENIED" + } + } } }, "com.amazonaws.ebs#Block": { @@ -176,14 +178,16 @@ } }, "com.amazonaws.ebs#ChecksumAggregationMethod": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LINEAR", - "name": "CHECKSUM_AGGREGATION_LINEAR" + "type": "enum", + "members": { + "CHECKSUM_AGGREGATION_LINEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINEAR" } - ], + } + }, + "traits": { "smithy.api#length": { "min": 0, "max": 32 @@ -192,14 +196,16 @@ } }, "com.amazonaws.ebs#ChecksumAlgorithm": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SHA256", - "name": "CHECKSUM_ALGORITHM_SHA256" + "type": "enum", + "members": { + "CHECKSUM_ALGORITHM_SHA256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHA256" } - ], + } + }, + "traits": { "smithy.api#length": { "min": 0, "max": 32 @@ -236,7 +242,7 @@ } ], "traits": { - "smithy.api#documentation": "

Seals and completes the snapshot after all of the required blocks of data have been\n written to it. Completing the snapshot changes the status to completed. You\n cannot write new blocks to a snapshot after it has been completed.

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

Seals and completes the snapshot after all of the required blocks of data have been\n written to it. Completing the snapshot changes the status to completed. You\n cannot write new blocks to a snapshot after it has been completed.

\n \n

You should always retry requests that receive server (5xx) \n error responses, and ThrottlingException and RequestThrottledException \n client error responses. For more information see Error retries in the \n Amazon Elastic Compute Cloud User Guide.

\n ", "smithy.api#http": { "method": "POST", "uri": "/snapshots/completion/{SnapshotId}", @@ -266,7 +272,7 @@ "Checksum": { "target": "com.amazonaws.ebs#Checksum", "traits": { - "smithy.api#documentation": "

An aggregated Base-64 SHA256 checksum based on the checksums of each written\n block.

\n

To generate the aggregated checksum using the linear aggregation method, arrange the\n checksums for each written block in ascending order of their block index, concatenate\n them to form a single string, and then generate the checksum on the entire string using\n the SHA256 algorithm.

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

An aggregated Base-64 SHA256 checksum based on the checksums of each written\n block.

\n

To generate the aggregated checksum using the linear aggregation method, arrange the\n checksums for each written block in ascending order of their block index, concatenate\n them to form a single string, and then generate the checksum on the entire string using\n the SHA256 algorithm.

", "smithy.api#httpHeader": "x-amz-Checksum" } }, @@ -284,6 +290,9 @@ "smithy.api#httpHeader": "x-amz-Checksum-Aggregation-Method" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.ebs#CompleteSnapshotResponse": { @@ -295,6 +304,9 @@ "smithy.api#documentation": "

The status of the snapshot.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ebs#ConcurrentLimitExceededException": { @@ -371,7 +383,7 @@ "name": "ebs" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon EBS snapshots, write data directly to \n \t\tyour snapshots, read data on your snapshots, and identify the differences or changes between \n \t\ttwo snapshots. If you’re an independent software vendor (ISV) who offers backup services for \n \t\tAmazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on \n \t\tyour Amazon EBS volumes through snapshots. This can be done without having to create new volumes \n \t\tfrom snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.

\n \t\t\n \t

You can create incremental snapshots directly from data on-premises into volumes and the \n \t\tcloud to use for quick disaster recovery. With the ability to write and read snapshots, you can \n \t\twrite your on-premises data to an snapshot during a disaster. Then after recovery, you can \n \t\trestore it back to Amazon Web Services or on-premises from the snapshot. You no longer need to build and \n \t\tmaintain complex mechanisms to copy data to and from Amazon EBS.

\n\n\n

This API reference provides detailed information about the actions, data types,\n parameters, and errors of the EBS direct APIs. For more information about the elements that\n make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User\n Guide. For more information about the supported Amazon Web Services Regions, endpoints,\n and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in\n the Amazon Web Services General Reference.

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

You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon EBS snapshots, write data directly to \n \t\tyour snapshots, read data on your snapshots, and identify the differences or changes between \n \t\ttwo snapshots. If you’re an independent software vendor (ISV) who offers backup services for \n \t\tAmazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on \n \t\tyour Amazon EBS volumes through snapshots. This can be done without having to create new volumes \n \t\tfrom snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.

\n

You can create incremental snapshots directly from data on-premises into volumes and the \n \t\tcloud to use for quick disaster recovery. With the ability to write and read snapshots, you can \n \t\twrite your on-premises data to an snapshot during a disaster. Then after recovery, you can \n \t\trestore it back to Amazon Web Services or on-premises from the snapshot. You no longer need to build and \n \t\tmaintain complex mechanisms to copy data to and from Amazon EBS.

\n

This API reference provides detailed information about the actions, data types,\n parameters, and errors of the EBS direct APIs. For more information about the elements that\n make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User\n Guide. For more information about the supported Amazon Web Services Regions, endpoints,\n and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in\n the Amazon Web Services General Reference.

", "smithy.api#title": "Amazon Elastic Block Store", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1428,7 +1440,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the data in a block in an Amazon Elastic Block Store snapshot.

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

Returns the data in a block in an Amazon Elastic Block Store snapshot.

\n \n

You should always retry requests that receive server (5xx) \n error responses, and ThrottlingException and RequestThrottledException \n client error responses. For more information see Error retries in the \n Amazon Elastic Compute Cloud User Guide.

\n ", "smithy.api#http": { "method": "GET", "uri": "/snapshots/{SnapshotId}/blocks/{BlockIndex}", @@ -1442,7 +1454,7 @@ "SnapshotId": { "target": "com.amazonaws.ebs#SnapshotId", "traits": { - "smithy.api#documentation": "

The ID of the snapshot containing the block from which to get data.

\n \n

If the specified snapshot is encrypted, you must have permission to use the \n KMS key that was used to encrypt the snapshot. For more information, see \n \n Using encryption in the Amazon Elastic Compute Cloud User \n Guide.

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

The ID of the snapshot containing the block from which to get data.

\n \n

If the specified snapshot is encrypted, you must have permission to use the \n KMS key that was used to encrypt the snapshot. For more information, see \n \n Using encryption in the Amazon Elastic Compute Cloud User \n Guide.

\n ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1463,6 +1475,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.ebs#GetSnapshotBlockResponse": { @@ -1497,6 +1512,9 @@ "smithy.api#httpHeader": "x-amz-Checksum-Algorithm" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ebs#IdempotencyToken": { @@ -1517,7 +1535,7 @@ } }, "traits": { - "smithy.api#documentation": "

An internal error has occurred.

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

An internal error has occurred. For more information see Error retries.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1562,7 +1580,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about the blocks that are different between two\n Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

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

Returns information about the blocks that are different between two\n Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

\n \n

You should always retry requests that receive server (5xx) \n error responses, and ThrottlingException and RequestThrottledException \n client error responses. For more information see Error retries in the \n Amazon Elastic Compute Cloud User Guide.

\n ", "smithy.api#http": { "method": "GET", "uri": "/snapshots/{SecondSnapshotId}/changedblocks", @@ -1581,14 +1599,14 @@ "FirstSnapshotId": { "target": "com.amazonaws.ebs#SnapshotId", "traits": { - "smithy.api#documentation": "

The ID of the first snapshot to use for the comparison.

\n \n

The FirstSnapshotID parameter must be specified with a\n SecondSnapshotId parameter; otherwise, an error occurs.

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

The ID of the first snapshot to use for the comparison.

\n \n

The FirstSnapshotID parameter must be specified with a\n SecondSnapshotId parameter; otherwise, an error occurs.

\n ", "smithy.api#httpQuery": "firstSnapshotId" } }, "SecondSnapshotId": { "target": "com.amazonaws.ebs#SnapshotId", "traits": { - "smithy.api#documentation": "

The ID of the second snapshot to use for the comparison.

\n \n

The SecondSnapshotId parameter must be specified with a\n FirstSnapshotID parameter; otherwise, an error occurs.

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

The ID of the second snapshot to use for the comparison.

\n \n

The SecondSnapshotId parameter must be specified with a\n FirstSnapshotID parameter; otherwise, an error occurs.

\n ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1596,24 +1614,27 @@ "NextToken": { "target": "com.amazonaws.ebs#PageToken", "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

\n

If you specify NextToken, then \n StartingBlockIndex is ignored.

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

The token to request the next page of results.

\n

If you specify NextToken, then \n StartingBlockIndex is ignored.

", "smithy.api#httpQuery": "pageToken" } }, "MaxResults": { "target": "com.amazonaws.ebs#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of blocks to be returned by the request.

\n

Even if additional blocks can be retrieved from the snapshot, the request can \n return less blocks than MaxResults or an empty \n array of blocks.

\n

To retrieve the next set of blocks from the snapshot, make another request with \n the returned NextToken value. The value of \n NextToken is null when there are no \n more blocks to return.

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

The maximum number of blocks to be returned by the request.

\n

Even if additional blocks can be retrieved from the snapshot, the request can \n return less blocks than MaxResults or an empty \n array of blocks.

\n

To retrieve the next set of blocks from the snapshot, make another request with \n the returned NextToken value. The value of \n NextToken is null when there are no \n more blocks to return.

", "smithy.api#httpQuery": "maxResults" } }, "StartingBlockIndex": { "target": "com.amazonaws.ebs#BlockIndex", "traits": { - "smithy.api#documentation": "

The block index from which the comparison should start.

\n

The list in the response will start from this block index or the next valid block\n index in the snapshots.

\n

If you specify NextToken, then \n StartingBlockIndex is ignored.

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

The block index from which the comparison should start.

\n

The list in the response will start from this block index or the next valid block\n index in the snapshots.

\n

If you specify NextToken, then \n StartingBlockIndex is ignored.

", "smithy.api#httpQuery": "startingBlockIndex" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.ebs#ListChangedBlocksResponse": { @@ -1649,6 +1670,9 @@ "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there\n are no more results to return.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ebs#ListSnapshotBlocks": { @@ -1680,7 +1704,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about the blocks in an Amazon Elastic Block Store snapshot.

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

Returns information about the blocks in an Amazon Elastic Block Store snapshot.

\n \n

You should always retry requests that receive server (5xx) \n error responses, and ThrottlingException and RequestThrottledException \n client error responses. For more information see Error retries in the \n Amazon Elastic Compute Cloud User Guide.

\n ", "smithy.api#http": { "method": "GET", "uri": "/snapshots/{SnapshotId}/blocks", @@ -1707,24 +1731,27 @@ "NextToken": { "target": "com.amazonaws.ebs#PageToken", "traits": { - "smithy.api#documentation": "

The token to request the next page of results.

\n

If you specify NextToken, then \n StartingBlockIndex is ignored.

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

The token to request the next page of results.

\n

If you specify NextToken, then \n StartingBlockIndex is ignored.

", "smithy.api#httpQuery": "pageToken" } }, "MaxResults": { "target": "com.amazonaws.ebs#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of blocks to be returned by the request.

\n

Even if additional blocks can be retrieved from the snapshot, the request can \n return less blocks than MaxResults or an empty \n array of blocks.

\n

To retrieve the next set of blocks from the snapshot, make another request with \n the returned NextToken value. The value of \n NextToken is null when there are no \n more blocks to return.

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

The maximum number of blocks to be returned by the request.

\n

Even if additional blocks can be retrieved from the snapshot, the request can \n return less blocks than MaxResults or an empty \n array of blocks.

\n

To retrieve the next set of blocks from the snapshot, make another request with \n the returned NextToken value. The value of \n NextToken is null when there are no \n more blocks to return.

", "smithy.api#httpQuery": "maxResults" } }, "StartingBlockIndex": { "target": "com.amazonaws.ebs#BlockIndex", "traits": { - "smithy.api#documentation": "

The block index from which the list should start. The list in the response will start\n from this block index or the next valid block index in the snapshot.

\n

If you specify NextToken, then \n StartingBlockIndex is ignored.

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

The block index from which the list should start. The list in the response will start\n from this block index or the next valid block index in the snapshot.

\n

If you specify NextToken, then \n StartingBlockIndex is ignored.

", "smithy.api#httpQuery": "startingBlockIndex" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.ebs#ListSnapshotBlocksResponse": { @@ -1760,6 +1787,9 @@ "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there\n are no more results to return.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ebs#MaxResults": { @@ -1833,7 +1863,7 @@ "smithy.api#auth": [ "aws.auth#sigv4" ], - "smithy.api#documentation": "

Writes a block of data to a snapshot. If the specified block contains\n data, the existing data is overwritten. The target snapshot must be in the\n pending state.

\t\n \t

Data written to a snapshot must be aligned with 512-KiB sectors.

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

Writes a block of data to a snapshot. If the specified block contains\n data, the existing data is overwritten. The target snapshot must be in the\n pending state.

\n

Data written to a snapshot must be aligned with 512-KiB sectors.

\n \n

You should always retry requests that receive server (5xx) \n error responses, and ThrottlingException and RequestThrottledException \n client error responses. For more information see Error retries in the \n Amazon Elastic Compute Cloud User Guide.

\n ", "smithy.api#http": { "method": "PUT", "uri": "/snapshots/{SnapshotId}/blocks/{BlockIndex}", @@ -1847,7 +1877,7 @@ "SnapshotId": { "target": "com.amazonaws.ebs#SnapshotId", "traits": { - "smithy.api#documentation": "

The ID of the snapshot.

\n \n

If the specified snapshot is encrypted, you must have permission to use \n the KMS key that was used to encrypt the snapshot. For more information, \n see \n Using encryption in the Amazon Elastic Compute Cloud User \n Guide..

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

The ID of the snapshot.

\n \n

If the specified snapshot is encrypted, you must have permission to use \n the KMS key that was used to encrypt the snapshot. For more information, \n see \n Using encryption in the Amazon Elastic Compute Cloud User \n Guide..

\n ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1863,7 +1893,7 @@ "BlockData": { "target": "com.amazonaws.ebs#BlockData", "traits": { - "smithy.api#documentation": "

The data to write to the block.

\n

The block data is not signed as part of the Signature Version 4 signing process. As a\n result, you must generate and provide a Base64-encoded SHA256 checksum for the block\n data using the x-amz-Checksum header. Also, you \n \tmust specify the checksum algorithm using the x-amz-Checksum-Algorithm \n \theader. The checksum that you provide is part of the Signature Version 4 signing process. \n \tIt is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity \n \tof the data. If the checksums do not correspond, the request fails. For more information, \n \tsee \n Using checksums with the EBS direct APIs in the Amazon Elastic Compute Cloud User\n Guide.

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

The data to write to the block.

\n

The block data is not signed as part of the Signature Version 4 signing process. As a\n result, you must generate and provide a Base64-encoded SHA256 checksum for the block\n data using the x-amz-Checksum header. Also, you \n \tmust specify the checksum algorithm using the x-amz-Checksum-Algorithm \n \theader. The checksum that you provide is part of the Signature Version 4 signing process. \n \tIt is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity \n \tof the data. If the checksums do not correspond, the request fails. For more information, \n \tsee \n Using checksums with the EBS direct APIs in the Amazon Elastic Compute Cloud User\n Guide.

", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -1871,7 +1901,7 @@ "DataLength": { "target": "com.amazonaws.ebs#DataLength", "traits": { - "smithy.api#documentation": "

The size of the data to write to the block, in bytes. Currently, the only supported\n size is 524288 bytes.

\n

Valid values: 524288\n

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

The size of the data to write to the block, in bytes. Currently, the only supported\n size is 524288 bytes.

\n

Valid values: 524288\n

", "smithy.api#httpHeader": "x-amz-Data-Length", "smithy.api#required": {} } @@ -1899,6 +1929,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.ebs#PutSnapshotBlockResponse": { @@ -1918,6 +1951,9 @@ "smithy.api#httpHeader": "x-amz-Checksum-Algorithm" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ebs#RequestThrottledException": { @@ -1934,28 +1970,32 @@ } }, "traits": { - "smithy.api#documentation": "

The number of API requests has exceed the maximum allowed API request throttling\n limit.

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

The number of API requests has exceeded the maximum allowed API request \n throttling limit for the snapshot. For more information see Error retries.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ebs#RequestThrottledExceptionReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACCOUNT_THROTTLED", - "name": "ACCOUNT_THROTTLED" - }, - { - "value": "DEPENDENCY_REQUEST_THROTTLED", - "name": "DEPENDENCY_REQUEST_THROTTLED" - }, - { - "value": "RESOURCE_LEVEL_THROTTLE", - "name": "RESOURCE_LEVEL_THROTTLE" + "type": "enum", + "members": { + "ACCOUNT_THROTTLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_THROTTLED" + } + }, + "DEPENDENCY_REQUEST_THROTTLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPENDENCY_REQUEST_THROTTLED" } - ] + }, + "RESOURCE_LEVEL_THROTTLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_LEVEL_THROTTLE" + } + } } }, "com.amazonaws.ebs#ResourceNotFoundException": { @@ -1978,18 +2018,55 @@ } }, "com.amazonaws.ebs#ResourceNotFoundExceptionReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SNAPSHOT_NOT_FOUND", - "name": "SNAPSHOT_NOT_FOUND" - }, - { - "value": "DEPENDENCY_RESOURCE_NOT_FOUND", - "name": "DEPENDENCY_RESOURCE_NOT_FOUND" + "type": "enum", + "members": { + "SNAPSHOT_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNAPSHOT_NOT_FOUND" } - ] + }, + "GRANT_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRANT_NOT_FOUND" + } + }, + "DEPENDENCY_RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPENDENCY_RESOURCE_NOT_FOUND" + } + }, + "IMAGE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE_NOT_FOUND" + } + } + } + }, + "com.amazonaws.ebs#SSEType": { + "type": "enum", + "members": { + "SSE_EBS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sse-ebs" + } + }, + "SSE_KMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sse-kms" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "none" + } + } } }, "com.amazonaws.ebs#ServiceQuotaExceededException": { @@ -2012,14 +2089,14 @@ } }, "com.amazonaws.ebs#ServiceQuotaExceededExceptionReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DEPENDENCY_SERVICE_QUOTA_EXCEEDED", - "name": "DEPENDENCY_SERVICE_QUOTA_EXCEEDED" + "type": "enum", + "members": { + "DEPENDENCY_SERVICE_QUOTA_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPENDENCY_SERVICE_QUOTA_EXCEEDED" } - ] + } } }, "com.amazonaws.ebs#SnapshotId": { @@ -2067,7 +2144,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon EBS snapshot. The new snapshot enters the pending state\n after the request completes.

\n

After creating the snapshot, use PutSnapshotBlock to\n write blocks of data to the snapshot.

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

Creates a new Amazon EBS snapshot. The new snapshot enters the pending state\n after the request completes.

\n

After creating the snapshot, use PutSnapshotBlock to\n write blocks of data to the snapshot.

\n \n

You should always retry requests that receive server (5xx) \n error responses, and ThrottlingException and RequestThrottledException \n client error responses. For more information see Error retries in the \n Amazon Elastic Compute Cloud User Guide.

\n ", "smithy.api#http": { "method": "POST", "uri": "/snapshots", @@ -2088,7 +2165,7 @@ "ParentSnapshotId": { "target": "com.amazonaws.ebs#SnapshotId", "traits": { - "smithy.api#documentation": "

The ID of the parent snapshot. If there is no parent snapshot, or if you are creating\n the first snapshot for an on-premises volume, omit this parameter.

\n

You can't specify ParentSnapshotId and \n Encrypted in the same request. If you specify both \n parameters, the request fails with ValidationException.

\n \n \n \n

The encryption status of the snapshot depends on the values that you specify for \n Encrypted, KmsKeyArn, \n and ParentSnapshotId, and whether your Amazon Web Services account \n is enabled for \n encryption by default. For more information, see \n Using encryption in the Amazon Elastic Compute Cloud User Guide.

\n \n \n

If you specify an encrypted parent snapshot, you must have permission to use the \n KMS key that was used to encrypt the parent snapshot. For more information, see \n \n Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User \n Guide.

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

The ID of the parent snapshot. If there is no parent snapshot, or if you are creating\n the first snapshot for an on-premises volume, omit this parameter.

\n

You can't specify ParentSnapshotId and \n Encrypted in the same request. If you specify both \n parameters, the request fails with ValidationException.

\n

The encryption status of the snapshot depends on the values that you specify for \n Encrypted, KmsKeyArn, \n and ParentSnapshotId, and whether your Amazon Web Services account \n is enabled for \n encryption by default. For more information, see \n Using encryption in the Amazon Elastic Compute Cloud User Guide.

\n \n

If you specify an encrypted parent snapshot, you must have permission to use the \n KMS key that was used to encrypt the parent snapshot. For more information, see \n \n Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User \n Guide.

\n " } }, "Tags": { @@ -2106,28 +2183,31 @@ "ClientToken": { "target": "com.amazonaws.ebs#IdempotencyToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent \n request, if the original request completes successfully. The subsequent retries with the same \n client token return the result from the original successful request and they have no additional \n effect.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

\n

For more information, see \n \t\tIdempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent \n request, if the original request completes successfully. The subsequent retries with the same \n client token return the result from the original successful request and they have no additional \n effect.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

\n

For more information, see \n \t\tIdempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.

", "smithy.api#idempotencyToken": {} } }, "Encrypted": { "target": "com.amazonaws.ebs#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether to encrypt the snapshot.

\n \n

You can't specify Encrypted and \n ParentSnapshotId in the same request. If you specify both parameters, the \n request fails with ValidationException.

\n \n

The encryption status of the snapshot depends on the values that you specify for \n Encrypted, KmsKeyArn, \n and ParentSnapshotId, and whether your Amazon Web Services account \n is enabled for \n encryption by default. For more information, see \n Using encryption in the Amazon Elastic Compute Cloud User Guide.

\n \n \n \n \n

To create an encrypted snapshot, you must have permission to use the KMS key. For \n more information, see \n Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User \n Guide.

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

Indicates whether to encrypt the snapshot.

\n

You can't specify Encrypted and \n ParentSnapshotId in the same request. If you specify both parameters, the \n request fails with ValidationException.

\n

The encryption status of the snapshot depends on the values that you specify for \n Encrypted, KmsKeyArn, \n and ParentSnapshotId, and whether your Amazon Web Services account \n is enabled for \n encryption by default. For more information, see \n Using encryption in the Amazon Elastic Compute Cloud User Guide.

\n \n

To create an encrypted snapshot, you must have permission to use the KMS key. For \n more information, see \n Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User \n Guide.

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

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be used to encrypt the snapshot.

\n \n

The encryption status of the snapshot depends on the values that you specify for \n Encrypted, KmsKeyArn, \n and ParentSnapshotId, and whether your Amazon Web Services account \n is enabled for \n encryption by default. For more information, see \n Using encryption in the Amazon Elastic Compute Cloud User Guide.

\n \n \n \n

To create an encrypted snapshot, you must have permission to use the KMS key. For \n more information, see \n Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User \n Guide.

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

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be used to encrypt the snapshot.

\n

The encryption status of the snapshot depends on the values that you specify for \n Encrypted, KmsKeyArn, \n and ParentSnapshotId, and whether your Amazon Web Services account \n is enabled for \n encryption by default. For more information, see \n Using encryption in the Amazon Elastic Compute Cloud User Guide.

\n \n

To create an encrypted snapshot, you must have permission to use the KMS key. For \n more information, see \n Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User \n Guide.

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

The amount of time (in minutes) after which the snapshot is automatically cancelled\n if:

\n \n

If no value is specified, the timeout defaults to 60 minutes.

" + "smithy.api#documentation": "

The amount of time (in minutes) after which the snapshot is automatically cancelled\n if:

\n \n

If no value is specified, the timeout defaults to 60 minutes.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.ebs#StartSnapshotResponse": { @@ -2192,26 +2272,41 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the snapshot.

" } + }, + "SseType": { + "target": "com.amazonaws.ebs#SSEType", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.ebs#Status": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "completed", - "name": "COMPLETED" - }, - { - "value": "pending", - "name": "PENDING" - }, - { - "value": "error", - "name": "ERROR" + "type": "enum", + "members": { + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" } - ], + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + } + }, + "traits": { "smithy.api#length": { "min": 0, "max": 32 @@ -2296,58 +2391,98 @@ } }, "com.amazonaws.ebs#ValidationExceptionReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "INVALID_CUSTOMER_KEY", - "name": "INVALID_CUSTOMER_KEY" - }, - { - "value": "INVALID_PAGE_TOKEN", - "name": "INVALID_PAGE_TOKEN" - }, - { - "value": "INVALID_BLOCK_TOKEN", - "name": "INVALID_BLOCK_TOKEN" - }, - { - "value": "INVALID_SNAPSHOT_ID", - "name": "INVALID_SNAPSHOT_ID" - }, - { - "value": "UNRELATED_SNAPSHOTS", - "name": "UNRELATED_SNAPSHOTS" - }, - { - "value": "INVALID_BLOCK", - "name": "INVALID_BLOCK" - }, - { - "value": "INVALID_CONTENT_ENCODING", - "name": "INVALID_CONTENT_ENCODING" - }, - { - "value": "INVALID_TAG", - "name": "INVALID_TAG" - }, - { - "value": "INVALID_DEPENDENCY_REQUEST", - "name": "INVALID_DEPENDENCY_REQUEST" - }, - { - "value": "INVALID_PARAMETER_VALUE", - "name": "INVALID_PARAMETER_VALUE" - }, - { - "value": "INVALID_VOLUME_SIZE", - "name": "INVALID_VOLUME_SIZE" - }, - { - "value": "CONFLICTING_BLOCK_UPDATE", - "name": "CONFLICTING_BLOCK_UPDATE" + "type": "enum", + "members": { + "INVALID_CUSTOMER_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_CUSTOMER_KEY" } - ] + }, + "INVALID_PAGE_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_PAGE_TOKEN" + } + }, + "INVALID_BLOCK_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_BLOCK_TOKEN" + } + }, + "INVALID_GRANT_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_GRANT_TOKEN" + } + }, + "INVALID_SNAPSHOT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_SNAPSHOT_ID" + } + }, + "UNRELATED_SNAPSHOTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNRELATED_SNAPSHOTS" + } + }, + "INVALID_BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_BLOCK" + } + }, + "INVALID_CONTENT_ENCODING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_CONTENT_ENCODING" + } + }, + "INVALID_TAG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_TAG" + } + }, + "INVALID_DEPENDENCY_REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_DEPENDENCY_REQUEST" + } + }, + "INVALID_PARAMETER_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_PARAMETER_VALUE" + } + }, + "INVALID_VOLUME_SIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_VOLUME_SIZE" + } + }, + "CONFLICTING_BLOCK_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFLICTING_BLOCK_UPDATE" + } + }, + "INVALID_IMAGE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_IMAGE_ID" + } + }, + "WRITE_REQUEST_TIMEOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WRITE_REQUEST_TIMEOUT" + } + } } }, "com.amazonaws.ebs#VolumeSize": { diff --git a/codegen/sdk/aws-models/ec2.json b/codegen/sdk/aws-models/ec2.json index ad0a3fa0f8a5..ceab0cec3777 100644 --- a/codegen/sdk/aws-models/ec2.json +++ b/codegen/sdk/aws-models/ec2.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.

\n

You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created \n from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own \n IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

\n

If 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.

\n

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, \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.

\n

You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created \n from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own \n IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

\n

If 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.

\n

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, \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.

\n

If 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.

\n

You cannot associate an Elastic IP address with an interface in a different network border group.

\n \n

This 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.

\n " + "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.

\n

If 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.

\n

You cannot associate an Elastic IP address with an interface in a different network border group.

\n \n

This 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.

\n ", + "smithy.api#examples": [ + { + "title": "To associate an Elastic IP address", + "documentation": "This example associates the specified Elastic IP address with the specified instance.", + "input": { + "AllocationId": "eipalloc-64d5890a", + "InstanceId": "i-0b263919b6498b123" + }, + "output": { + "AssociationId": "eipassoc-2bebb745" + } + } + ] } }, "com.amazonaws.ec2#AssociateAddressRequest": { @@ -6150,7 +6140,17 @@ "target": "smithy.api#Unit" }, "traits": { - "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.

\n

After 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.

\n

For 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.

\n

After 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.

\n

For 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.

\n

Encrypted 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.

\n

After you attach an EBS volume, you must make it available. For more information, see \n Make an EBS volume available for use.

\n

If a volume has an Amazon Web Services Marketplace product code:

\n \n

For 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.

\n

Encrypted 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.

\n

After you attach an EBS volume, you must make it available. For more information, see \n Make an EBS volume available for use.

\n

If a volume has an Amazon Web Services Marketplace product code:

\n \n

For 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.

\n

An 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.

\n

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.

\n

Rule changes are propagated to instances within the security group as quickly as possible. \n However, a small delay might occur.

\n

For more information about VPC security group quotas, see Amazon VPC quotas.

" + "smithy.api#documentation": "

Adds the specified inbound (ingress) rules to a security group.

\n

An 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.

\n

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.

\n

Rule changes are propagated to instances within the security group as quickly as possible. \n However, a small delay might occur.

\n

For 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.

\n

To 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.

\n

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.

\n

For 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.

\n

To 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.

\n

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.

\n

For 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.

\n

You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).

\n

When 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.

\n

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 Elastic Compute Cloud User Guide.

\n

Snapshots created by copying another snapshot have an arbitrary volume ID that should not\n be used for any purpose.

\n

For 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.

\n

You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).

\n

When 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.

\n

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 Elastic Compute Cloud User Guide.

\n

Snapshots created by copying another snapshot have an arbitrary volume ID that should not\n be used for any purpose.

\n

For 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).

\n

For 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.

\n

To 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).

\n

For 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.

\n

To 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

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.

" + "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

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.

", + "smithy.api#examples": [ + { + "title": "To create a DHCP options set", + "documentation": "This example creates a DHCP options set.", + "input": { + "DhcpConfigurations": [ + { + "Key": "domain-name-servers", + "Values": [ + "10.2.5.1", + "10.2.5.2" + ] + } + ] + }, + "output": { + "DhcpOptions": { + "DhcpConfigurations": [ + { + "Values": [ + { + "Value": "10.2.5.2" + }, + { + "Value": "10.2.5.1" + } + ], + "Key": "domain-name-servers" + } + ], + "DhcpOptionsId": "dopt-d9070ebb" + } + } + } + ] } }, "com.amazonaws.ec2#CreateDhcpOptionsRequest": { @@ -15048,7 +15210,20 @@ "target": "com.amazonaws.ec2#CreateInternetGatewayResult" }, "traits": { - "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.

\n

For 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.

\n

For 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.

\n

The 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.

\n

You can have up to 5,000 key pairs per Amazon Web Services Region.

\n

For 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.

\n

The 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.

\n

You can have up to 5,000 key pairs per Amazon Web Services Region.

\n

For 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.

\n

A 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.

\n

If 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.

\n

A 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.

\n

If 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.

\n

Launch 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.

\n

Launch 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.

\n

For 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.

\n

Launch 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.

\n

Launch 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.

\n

For 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.

\n

With 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.

\n

With 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.

\n

For 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.

\n

With 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.

\n

With 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.

\n

For 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.

\n

A 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.

\n

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.

\n

A 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.

\n

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.

\n

A 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.

\n

When 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.

\n

You 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.

\n

You 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.

\n

For more information about VPC security group limits, see Amazon VPC Limits.

" + "smithy.api#documentation": "

Creates a security group.

\n

A 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.

\n

When 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.

\n

You 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.

\n

You 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.

\n

For 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.

\n

You 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.

\n

When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.

\n

You 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.

\n

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.

\n

Snapshots 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.

\n

You can tag your snapshots during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.

\n

For 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.

\n

You 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.

\n

When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.

\n

You 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.

\n

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.

\n

Snapshots 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.

\n

You can tag your snapshots during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.

\n

For 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.

\n

A 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.

\n

The 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.

\n

If 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.

\n

If 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.

\n

When 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.

\n

For 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.

\n

A 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.

\n

The 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.

\n

If 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.

\n

If 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.

\n

When 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.

\n

For 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": { @@ -19778,7 +20143,29 @@ "target": "com.amazonaws.ec2#Volume" }, "traits": { - "smithy.api#documentation": "

Creates an EBS volume that can be attached to an instance in the same Availability Zone.

\n

You 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.

\n

You 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.

\n

You can tag your volumes during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.

\n

For 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.

\n

You 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.

\n

You 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.

\n

You can tag your volumes during creation. For more information, see Tag your Amazon EC2\n resources in the Amazon Elastic Compute Cloud User Guide.

\n

For 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.

\n

You 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).

\n

By 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.

\n

You 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.

\n

You 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).

\n

By 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.

\n

You 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. 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#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": { @@ -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.

\n

If 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.

" + "smithy.api#documentation": "

Deletes a security group.

\n

If 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.

", + "smithy.api#examples": [ + { + "title": "To delete a security group", + "documentation": "This example deletes the specified security group.", + "input": { + "GroupId": "sg-903004f8" + }, + "output": {} + } + ] } }, "com.amazonaws.ec2#DeleteSecurityGroupRequest": { @@ -23502,7 +23997,17 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deletes the specified snapshot.

\n

When 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.

\n

You 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.

\n

For more information, see Delete an Amazon EBS snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Deletes the specified snapshot.

\n

When 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.

\n

You 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.

\n

For 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).

\n

The volume can remain in the deleting state for several minutes.

\n

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).

\n

The volume can remain in the deleting state for several minutes.

\n

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 " + "smithy.api#documentation": "

Describes attributes of your Amazon Web Services account. The following are the supported account attributes:

\n ", + "smithy.api#examples": [ + { + "title": "To describe a single attribute for your AWS account", + "documentation": "This example describes the supported-platforms attribute for your AWS account.", + "input": { + "AttributeNames": [ + "supported-platforms" + ] + }, + "output": { + "AccountAttributes": [ + { + "AttributeName": "supported-platforms", + "AttributeValues": [ + { + "AttributeValue": "EC2" + }, + { + "AttributeValue": "VPC" + } + ] + } + ] + } + } + ] } }, "com.amazonaws.ec2#DescribeAccountAttributesRequest": { @@ -25717,7 +26282,32 @@ "target": "com.amazonaws.ec2#DescribeAddressesResult" }, "traits": { - "smithy.api#documentation": "

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.

\n

For 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.

\n

For 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.

\n

For 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.

\n

For 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.

\n

The 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.

\n

Recently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.

", + "smithy.api#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.

\n

Instance status includes the following components:

\n ", + "smithy.api#examples": [ + { + "title": "To describe the status of an instance", + "documentation": "This example describes the current status of the specified instance.", + "input": { + "InstanceIds": [ + "i-1234567890abcdef0" + ] + }, + "output": { + "InstanceStatuses": [ + { + "InstanceId": "i-1234567890abcdef0", + "InstanceState": { + "Code": 16, + "Name": "running" + }, + "AvailabilityZone": "us-east-1d", + "SystemStatus": { + "Status": "ok", + "Details": [ + { + "Status": "passed", + "Name": "reachability" + } + ] + }, + "InstanceStatus": { + "Status": "ok", + "Details": [ + { + "Status": "passed", + "Name": "reachability" + } + ] + } + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -30444,6 +31246,18 @@ }, "traits": { "smithy.api#documentation": "

Describes the specified instances or all instances.

\n

If 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.

\n

If 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.

\n

Recently terminated instances might appear in the returned results. This interval is\n usually less than one hour.

\n

If 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", @@ -30683,6 +31497,36 @@ }, "traits": { "smithy.api#documentation": "

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.

\n

For 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": "\n

This action is deprecated.

\n \n

Describes 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.

\n

For 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.

\n

For a list of the Regions supported by Amazon EC2, see \n Amazon Elastic Compute Cloud endpoints and quotas.

\n

For 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.

\n

For a list of the Regions supported by Amazon EC2, see \n Amazon Elastic Compute Cloud endpoints and quotas.

\n

For 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.

\n

Each 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.

\n

For 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.

\n

For 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.

\n

For 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.

\n

The 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.

\n

The create volume permissions fall into the following categories:

\n \n

The 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.

\n

If 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.

\n

If 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.

\n

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.

\n

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.

\n

To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.

\n

For 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.

\n

Spot 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.

\n

You can use DescribeSpotInstanceRequests to find a running Spot Instance by\n examining the response. If the status of the Spot Instance is fulfilled, the\n instance ID appears in the response and contains the identifier of the instance.\n Alternatively, you can use DescribeInstances\n with a filter to look for instances where the instance lifecycle is\n spot.

\n

We recommend that you set MaxResults to a value between 5 and 1000 to\n limit the number of 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.

\n

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.

\n

When you specify a start and end time, the operation returns the prices of the\n instance types within that time range. It also returns the last price change before the\n start time, which is the effective price as of the start time.

", + "smithy.api#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", @@ -35828,6 +37246,43 @@ "outputToken": "NextToken", "items": "StoreImageTaskResults", "pageSize": "MaxResults" + }, + "smithy.waiters#waitable": { + "StoreImageTaskComplete": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "StoreImageTaskResults[].StoreTaskState", + "expected": "Completed", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "StoreImageTaskResults[].StoreTaskState", + "expected": "Failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "StoreImageTaskResults[].StoreTaskState", + "expected": "InProgress", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 5 + } } } }, @@ -35919,6 +37374,36 @@ }, "traits": { "smithy.api#documentation": "

Describes one or more of your subnets.

\n

For 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", @@ -36034,6 +37519,38 @@ }, "traits": { "smithy.api#documentation": "

Describes the specified tags for your EC2 resources.

\n

For 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", @@ -37820,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.

\n

For 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.

\n

For 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": { @@ -37899,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.

\n

The DescribeVolumeStatus operation provides the following information about\n the specified volumes:

\n

\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

\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

\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.

\n

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.)

", + "smithy.api#examples": [ + { + "title": "To describe the status of a single volume", + "documentation": "This example describes the status for the volume ``vol-1234567890abcdef0``.", + "input": { + "VolumeIds": [ + "vol-1234567890abcdef0" + ] + }, + "output": { + "VolumeStatuses": [ + { + "VolumeStatus": { + "Status": "ok", + "Details": [ + { + "Status": "passed", + "Name": "io-enabled" + }, + { + "Status": "not-applicable", + "Name": "io-performance" + } + ] + }, + "AvailabilityZone": "us-east-1a", + "VolumeId": "vol-1234567890abcdef0", + "Actions": [], + "Events": [] + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -37987,6 +39554,36 @@ }, "traits": { "smithy.api#documentation": "

Describes the specified EBS volumes or all of your EBS volumes.

\n

If 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.

\n

For 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", @@ -38240,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": { @@ -39133,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", @@ -39780,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.

\n

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.

\n

For 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.

\n

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.

\n

For 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": { @@ -40845,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": { @@ -40993,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.

\n

This 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.

\n

This 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": { @@ -41165,7 +42842,27 @@ "target": "com.amazonaws.ec2#DisassociateIamInstanceProfileResult" }, "traits": { - "smithy.api#documentation": "

Disassociates an IAM instance profile from a running or stopped instance.

\n

Use DescribeIamInstanceProfileAssociations to get the association\n ID.

" + "smithy.api#documentation": "

Disassociates an IAM instance profile from a running or stopped instance.

\n

Use 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": { @@ -42330,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.

\n

This parameter is only supported on BlockDeviceMapping objects called by\n \n CreateImage.

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

The ARN of the Outpost on which the snapshot is stored.

\n

This parameter is not supported when using CreateImage.

", "smithy.api#xmlName": "outpostArn" } }, @@ -44092,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": { @@ -48184,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.

\n

By 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.

\n

You 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.

\n

For 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.

\n

By 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.

\n

You 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.

\n

For 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": { @@ -48457,6 +50178,14 @@ "smithy.api#documentation": "

Indicates whether encryption by default is enabled.

", "smithy.api#xmlName": "ebsEncryptionByDefault" } + }, + "SseType": { + "target": "com.amazonaws.ec2#SSEType", + "traits": { + "aws.protocols#ec2QueryName": "SseType", + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#xmlName": "sseType" + } } }, "traits": { @@ -49469,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.

\n

This 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.

" + "smithy.api#documentation": "

Retrieves the configuration data of the specified instance. You can use this data to\n create a launch template.

\n

This 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.

", + "smithy.api#examples": [ + { + "title": "To get the launch template data for an instance ", + "documentation": "This example gets the launch template data for the specified instance.", + "input": { + "InstanceId": "0123d646e8048babc" + }, + "output": { + "LaunchTemplateData": { + "NetworkInterfaces": [ + { + "DeviceIndex": 0, + "Groups": [ + "sg-d14e1bb4" + ], + "Ipv6Addresses": [], + "AssociatePublicIpAddress": false, + "NetworkInterfaceId": "eni-4338b5a9", + "DeleteOnTermination": true, + "Description": "", + "PrivateIpAddress": "10.0.3.233", + "SubnetId": "subnet-5264e837", + "PrivateIpAddresses": [ + { + "PrivateIpAddress": "10.0.3.233", + "Primary": true + } + ] + } + ], + "Placement": { + "GroupName": "", + "Tenancy": "default", + "AvailabilityZone": "us-east-2b" + }, + "InstanceType": "t2.medium", + "EbsOptimized": false, + "BlockDeviceMappings": [ + { + "Ebs": { + "VolumeType": "gp2", + "Encrypted": false, + "Iops": 100, + "VolumeSize": 8, + "SnapshotId": "snap-02594938353ef77d3", + "DeleteOnTermination": true + }, + "DeviceName": "/dev/xvda" + } + ], + "KeyName": "my-key-pair", + "ImageId": "ami-32cf7b4a", + "Monitoring": { + "Enabled": false + } + } + } + } + ] } }, "com.amazonaws.ec2#GetLaunchTemplateDataRequest": { @@ -55966,6 +57754,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. \n For more information, see RunInstances.

", + "smithy.api#xmlName": "isPrimaryIpv6" + } } }, "traits": { @@ -56770,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.

" } + }, + "PrimaryIpv6": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } } }, "traits": { @@ -66358,6 +68164,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": { @@ -66510,6 +68326,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.

" } + }, + "PrimaryIpv6": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "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.

" + } } }, "traits": { @@ -69692,7 +71516,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.

\n

To specify the attribute, you can use the Attribute parameter, or one of the following parameters: \n Description, ImdsSupport, or LaunchPermission.

\n

Images with an Amazon Web Services Marketplace product code cannot be made public.

\n

To 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.

\n

To specify the attribute, you can use the Attribute parameter, or one of the following parameters: \n Description, ImdsSupport, or LaunchPermission.

\n

Images with an Amazon Web Services Marketplace product code cannot be made public.

\n

To 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": { @@ -70886,7 +72727,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": { @@ -71181,6 +73042,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": { @@ -71400,7 +73269,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.

\n

Encrypted 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.

\n

For 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.

\n

Encrypted 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.

\n

For 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": { @@ -71625,7 +73509,19 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Modifies a subnet attribute. You can only modify one attribute at a time.

\n

Use this action to modify subnets on Amazon Web Services Outposts.

\n \n

For more information about Amazon Web Services Outposts, see the following:

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

Modifies a subnet attribute. You can only modify one attribute at a time.

\n

Use this action to modify subnets on Amazon Web Services Outposts.

\n \n

For more information about Amazon Web Services Outposts, see the following:

\n ", + "smithy.api#examples": [ + { + "title": "To change a subnet's public IP addressing behavior", + "documentation": "This example modifies the specified subnet so that all instances launched into this subnet are assigned a public IP address.", + "input": { + "SubnetId": "subnet-1a2b3c4d", + "MapPublicIpOnLaunch": { + "Value": true + } + } + } + ] } }, "com.amazonaws.ec2#ModifySubnetAttributeRequest": { @@ -72952,7 +74848,21 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Modifies a volume attribute.

\n

By 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.

\n

You 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.

\n

By 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.

\n

You 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": { @@ -73074,7 +74984,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": { @@ -76228,6 +78150,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": { @@ -80176,7 +82108,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.

\n

If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a\n hard reboot.

\n

For 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.

\n

If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a\n hard reboot.

\n

For 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": { @@ -81031,7 +82975,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).

\n

After releasing an Elastic IP address, it is released to the IP address pool. \n Be sure to update your DNS records and any servers or devices that communicate with the address. \n If you attempt to release an Elastic IP address that you already released, you'll get an\n AuthFailure error if the address is already allocated to another Amazon Web Services account.

\n

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).

\n

After releasing an Elastic IP address, it is released to the IP address pool. \n Be sure to update your DNS records and any servers or devices that communicate with the address. \n If you attempt to release an Elastic IP address that you already released, you'll get an\n AuthFailure error if the address is already allocated to another Amazon Web Services account.

\n

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": { @@ -82524,7 +84477,32 @@ "target": "com.amazonaws.ec2#RequestSpotInstancesResult" }, "traits": { - "smithy.api#documentation": "

Creates a Spot Instance request.

\n

For more information, see Spot Instance requests in\n the Amazon EC2 User Guide for Linux Instances.

\n \n

We 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.

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

Creates a Spot Instance request.

\n

For more information, see Spot Instance requests in\n the Amazon EC2 User Guide for Linux Instances.

\n \n

We 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.

\n ", + "smithy.api#examples": [ + { + "title": "To create a one-time Spot Instance request", + "documentation": "This example creates a one-time Spot Instance request for five instances in the specified Availability Zone. If your account supports EC2-VPC only, Amazon EC2 launches the instances in the default subnet of the specified Availability Zone.", + "input": { + "SpotPrice": "0.03", + "InstanceCount": 5, + "Type": "one-time", + "LaunchSpecification": { + "ImageId": "ami-1a2b3c4d", + "KeyName": "my-key-pair", + "SecurityGroupIds": [ + "sg-1a2b3c4d" + ], + "InstanceType": "m3.medium", + "Placement": { + "AvailabilityZone": "us-west-2a" + }, + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + } + } + } + } + ] } }, "com.amazonaws.ec2#RequestSpotInstancesRequest": { @@ -83933,7 +85911,18 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Resets 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": { @@ -84090,7 +86079,18 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Resets permission settings for the specified snapshot.

\n

For 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.

\n

For 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": { @@ -85338,6 +87338,14 @@ "smithy.api#documentation": "

The size of the volume, in GiB.

", "smithy.api#xmlName": "volumeSize" } + }, + "SseType": { + "target": "com.amazonaws.ec2#SSEType", + "traits": { + "aws.protocols#ec2QueryName": "SseType", + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#xmlName": "sseType" + } } }, "traits": { @@ -86335,7 +88343,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.

\n

You can specify a number of options, or leave the default options. The following rules\n apply:

\n \n

You 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.

\n

To 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.

\n

An 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.

\n

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.

\n

For 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.

\n

You can specify a number of options, or leave the default options. The following rules\n apply:

\n \n

You 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.

\n

To 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.

\n

An 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.

\n

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.

\n

For 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": { @@ -86641,6 +88686,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": { @@ -86805,6 +88858,29 @@ "smithy.api#documentation": "

Describes the storage parameters for Amazon S3 and Amazon S3 buckets for an instance store-backed AMI.

" } }, + "com.amazonaws.ec2#SSEType": { + "type": "enum", + "members": { + "sse_ebs": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sse-ebs" + } + }, + "sse_kms": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sse-kms" + } + }, + "none": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "none" + } + } + } + }, "com.amazonaws.ec2#ScheduledInstance": { "type": "structure", "members": { @@ -88956,6 +91032,14 @@ "smithy.api#documentation": "

Only for archived snapshots that are temporarily restored. Indicates the date and \n time when a temporarily restored snapshot will be automatically re-archived.

", "smithy.api#xmlName": "restoreExpiryTime" } + }, + "SseType": { + "target": "com.amazonaws.ec2#SSEType", + "traits": { + "aws.protocols#ec2QueryName": "SseType", + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#xmlName": "sseType" + } } }, "traits": { @@ -89216,6 +91300,14 @@ "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the \n \t\tAmazon Elastic Compute Cloud User Guide.

", "smithy.api#xmlName": "outpostArn" } + }, + "SseType": { + "target": "com.amazonaws.ec2#SSEType", + "traits": { + "aws.protocols#ec2QueryName": "SseType", + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#xmlName": "sseType" + } } }, "traits": { @@ -91003,7 +93095,33 @@ "target": "com.amazonaws.ec2#StartInstancesResult" }, "traits": { - "smithy.api#documentation": "

Starts an Amazon EBS-backed instance that you've previously stopped.

\n

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and\n started. When an instance is stopped, the compute resources are released and you are not\n billed for instance usage. However, your root partition Amazon EBS volume remains and\n continues to persist your data, and you are charged for Amazon EBS volume usage. You can\n restart your instance at any time. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.

\n

Before stopping an instance, make sure it is in a state from which it can be\n restarted. Stopping an instance does not preserve data stored in RAM.

\n

Performing this operation on an instance that uses an instance store as its root\n device returns an error.

\n

If 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.

\n

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.

\n

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and\n started. When an instance is stopped, the compute resources are released and you are not\n billed for instance usage. However, your root partition Amazon EBS volume remains and\n continues to persist your data, and you are charged for Amazon EBS volume usage. You can\n restart your instance at any time. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.

\n

Before stopping an instance, make sure it is in a state from which it can be\n restarted. Stopping an instance does not preserve data stored in RAM.

\n

Performing this operation on an instance that uses an instance store as its root\n device returns an error.

\n

If 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.

\n

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": { @@ -91438,7 +93556,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.

\n

You can use the Stop action to hibernate an instance if the instance is enabled for\n hibernation and it meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.

\n

We don't charge usage for a stopped instance, or data transfer fees; however, your\n root partition Amazon EBS volume remains and continues to persist your data, and you are\n charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.

\n

You can't stop or hibernate instance store-backed instances. You can't use the Stop\n action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate\n Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the\n Amazon EC2 User Guide.

\n

When you stop or hibernate an instance, we shut it down. You can restart your instance\n at any time. Before stopping or hibernating an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not preserve data stored in RAM,\n but hibernating an instance does preserve data stored in RAM. If an instance cannot\n hibernate successfully, a normal shutdown occurs.

\n

Stopping and hibernating an instance is different to rebooting or terminating it. For\n example, when you stop or hibernate an instance, the root device and any other devices\n attached to the instance persist. When you terminate an instance, the root device and\n any other devices attached during the instance launch are automatically deleted. For\n more information about the differences between rebooting, stopping, hibernating, and\n terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

When you stop an instance, we attempt to shut it down forcibly after a short while. If\n your instance appears stuck in the stopping state after a period of time, there may be\n an issue with the underlying host computer. For more information, see 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.

\n

You can use the Stop action to hibernate an instance if the instance is enabled for\n hibernation and it meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.

\n

We don't charge usage for a stopped instance, or data transfer fees; however, your\n root partition Amazon EBS volume remains and continues to persist your data, and you are\n charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.

\n

You can't stop or hibernate instance store-backed instances. You can't use the Stop\n action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate\n Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the\n Amazon EC2 User Guide.

\n

When you stop or hibernate an instance, we shut it down. You can restart your instance\n at any time. Before stopping or hibernating an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not preserve data stored in RAM,\n but hibernating an instance does preserve data stored in RAM. If an instance cannot\n hibernate successfully, a normal shutdown occurs.

\n

Stopping and hibernating an instance is different to rebooting or terminating it. For\n example, when you stop or hibernate an instance, the root device and any other devices\n attached to the instance persist. When you terminate an instance, the root device and\n any other devices attached during the instance launch are automatically deleted. For\n more information about the differences between rebooting, stopping, hibernating, and\n terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

When you stop an instance, we attempt to shut it down forcibly after a short while. If\n your instance appears stuck in the stopping state after a period of time, there may be\n an issue with the underlying host computer. For more information, see 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": { @@ -92916,7 +95060,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.

\n

If you specify multiple instances and the request fails (for example, because of a\n single incorrect instance ID), none of the instances are terminated.

\n

If 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:

\n \n

For example, say you have the following instances:

\n \n

If you attempt to terminate all of these instances in the same request, the request\n reports failure with the following results:

\n \n

Terminated instances remain visible after termination (for approximately one\n hour).

\n

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.

\n

You can stop, start, and terminate EBS-backed instances. You can only terminate\n instance store-backed instances. What happens to an instance differs if you stop it or\n terminate it. For example, when you stop an instance, the root device and any other\n devices attached to the instance persist. When you terminate an instance, any attached\n EBS volumes with the DeleteOnTermination block device mapping parameter set\n to true are automatically deleted. For more information about the\n differences between stopping and terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

For more information about troubleshooting, see Troubleshooting terminating your instance in the\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.

\n

If you specify multiple instances and the request fails (for example, because of a\n single incorrect instance ID), none of the instances are terminated.

\n

If 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:

\n \n

For example, say you have the following instances:

\n \n

If you attempt to terminate all of these instances in the same request, the request\n reports failure with the following results:

\n \n

Terminated instances remain visible after termination (for approximately one\n hour).

\n

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.

\n

You can stop, start, and terminate EBS-backed instances. You can only terminate\n instance store-backed instances. What happens to an instance differs if you stop it or\n terminate it. For example, when you stop an instance, the root device and any other\n devices attached to the instance persist. When you terminate an instance, any attached\n EBS volumes with the DeleteOnTermination block device mapping parameter set\n to true are automatically deleted. For more information about the\n differences between stopping and terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

For more information about troubleshooting, see Troubleshooting terminating your instance in the\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": { @@ -97438,7 +99608,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": { @@ -97509,7 +99702,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": { @@ -99283,6 +101499,14 @@ "smithy.api#documentation": "

The throughput that the volume supports, in MiB/s.

", "smithy.api#xmlName": "throughput" } + }, + "SseType": { + "target": "com.amazonaws.ec2#SSEType", + "traits": { + "aws.protocols#ec2QueryName": "SseType", + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#xmlName": "sseType" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/ecs.json b/codegen/sdk/aws-models/ecs.json index 6f83e3d43615..37ba5292c62f 100644 --- a/codegen/sdk/aws-models/ecs.json +++ b/codegen/sdk/aws-models/ecs.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.

\n \n

When the ECS_CONTAINER_START_TIMEOUT container agent configuration\n\t\t\t\tvariable is used, it's enforced independently from this start timeout value.

\n \n

For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:

\n \n

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.

" + "smithy.api#documentation": "

Time duration (in seconds) to wait before giving up on resolving dependencies for a\n\t\t\tcontainer. For example, you specify two containers in a task definition with containerA\n\t\t\thaving a dependency on containerB reaching a COMPLETE,\n\t\t\tSUCCESS, or HEALTHY status. If a startTimeout\n\t\t\tvalue is specified for containerB and it doesn't reach the desired status within that\n\t\t\ttime then containerA gives up and not start. This results in the task transitioning to a\n\t\t\t\tSTOPPED state.

\n \n

When the ECS_CONTAINER_START_TIMEOUT container agent configuration\n\t\t\t\tvariable is used, it's enforced independently from this start timeout value.

\n \n

For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:

\n \n

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.

\n

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.

\n

For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:

\n \n

The max stop timeout value is 120 seconds and if the parameter is not specified, the\n\t\t\tdefault value of 30 seconds is used.

\n

For tasks that use the EC2 launch type, if the stopTimeout\n\t\t\tparameter isn't specified, the value set for the Amazon ECS container agent configuration\n\t\t\tvariable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the\n\t\t\t\tstopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT\n\t\t\tagent configuration variable are set, then the default values of 30 seconds for Linux\n\t\t\tcontainers and 30 seconds on Windows containers are used. Your container instances\n\t\t\trequire at least version 1.26.0 of the container agent to 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.

" + "smithy.api#documentation": "

Time duration (in seconds) to wait before the container is forcefully killed if it\n\t\t\tdoesn't exit normally on its own.

\n

For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:

\n \n

The max stop timeout value is 120 seconds and if the parameter is not specified, the\n\t\t\tdefault value of 30 seconds is used.

\n

For tasks that use the EC2 launch type, if the stopTimeout\n\t\t\tparameter isn't specified, the value set for the Amazon ECS container agent configuration\n\t\t\tvariable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the\n\t\t\t\tstopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT\n\t\t\tagent configuration variable are set, then the default values of 30 seconds for Linux\n\t\t\tcontainers and 30 seconds on Windows containers are used. Your container instances\n\t\t\trequire at least version 1.26.0 of the container agent to 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.

\n

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.

\n

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.

\n

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.

" + "smithy.api#documentation": "

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.

\n

There are two formats for each ARN.

\n
\n
credentialspecdomainless:MyARN
\n
\n

You 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.

\n

Each task that runs on any container instance can join different\n\t\t\t\t\t\tdomains.

\n

You can use this format without joining the container instance to a\n\t\t\t\t\t\tdomain.

\n
\n
credentialspec:MyARN
\n
\n

You use credentialspec:MyARN to provide a\n\t\t\t\t\t\t\tCredSpec for a single domain.

\n

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.

\n
\n
\n

In both formats, replace MyARN with the ARN in\n\t\t\tSSM or Amazon S3.

\n

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.

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

The overrides that are sent to a container. An empty container override can be passed\n\t\t\tin. An example of an empty container override is {\"containerOverrides\": [ ]\n\t\t\t\t}. If a non-empty container override is specified, the name\n\t\t\tparameter must be included.

" + "smithy.api#documentation": "

The overrides that are sent to a container. An empty container override can be passed\n\t\t\tin. An example of an empty container override is {\"containerOverrides\": [ ]\n\t\t\t\t}. If a non-empty container override is specified, the name\n\t\t\tparameter must be included.

\n

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.

\n \n

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.

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

Creates a new Amazon ECS cluster. By default, your account receives a default\n\t\t\tcluster when you launch your first container instance. However, you can create your own\n\t\t\tcluster with a unique name with the CreateCluster action.

\n \n

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.

\n ", + "smithy.api#examples": [ + { + "title": "To create a new cluster", + "documentation": "This example creates a cluster in your default region.", + "input": { + "clusterName": "my_cluster" + }, + "output": { + "cluster": { + "status": "ACTIVE", + "clusterName": "my_cluster", + "registeredContainerInstancesCount": 0, + "pendingTasksCount": 0, + "runningTasksCount": 0, + "activeServicesCount": 0, + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster" + } + } + } + ] } }, "com.amazonaws.ecs#CreateClusterRequest": { @@ -3056,7 +3040,59 @@ } ], "traits": { - "smithy.api#documentation": "

Runs and maintains your desired number of tasks from a specified task definition. If\n\t\t\tthe number of tasks running in a service drops below the desiredCount,\n\t\t\tAmazon ECS runs another copy of the task in the specified cluster. To update an existing\n\t\t\tservice, see the UpdateService action.

\n \n

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.

\n \n

In addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

\n

Tasks for services that don't use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING state. Tasks for services that use a load balancer are\n\t\t\tconsidered healthy if they're in the RUNNING state and are reported as\n\t\t\thealthy by the load balancer.

\n

There are two service scheduler strategies available:

\n \n

You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis initiated by changing properties. For example, the deployment might be initiated by\n\t\t\tthe task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for\n\t\t\t\tminimumHealthyPercent is 100%. The default value for a daemon service\n\t\t\tfor minimumHealthyPercent is 0%.

\n

If a service uses the ECS deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of your desired number of tasks (rounded up to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can deploy without using additional cluster capacity. For example, if you\n\t\t\tset your service to have desired number of four tasks and a minimum healthy percent of\n\t\t\t50%, the scheduler might stop two existing tasks to free up cluster capacity before\n\t\t\tstarting two new tasks. If they're in the RUNNING state, tasks for services\n\t\t\tthat don't use a load balancer are considered healthy . If they're in the\n\t\t\t\tRUNNING state and reported as healthy by the load balancer, tasks for\n\t\t\tservices that do use a load balancer are considered healthy . The\n\t\t\tdefault value for minimum healthy percent is 100%.

\n

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of the desired number of tasks (rounded down to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can define the deployment batch size. For example, if your service has a\n\t\t\tdesired number of four tasks and a maximum percent value of 200%, the scheduler may\n\t\t\tstart four new tasks before stopping the four older tasks (provided that the cluster\n\t\t\tresources required to do this are available). The default value for maximum percent is\n\t\t\t200%.

\n

If a service uses either the CODE_DEPLOY or EXTERNAL\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING state.\n\t\t\tThis is while the container instances are in the DRAINING state. If the\n\t\t\ttasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're\n\t\t\tcurrently visible when describing your service.

\n

When creating a service that uses the EXTERNAL deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

\n

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.

\n \n

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.

\n \n

In addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

\n

Tasks for services that don't use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING state. Tasks for services that use a load balancer are\n\t\t\tconsidered healthy if they're in the RUNNING state and are reported as\n\t\t\thealthy by the load balancer.

\n

There are two service scheduler strategies available:

\n \n

You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis initiated by changing properties. For example, the deployment might be initiated by\n\t\t\tthe task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for\n\t\t\t\tminimumHealthyPercent is 100%. The default value for a daemon service\n\t\t\tfor minimumHealthyPercent is 0%.

\n

If a service uses the ECS deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of your desired number of tasks (rounded up to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can deploy without using additional cluster capacity. For example, if you\n\t\t\tset your service to have desired number of four tasks and a minimum healthy percent of\n\t\t\t50%, the scheduler might stop two existing tasks to free up cluster capacity before\n\t\t\tstarting two new tasks. If they're in the RUNNING state, tasks for services\n\t\t\tthat don't use a load balancer are considered healthy . If they're in the\n\t\t\t\tRUNNING state and reported as healthy by the load balancer, tasks for\n\t\t\tservices that do use a load balancer are considered healthy . The\n\t\t\tdefault value for minimum healthy percent is 100%.

\n

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of the desired number of tasks (rounded down to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can define the deployment batch size. For example, if your service has a\n\t\t\tdesired number of four tasks and a maximum percent value of 200%, the scheduler may\n\t\t\tstart four new tasks before stopping the four older tasks (provided that the cluster\n\t\t\tresources required to do this are available). The default value for maximum percent is\n\t\t\t200%.

\n

If a service uses either the CODE_DEPLOY or EXTERNAL\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING state.\n\t\t\tThis is while the container instances are in the DRAINING state. If the\n\t\t\ttasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're\n\t\t\tcurrently visible when describing your service.

\n

When creating a service that uses the EXTERNAL deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

\n

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.

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

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:::user/principalName" + } + } + } + ] } }, "com.amazonaws.ecs#DeleteAccountSettingRequest": { @@ -3575,7 +3627,27 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified cluster. The cluster transitions to the INACTIVE\n\t\t\tstate. Clusters with an INACTIVE status might remain discoverable in your\n\t\t\taccount for a period of time. However, this behavior is subject to change in the future.\n\t\t\tWe don't recommend that you rely on INACTIVE clusters persisting.

\n

You must deregister all container instances from this cluster before you may delete\n\t\t\tit. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

" + "smithy.api#documentation": "

Deletes the specified cluster. The cluster transitions to the INACTIVE\n\t\t\tstate. Clusters with an INACTIVE status might remain discoverable in your\n\t\t\taccount for a period of time. However, this behavior is subject to change in the future.\n\t\t\tWe don't recommend that you rely on INACTIVE clusters persisting.

\n

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.

\n \n

When you delete a service, if there are still running tasks that require cleanup,\n\t\t\t\tthe service status moves from ACTIVE to DRAINING, and the\n\t\t\t\tservice is no longer visible in the console or in the ListServices\n\t\t\t\tAPI operation. After all tasks have transitioned to either STOPPING or\n\t\t\t\t\tSTOPPED status, the service status moves from DRAINING\n\t\t\t\tto INACTIVE. Services in the DRAINING or\n\t\t\t\t\tINACTIVE status can still be viewed with the DescribeServices API operation. However, in the future,\n\t\t\t\t\tINACTIVE services may be cleaned up and purged from Amazon ECS record\n\t\t\t\tkeeping, and DescribeServices calls on those services return a\n\t\t\t\t\tServiceNotFoundException error.

\n \n \n

If you attempt to create a new service with the same name as an existing service\n\t\t\t\tin either ACTIVE or DRAINING status, you receive an\n\t\t\t\terror.

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

Deletes a specified service within a cluster. You can delete a service if you have no\n\t\t\trunning tasks in it and the desired task count is zero. If the service is actively\n\t\t\tmaintaining tasks, you can't delete it, and you must update the service to a desired\n\t\t\ttask count of zero. For more information, see UpdateService.

\n \n

When you delete a service, if there are still running tasks that require cleanup,\n\t\t\t\tthe service status moves from ACTIVE to DRAINING, and the\n\t\t\t\tservice is no longer visible in the console or in the ListServices\n\t\t\t\tAPI operation. After all tasks have transitioned to either STOPPING or\n\t\t\t\t\tSTOPPED status, the service status moves from DRAINING\n\t\t\t\tto INACTIVE. Services in the DRAINING or\n\t\t\t\t\tINACTIVE status can still be viewed with the DescribeServices API operation. However, in the future,\n\t\t\t\t\tINACTIVE services may be cleaned up and purged from Amazon ECS record\n\t\t\t\tkeeping, and DescribeServices calls on those services return a\n\t\t\t\t\tServiceNotFoundException error.

\n \n \n

If you attempt to create a new service with the same name as an existing service\n\t\t\t\tin either ACTIVE or DRAINING status, you receive an\n\t\t\t\terror.

\n ", + "smithy.api#examples": [ + { + "title": "To delete a service", + "documentation": "This example deletes the my-http-service service. The service must have a desired count and running count of 0 before you can delete it.", + "input": { + "service": "my-http-service" + }, + "output": {} + } + ] } }, "com.amazonaws.ecs#DeleteServiceRequest": { @@ -4000,7 +4082,7 @@ } }, "traits": { - "smithy.api#documentation": "\n

The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type.

\n \n

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": "\n

The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type.

\n \n

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.

\n

For 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.

\n

If you intend to use the container instance for some other purpose after\n\t\t\tderegistration, we recommend that you stop all of the tasks running on the container\n\t\t\tinstance before deregistration. That prevents any orphaned tasks from consuming\n\t\t\tresources.

\n

Deregistering a container instance removes the instance from a cluster, but it doesn't\n\t\t\tterminate the EC2 instance. If you are finished using the instance, be sure to terminate\n\t\t\tit in the Amazon EC2 console to stop billing.

\n \n

If you terminate a running container instance, Amazon ECS automatically deregisters the\n\t\t\t\tinstance from your cluster (stopped container instances or instances with\n\t\t\t\tdisconnected agents aren't automatically deregistered when terminated).

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

Deregisters an Amazon ECS container instance from the specified cluster. This instance is\n\t\t\tno longer available to run tasks.

\n

If you intend to use the container instance for some other purpose after\n\t\t\tderegistration, we recommend that you stop all of the tasks running on the container\n\t\t\tinstance before deregistration. That prevents any orphaned tasks from consuming\n\t\t\tresources.

\n

Deregistering a container instance removes the instance from a cluster, but it doesn't\n\t\t\tterminate the EC2 instance. If you are finished using the instance, be sure to terminate\n\t\t\tit in the Amazon EC2 console to stop billing.

\n \n

If you terminate a running container instance, Amazon ECS automatically deregisters the\n\t\t\t\tinstance from your cluster (stopped container instances or instances with\n\t\t\t\tdisconnected agents aren't automatically deregistered when terminated).

\n ", + "smithy.api#examples": [ + { + "title": "To deregister a container instance from a cluster", + "documentation": "This example deregisters a container instance from the specified cluster in your default region. If there are still tasks running on the container instance, you must either stop those tasks before deregistering, or use the force option.", + "input": { + "cluster": "default", + "force": true, + "containerInstance": "container_instance_UUID" + }, + "output": {} + } + ] } }, "com.amazonaws.ecs#DeregisterContainerInstanceRequest": { @@ -4322,7 +4416,28 @@ } ], "traits": { - "smithy.api#documentation": "

Describes 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.

\n \n

You can only describe INACTIVE task definitions while an active task\n\t\t\t\tor service references them.

\n " + "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.

\n \n

You can only describe INACTIVE task definitions while an active task\n\t\t\t\tor service references them.

\n ", + "smithy.api#examples": [ + { + "title": "To describe a task definition", + "documentation": "This example provides a description of the specified task definition.", + "input": { + "taskDefinition": "hello_world:8" + }, + "output": { + "taskDefinition": { + "family": "hello_world", + "taskDefinitionArn": "arn:aws:ecs:us-east-1::task-definition/hello_world:8", + "containerDefinitions": [ + { + "mountPoints": [], + "name": "wordpress", + "links": [ + "mysql" + ], + "image": "wordpress", + "cpu": 10, + "environment": [], + "memory": 500, + "portMappings": [ + { + "containerPort": 80, + "hostPort": 80 + } + ], + "essential": true, + "volumesFrom": [] + }, + { + "mountPoints": [], + "name": "mysql", + "image": "mysql", + "cpu": 10, + "environment": [ + { + "name": "MYSQL_ROOT_PASSWORD", + "value": "password" + } + ], + "memory": 500, + "portMappings": [], + "volumesFrom": [], + "essential": true + } + ], + "volumes": [], + "revision": 8 + } + } + } + ] } }, "com.amazonaws.ecs#DescribeTaskDefinitionRequest": { @@ -4762,7 +5066,54 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a specified task or tasks.

\n

Currently, stopped tasks appear in the returned results for at least one hour.

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

Describes a specified task or tasks.

\n

Currently, stopped tasks appear in the returned results for at least one hour.

\n

If 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:::task/c5cba4eb-5dad-405e-96db-71ef8eefe6a8", + "overrides": { + "containerOverrides": [ + { + "name": "ecs-demo" + } + ] + }, + "lastStatus": "RUNNING", + "containerInstanceArn": "arn:aws:ecs:::container-instance/18f9eda5-27d7-4c19-b133-45adc516e8fb", + "clusterArn": "arn:aws:ecs:::cluster/default", + "desiredStatus": "RUNNING", + "taskDefinitionArn": "arn:aws:ecs:::task-definition/amazon-ecs-sample:1", + "startedBy": "ecs-svc/9223370608528463088", + "containers": [ + { + "containerArn": "arn:aws:ecs:::container/7c01765b-c588-45b3-8290-4ba38bd6c5a6", + "taskArn": "arn:aws:ecs:::task/c5cba4eb-5dad-405e-96db-71ef8eefe6a8", + "lastStatus": "RUNNING", + "name": "ecs-demo", + "networkBindings": [ + { + "bindIP": "0.0.0.0", + "containerPort": 80, + "hostPort": 80 + } + ] + } + ] + } + ] + } + } + ], "smithy.waiters#waitable": { "TasksRunning": { "acceptors": [ @@ -5180,7 +5531,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of files containing the environment variables to pass to a container. You can\n\t\t\tspecify up to ten environment files. The file must have a .env file\n\t\t\textension. Each line in an environment file should contain an environment variable in\n\t\t\t\tVARIABLE=VALUE format. Lines beginning with # are treated\n\t\t\tas comments and are ignored. For more information about the environment variable file\n\t\t\tsyntax, see Declare default\n\t\t\t\tenvironment variables in file.

\n

If there are environment variables specified using the environment\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they're processed from the top down. We recommend that you use unique\n\t\t\tvariable names. For more information, see Specifying environment\n\t\t\t\tvariables in the Amazon Elastic Container Service Developer Guide.

\n

This parameter is only supported for tasks hosted on Fargate using the\n\t\t\tfollowing platform versions:

\n
    \n
  • \n

    Linux platform version 1.4.0 or later.

    \n
    • \n
  • \n

    Windows platform version 1.0.0 or later.

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

A list of files containing the environment variables to pass to a container. You can\n\t\t\tspecify up to ten environment files. The file must have a .env file\n\t\t\textension. Each line in an environment file should contain an environment variable in\n\t\t\t\tVARIABLE=VALUE format. Lines beginning with # are treated\n\t\t\tas comments and are ignored. For more information about the environment variable file\n\t\t\tsyntax, see Declare default\n\t\t\t\tenvironment variables in file.

\n

If there are environment variables specified using the environment\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they're processed from the top down. We recommend that you use unique\n\t\t\tvariable names. For more information, see Specifying environment\n\t\t\t\tvariables in the Amazon Elastic Container Service Developer Guide.

\n

You must use the following platforms for the Fargate launch type:

\n
    \n
  • \n

    Linux platform version 1.4.0 or later.

    \n
    • \n
  • \n

    Windows platform version 1.0.0 or later.

    \n
    • \n
" } }, "com.amazonaws.ecs#EnvironmentFileType": { @@ -5592,7 +5943,29 @@ } ], "traits": { - "smithy.api#documentation": "

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:::user/principalName" + }, + { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam:::user/principalName" + }, + { + "name": "taskLongArnFormat", + "value": "disabled", + "principalArn": "arn:aws:iam:::user/principalName" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -6251,6 +6652,18 @@ ], "traits": { "smithy.api#documentation": "

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::cluster/test", + "arn:aws:ecs:us-east-1::cluster/default" + ] + } + } + ], "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -6323,6 +6736,21 @@ ], "traits": { "smithy.api#documentation": "

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.

", + "smithy.api#examples": [ + { + "title": "To list your available container instances in a cluster", + "documentation": "This example lists all of your available container instances in the specified cluster in your default region.", + "input": { + "cluster": "default" + }, + "output": { + "containerInstanceArns": [ + "arn:aws:ecs:us-east-1::container-instance/f6bbb147-5370-4ace-8c73-c7181ded911f", + "arn:aws:ecs:us-east-1::container-instance/ffe3d344-77e2-476c-a4d0-bf560ad50acb" + ] + } + } + ], "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -6413,6 +6841,17 @@ ], "traits": { "smithy.api#documentation": "

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.

\n

You can filter out task definition families that don't contain any ACTIVE\n\t\t\ttask definition revisions by setting the status parameter to\n\t\t\t\tACTIVE. You can also filter the results with the\n\t\t\t\tfamilyPrefix parameter.

", + "smithy.api#examples": [ + { + "title": "To list your registered task definition families", + "documentation": "This example lists all of your registered task definition families.", + "output": { + "families": [ + "node-js-app", + "web-timer", + "hpcc", + "hpcc-c4-8xlarge" + ] + } + } + ], "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -6715,6 +7185,22 @@ ], "traits": { "smithy.api#documentation": "

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.

", + "smithy.api#examples": [ + { + "title": "To list your registered task definitions", + "documentation": "This example lists all of your registered task definitions.", + "output": { + "taskDefinitionArns": [ + "arn:aws:ecs:us-east-1::task-definition/sleep300:2", + "arn:aws:ecs:us-east-1::task-definition/sleep360:1", + "arn:aws:ecs:us-east-1::task-definition/wordpress:3", + "arn:aws:ecs:us-east-1::task-definition/wordpress:4", + "arn:aws:ecs:us-east-1::task-definition/wordpress:5", + "arn:aws:ecs:us-east-1::task-definition/wordpress:6" + ] + } + } + ], "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -6807,7 +7293,22 @@ } ], "traits": { - "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.

\n

Recently 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.

\n

Recently 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.

\n

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a\n\t\t\tClassic Load Balancer, omit the target group ARN.

\n

For services using the ECS deployment controller, you can specify one or\n\t\t\tmultiple target groups. For more information, see Registering multiple target groups with a service in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.

\n

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.

\n \n

If your service's task definition uses the awsvpc network mode, you\n\t\t\t\tmust choose ip as the target type, not instance. Do this\n\t\t\t\twhen creating your target groups because tasks that use the awsvpc\n\t\t\t\tnetwork mode are associated with an elastic network interface, not an Amazon EC2\n\t\t\t\tinstance. This network mode is required for the Fargate launch\n\t\t\t\ttype.

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

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or\n\t\t\ttask set.

\n

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.

\n

For services using the ECS deployment controller, you can specify one or\n\t\t\tmultiple target groups. For more information, see Registering multiple target groups with a service in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.

\n

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.

\n \n

If your service's task definition uses the awsvpc network mode, you\n\t\t\t\tmust choose ip as the target type, not instance. Do this\n\t\t\t\twhen creating your target groups because tasks that use the awsvpc\n\t\t\t\tnetwork mode are associated with an elastic network interface, not an Amazon EC2\n\t\t\t\tinstance. This network mode is required for the Fargate launch\n\t\t\t\ttype.

\n " } }, "loadBalancerName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the load balancer to associate with the Amazon ECS service or task set.

\n

A 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.

\n

If 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 .

\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.

\n

Understand the following when specifying a log configuration for your\n\t\t\tcontainers.

\n
    \n
  • \n

    Amazon 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.

    \n
    • \n
  • \n

    This parameter requires version 1.18 of the Docker Remote API or greater on\n\t\t\t\t\tyour container instance.

    \n
    • \n
  • \n

    For 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.

    \n
    • \n
  • \n

    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.

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

The log configuration for the container. This parameter maps to LogConfig\n\t\t\tin the Create a container section of the Docker Remote API and the\n\t\t\t\t--log-driver option to \n docker\n\t\t\t\t\trun\n .

\n

By default, containers use the same logging driver that the Docker daemon uses.\n\t\t\tHowever, the container might use a different logging driver than the Docker daemon by\n\t\t\tspecifying a log driver configuration in the container definition. For more information\n\t\t\tabout the options for different supported log drivers, see Configure logging\n\t\t\t\tdrivers in the Docker documentation.

\n

Understand the following when specifying a log configuration for your\n\t\t\tcontainers.

\n
    \n
  • \n

    Amazon 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.

    \n

    For tasks on Fargate, the supported log drivers are awslogs,\n\t\t\t\t\t\tsplunk, and awsfirelens.

    \n

    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.

    \n
    • \n
  • \n

    This parameter requires version 1.18 of the Docker Remote API or greater on\n\t\t\t\t\tyour container instance.

    \n
    • \n
  • \n

    For 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.

    \n
    • \n
  • \n

    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.

    \n
    • \n
" } }, "com.amazonaws.ecs#LogConfigurationOptionsMap": { @@ -7145,7 +7646,7 @@ "maximumScalingStepSize": { "target": "com.amazonaws.ecs#ManagedScalingStepSize", "traits": { - "smithy.api#documentation": "

The 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.

" + "smithy.api#documentation": "

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.

" } }, "instanceWarmupPeriod": { @@ -7650,7 +8151,7 @@ "hostPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The port number on the container instance to reserve for your container.

\n

If you specify a containerPortRange, leave this field empty and the value of\n\t\t\tthe hostPort is set as follows:

\n
    \n
  • \n

    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.

    \n
    • \n
  • \n

    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.

    \n
    • \n
\n

If you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, the hostPort can either be left blank or set to the same\n\t\t\tvalue as the containerPort.

\n

If you use containers in a task with the bridge network mode, you can\n\t\t\tspecify a non-reserved host port for your container port mapping, or you can omit the\n\t\t\t\thostPort (or set it to 0) while specifying a\n\t\t\t\tcontainerPort and your container automatically receives a port in the\n\t\t\tephemeral port range for your container instance operating system and Docker\n\t\t\tversion.

\n

The default ephemeral port range for Docker version 1.6.0 and later is listed on the\n\t\t\tinstance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel\n\t\t\tparameter is unavailable, the default ephemeral port range from 49153 through 65535 is\n\t\t\tused. Do not attempt to specify a host port in the ephemeral port range as these are\n\t\t\treserved for automatic assignment. In general, ports below 32768 are outside of the\n\t\t\tephemeral port range.

\n

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.

" + "smithy.api#documentation": "

The port number on the container instance to reserve for your container.

\n

If you specify a containerPortRange, leave this field empty and the value of\n\t\t\tthe hostPort is set as follows:

\n
    \n
  • \n

    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.

    \n
    • \n
  • \n

    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.

    \n
    • \n
\n

If you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, the hostPort can either be left blank or set to the same\n\t\t\tvalue as the containerPort.

\n

If you use containers in a task with the bridge network mode, you can\n\t\t\tspecify a non-reserved host port for your container port mapping, or you can omit the\n\t\t\t\thostPort (or set it to 0) while specifying a\n\t\t\t\tcontainerPort and your container automatically receives a port in the\n\t\t\tephemeral port range for your container instance operating system and Docker\n\t\t\tversion.

\n

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.

\n

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.

" } }, "protocol": { @@ -7817,7 +8318,24 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies an account setting. Account settings are set on a per-Region basis.

\n

If 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.

\n

When serviceLongArnFormat, taskLongArnFormat, or\n\t\t\t\tcontainerInstanceLongArnFormat are specified, the Amazon Resource Name\n\t\t\t(ARN) and resource ID format of the resource type for a specified 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.

\n

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.

\n

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.

\n

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.

" + "smithy.api#documentation": "

Modifies an account setting. Account settings are set on a per-Region basis.

\n

If 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.

\n

When serviceLongArnFormat, taskLongArnFormat, or\n\t\t\t\tcontainerInstanceLongArnFormat are specified, the Amazon Resource Name\n\t\t\t(ARN) and resource ID format of the resource type for a specified 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.

\n

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.

\n

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.

\n

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.

", + "smithy.api#examples": [ + { + "title": "To modify your account settings", + "documentation": "This example modifies your account settings to opt in to the new ARN and resource ID format for Amazon ECS services. If you’re using this command as the root user, then 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:::user/principalName" + } + } + } + ] } }, "com.amazonaws.ecs#PutAccountSettingDefault": { @@ -7840,7 +8358,24 @@ } ], "traits": { - "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#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:::root" + } + } + } + ] } }, "com.amazonaws.ecs#PutAccountSettingDefaultRequest": { @@ -8176,7 +8711,56 @@ } ], "traits": { - "smithy.api#documentation": "

Registers a new task definition from the supplied family and\n\t\t\t\tcontainerDefinitions. Optionally, you can add data volumes to your\n\t\t\tcontainers with the volumes parameter. For more information about task\n\t\t\tdefinition parameters and defaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.

\n

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.

\n

You can specify a Docker networking mode for the containers in your task definition\n\t\t\twith the networkMode parameter. The available network modes correspond to\n\t\t\tthose described in Network\n\t\t\t\tsettings in the Docker run reference. If you specify the awsvpc\n\t\t\tnetwork mode, the task is allocated an elastic network interface, and you must specify a\n\t\t\t\tNetworkConfiguration when you create a service or run a task with\n\t\t\tthe task definition. For more information, see Task Networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Registers a new task definition from the supplied family and\n\t\t\t\tcontainerDefinitions. Optionally, you can add data volumes to your\n\t\t\tcontainers with the volumes parameter. For more information about task\n\t\t\tdefinition parameters and defaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.

\n

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.

\n

You can specify a Docker networking mode for the containers in your task definition\n\t\t\twith the networkMode parameter. The available network modes correspond to\n\t\t\tthose described in Network\n\t\t\t\tsettings in the Docker run reference. If you specify the awsvpc\n\t\t\tnetwork mode, the task is allocated an elastic network interface, and you must specify a\n\t\t\t\tNetworkConfiguration when you create a service or run a task with\n\t\t\tthe task definition. For more information, see Task Networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

", + "smithy.api#examples": [ + { + "title": "To register a task definition", + "documentation": "This example registers a task definition to the specified family.", + "input": { + "family": "sleep360", + "taskRoleArn": "", + "containerDefinitions": [ + { + "name": "sleep", + "image": "busybox", + "cpu": 10, + "command": [ + "sleep", + "360" + ], + "memory": 10, + "essential": true + } + ], + "volumes": [] + }, + "output": { + "taskDefinition": { + "volumes": [], + "taskDefinitionArn": "arn:aws:ecs:us-east-1::task-definition/sleep360:19", + "containerDefinitions": [ + { + "environment": [], + "name": "sleep", + "mountPoints": [], + "image": "busybox", + "cpu": 10, + "portMappings": [], + "command": [ + "sleep", + "360" + ], + "memory": 10, + "essential": true, + "volumesFrom": [] + } + ], + "family": "sleep360", + "revision": 1 + } + } + } + ] } }, "com.amazonaws.ecs#RegisterTaskDefinitionRequest": { @@ -8492,7 +9076,43 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a new task using the specified task definition.

\n

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the Amazon Elastic Container Service Developer Guide.

\n

Alternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.

\n \n

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.

\n \n

The 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.

\n

To manage eventual consistency, you can do the following:

\n
    \n
  • \n

    Confirm 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.

    \n
    • \n
  • \n

    Add 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.

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

Starts a new task using the specified task definition.

\n

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the Amazon Elastic Container Service Developer Guide.

\n

Alternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.

\n \n

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.

\n \n

The 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.

\n

To manage eventual consistency, you can do the following:

\n
    \n
  • \n

    Confirm 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.

    \n
    • \n
  • \n

    Add 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.

    \n
    • \n
", + "smithy.api#examples": [ + { + "title": "To run a task on your default cluster", + "documentation": "This example runs the specified task definition on your default cluster.", + "input": { + "cluster": "default", + "taskDefinition": "sleep360:1" + }, + "output": { + "tasks": [ + { + "taskArn": "arn:aws:ecs:us-east-1::task/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0", + "overrides": { + "containerOverrides": [ + { + "name": "sleep" + } + ] + }, + "lastStatus": "PENDING", + "containerInstanceArn": "arn:aws:ecs:us-east-1::container-instance/ffe3d344-77e2-476c-a4d0-bf560ad50acb", + "desiredStatus": "RUNNING", + "taskDefinitionArn": "arn:aws:ecs:us-east-1::task-definition/sleep360:1", + "containers": [ + { + "containerArn": "arn:aws:ecs:us-east-1::container/58591c8e-be29-4ddf-95aa-ee459d4c59fd", + "taskArn": "arn:aws:ecs:us-east-1::task/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0", + "lastStatus": "PENDING", + "name": "sleep" + } + ] + } + ] + } + } + ] } }, "com.amazonaws.ecs#RunTaskRequest": { @@ -9909,7 +10529,23 @@ } ], "traits": { - "smithy.api#documentation": "

Associates the specified tags to a resource with the specified\n\t\t\t\tresourceArn. If existing tags on a resource 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.

" + "smithy.api#documentation": "

Associates the specified tags to a resource with the specified\n\t\t\t\tresourceArn. If existing tags on a resource aren't specified in the\n\t\t\trequest parameters, they aren't changed. When a resource is deleted, the tags that are\n\t\t\tassociated with that resource are deleted as well.

", + "smithy.api#examples": [ + { + "title": "To tag a cluster.", + "documentation": "This example tags the 'dev' cluster with key 'team' and value 'dev'.", + "input": { + "resourceArn": "arn:aws:ecs:region:aws_account_id:cluster/dev", + "tags": [ + { + "key": "team", + "value": "dev" + } + ] + }, + "output": {} + } + ] } }, "com.amazonaws.ecs#TagResourceRequest": { @@ -10167,7 +10803,7 @@ "stopCode": { "target": "com.amazonaws.ecs#TaskStopCode", "traits": { - "smithy.api#documentation": "

The stop code indicating why a task was stopped. The stoppedReason might\n\t\t\tcontain additional details.

\n

The following are valid values:

\n
    \n
  • \n

    \n TaskFailedToStart\n

    \n
    • \n
  • \n

    \n EssentialContainerExited\n

    \n
    • \n
  • \n

    \n UserInitiated\n

    \n
    • \n
  • \n

    \n TerminationNotice\n

    \n
    • \n
  • \n

    \n ServiceSchedulerInitiated\n

    \n
    • \n
  • \n

    \n SpotInterruption\n

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

The stop code indicating why a task was stopped. The stoppedReason might\n\t\t\tcontain additional details.

\n

For more information about stop code, see Stopped tasks error codes in the Amazon ECS User Guide.

\n

The following are valid values:

\n
    \n
  • \n

    \n TaskFailedToStart\n

    \n
    • \n
  • \n

    \n EssentialContainerExited\n

    \n
    • \n
  • \n

    \n UserInitiated\n

    \n
    • \n
  • \n

    \n TerminationNotice\n

    \n
    • \n
  • \n

    \n ServiceSchedulerInitiated\n

    \n
    • \n
  • \n

    \n SpotInterruption\n

    \n
    • \n
" } }, "stoppedAt": { @@ -10185,7 +10821,7 @@ "stoppingAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for the time when the task stops. More specifically, it's for the\n\t\t\ttime when the task transitions from the RUNNING state to\n\t\t\t\tSTOPPED.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the task stops. More specifically, it's for the\n\t\t\ttime when the task transitions from the RUNNING state to\n\t\t\t\tSTOPPING.

" } }, "tags": { @@ -10309,7 +10945,7 @@ "requiresCompatibilities": { "target": "com.amazonaws.ecs#CompatibilityList", "traits": { - "smithy.api#documentation": "

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.

" } }, "cpu": { @@ -11012,7 +11648,20 @@ } ], "traits": { - "smithy.api#documentation": "

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.

\n

For 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.

\n

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.

\n

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.

\n

You can add to or subtract from the number of instantiations of a task definition in a\n\t\t\tservice by specifying the cluster that the service is running in and a new\n\t\t\t\tdesiredCount parameter.

\n

If you have updated the Docker image of your application, you can create a new task\n\t\t\tdefinition with that image and deploy it to your service. The service scheduler uses the\n\t\t\tminimum healthy percent and maximum percent parameters (in the service's deployment\n\t\t\tconfiguration) to determine the deployment strategy.

\n \n

If your updated Docker image uses the same tag as what is in the existing task\n\t\t\t\tdefinition for your service (for example, my_image:latest), you don't\n\t\t\t\tneed to create a new revision of your task definition. You can update the service\n\t\t\t\tusing the forceNewDeployment option. The new tasks launched by the\n\t\t\t\tdeployment pull the current image/tag combination from your repository when they\n\t\t\t\tstart.

\n \n

You can also update the deployment configuration of a service. When a deployment is\n\t\t\ttriggered by updating the task definition of a service, the service scheduler uses the\n\t\t\tdeployment configuration parameters, minimumHealthyPercent and\n\t\t\t\tmaximumPercent, to determine the deployment strategy.

\n
    \n
  • \n

    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.

    \n
    • \n
  • \n

    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).

    \n
    • \n
\n

When UpdateService stops a task during a deployment, the equivalent\n\t\t\tof docker stop is issued to the containers running in the task. This\n\t\t\tresults in a SIGTERM and a 30-second timeout. After this,\n\t\t\t\tSIGKILL is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM gracefully and exits within 30 seconds from\n\t\t\treceiving it, no SIGKILL is sent.

\n

When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster with the following logic.

\n
    \n
  • \n

    Determine 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.

    \n
    • \n
  • \n

    By 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.

    \n
      \n
    • \n

      Sort 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.

      \n
      • \n
    • \n

      Place 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.

      \n
      • \n
    \n
    • \n
\n

When the service scheduler stops running tasks, it attempts to maintain balance across\n\t\t\tthe Availability Zones in your cluster using the following logic:

\n
    \n
  • \n

    Sort 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.

    \n
    • \n
  • \n

    Stop 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.

    \n
    • \n
\n \n

You 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
  • \n

    \n loadBalancers,\n

    \n
    • \n
  • \n

    \n serviceRegistries\n

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

Modifies the parameters of a service.

\n

For 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.

\n

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.

\n

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.

\n

You can add to or subtract from the number of instantiations of a task definition in a\n\t\t\tservice by specifying the cluster that the service is running in and a new\n\t\t\t\tdesiredCount parameter.

\n

If you have updated the Docker image of your application, you can create a new task\n\t\t\tdefinition with that image and deploy it to your service. The service scheduler uses the\n\t\t\tminimum healthy percent and maximum percent parameters (in the service's deployment\n\t\t\tconfiguration) to determine the deployment strategy.

\n \n

If your updated Docker image uses the same tag as what is in the existing task\n\t\t\t\tdefinition for your service (for example, my_image:latest), you don't\n\t\t\t\tneed to create a new revision of your task definition. You can update the service\n\t\t\t\tusing the forceNewDeployment option. The new tasks launched by the\n\t\t\t\tdeployment pull the current image/tag combination from your repository when they\n\t\t\t\tstart.

\n \n

You can also update the deployment configuration of a service. When a deployment is\n\t\t\ttriggered by updating the task definition of a service, the service scheduler uses the\n\t\t\tdeployment configuration parameters, minimumHealthyPercent and\n\t\t\t\tmaximumPercent, to determine the deployment strategy.

\n
    \n
  • \n

    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.

    \n
    • \n
  • \n

    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).

    \n
    • \n
\n

When UpdateService stops a task during a deployment, the equivalent\n\t\t\tof docker stop is issued to the containers running in the task. This\n\t\t\tresults in a SIGTERM and a 30-second timeout. After this,\n\t\t\t\tSIGKILL is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM gracefully and exits within 30 seconds from\n\t\t\treceiving it, no SIGKILL is sent.

\n

When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster with the following logic.

\n
    \n
  • \n

    Determine 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.

    \n
    • \n
  • \n

    By 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.

    \n
      \n
    • \n

      Sort 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.

      \n
      • \n
    • \n

      Place 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.

      \n
      • \n
    \n
    • \n
\n

When the service scheduler stops running tasks, it attempts to maintain balance across\n\t\t\tthe Availability Zones in your cluster using the following logic:

\n
    \n
  • \n

    Sort 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.

    \n
    • \n
  • \n

    Stop 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.

    \n
    • \n
\n \n

You must have a service-linked role when you update any of the following service\n\t\t\t\tproperties:

\n
    \n
  • \n

    \n loadBalancers,

    \n
    • \n
  • \n

    \n serviceRegistries\n

    \n
    • \n
\n

For more information about the role see the CreateService request parameter\n\t\t\t\t\n role\n .

\n ", + "smithy.api#examples": [ + { + "title": "To change the task definition used in a service", + "documentation": "This example updates the my-http-service service to use the amazon-ecs-sample task definition.", + "input": { + "service": "my-http-service", + "taskDefinition": "amazon-ecs-sample" + }, + "output": {} + } + ] } }, "com.amazonaws.ecs#UpdateServicePrimaryTaskSet": { @@ -11689,7 +12349,31 @@ } ], "traits": { - "smithy.api#documentation": "

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.

\n

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.

\n

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.

\n

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 .

\n \n

This 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.

\n \n \n

If you prefer to set task protection from within the container, we recommend using\n\t\t\t\tthe Task scale-in protection endpoint.

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

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.

\n

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.

\n

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.

\n

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 .

\n \n

This 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.

\n \n \n

If you prefer to set task protection from within the container, we recommend using\n\t\t\t\tthe Task scale-in protection endpoint.

\n ", + "smithy.api#examples": [ + { + "title": "To set task scale-in protection for a task for 60 minutes", + "documentation": "This example enables scale-in protection for a task for 60 minutes.", + "input": { + "cluster": "test-task-protection", + "tasks": [ + "b8b1cf532d0e46ba8d44a40d1de16772" + ], + "protectionEnabled": true, + "expiresInMinutes": 60 + }, + "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#UpdateTaskProtectionRequest": { @@ -11871,7 +12555,7 @@ "name": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

\n

This is required wwhen you use an Amazon EFS volume.

" } }, "host": { diff --git a/codegen/sdk/aws-models/eks.json b/codegen/sdk/aws-models/eks.json index ecdcae8a33fc..e6afaa5ddf1b 100644 --- a/codegen/sdk/aws-models/eks.json +++ b/codegen/sdk/aws-models/eks.json @@ -1705,6 +1705,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#AssociateEncryptionConfigResponse": { @@ -1713,6 +1716,9 @@ "update": { "target": "com.amazonaws.eks#Update" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#AssociateIdentityProviderConfig": { @@ -1783,6 +1789,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#AssociateIdentityProviderConfigResponse": { @@ -1797,6 +1806,9 @@ "smithy.api#documentation": "

The tags for the resource.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#AutoScalingGroup": { @@ -2449,6 +2461,9 @@ "smithy.api#documentation": "

The set of configuration values for the add-on that's created. The values that you\n provide are validated against the schema in \n DescribeAddonConfiguration\n .

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#CreateAddonResponse": { @@ -2457,6 +2472,9 @@ "addon": { "target": "com.amazonaws.eks#Addon" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#CreateCluster": { @@ -2566,6 +2584,9 @@ "smithy.api#documentation": "

An object representing the configuration of your local Amazon EKS cluster on\n an Amazon Web Services Outpost. Before creating a local cluster on an Outpost, review\n Local clusters\n for Amazon EKS on Amazon Web Services Outposts in the\n Amazon EKS User Guide. This object isn't available for creating Amazon EKS clusters\n on the Amazon Web Services cloud.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#CreateClusterResponse": { @@ -2577,6 +2598,9 @@ "smithy.api#documentation": "

The full description of your new cluster.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#CreateFargateProfile": { @@ -2666,6 +2690,9 @@ "smithy.api#documentation": "

The metadata to apply to the Fargate profile to assist with\n categorization and organization. Each tag consists of a key and an optional value. You\n define both. Fargate profile tags do not propagate to any other resources\n associated with the Fargate profile, such as the pods that are scheduled\n with it.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#CreateFargateProfileResponse": { @@ -2677,6 +2704,9 @@ "smithy.api#documentation": "

The full description of your new Fargate profile.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#CreateNodegroup": { @@ -2836,6 +2866,9 @@ "smithy.api#documentation": "

The AMI version of the Amazon EKS optimized AMI to use with your node group.\n By default, the latest available AMI version for the node group's current Kubernetes version\n is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the\n Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the\n Amazon EKS User Guide.

\n

If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify \n releaseVersion, or the node group deployment will fail.\n For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#CreateNodegroupResponse": { @@ -2847,6 +2880,9 @@ "smithy.api#documentation": "

The full description of your new node group.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#DeleteAddon": { @@ -2910,6 +2946,9 @@ "smithy.api#httpQuery": "preserve" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#DeleteAddonResponse": { @@ -2918,6 +2957,9 @@ "addon": { "target": "com.amazonaws.eks#Addon" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#DeleteCluster": { @@ -2965,6 +3007,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#DeleteClusterResponse": { @@ -2976,6 +3021,9 @@ "smithy.api#documentation": "

The full description of the cluster to delete.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#DeleteFargateProfile": { @@ -3028,6 +3076,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#DeleteFargateProfileResponse": { @@ -3039,6 +3090,9 @@ "smithy.api#documentation": "

The deleted Fargate profile.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#DeleteNodegroup": { @@ -3097,6 +3151,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#DeleteNodegroupResponse": { @@ -3108,6 +3165,9 @@ "smithy.api#documentation": "

The full description of your deleted node group.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#DeregisterCluster": { @@ -3158,6 +3218,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#DeregisterClusterResponse": { @@ -3166,6 +3229,9 @@ "cluster": { "target": "com.amazonaws.eks#Cluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#DescribeAddon": { @@ -3307,6 +3373,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#DescribeAddonConfigurationResponse": { @@ -3330,6 +3399,9 @@ "smithy.api#documentation": "

A JSON schema that's used to validate the configuration values that you provide when\n an addon is created or updated.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#DescribeAddonRequest": { @@ -3351,6 +3423,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#DescribeAddonResponse": { @@ -3359,6 +3434,9 @@ "addon": { "target": "com.amazonaws.eks#Addon" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#DescribeAddonVersions": { @@ -3447,6 +3525,9 @@ "smithy.api#httpQuery": "owners" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#DescribeAddonVersionsRequestMaxResults": { @@ -3473,6 +3554,9 @@ "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n DescribeAddonVersionsResponse where maxResults was used\n and the results exceeded the value of that parameter. Pagination continues from the end\n of the previous results that returned the nextToken value.

\n \n

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

\n " } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#DescribeCluster": { @@ -3595,6 +3679,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#DescribeClusterResponse": { @@ -3606,6 +3693,9 @@ "smithy.api#documentation": "

The full description of your specified cluster.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#DescribeFargateProfile": { @@ -3706,6 +3796,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#DescribeFargateProfileResponse": { @@ -3717,6 +3810,9 @@ "smithy.api#documentation": "

The full description of your Fargate profile.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#DescribeIdentityProviderConfig": { @@ -3771,6 +3867,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#DescribeIdentityProviderConfigResponse": { @@ -3782,6 +3881,9 @@ "smithy.api#documentation": "

The object that represents an OpenID Connect (OIDC) identity provider\n configuration.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#DescribeNodegroup": { @@ -3885,6 +3987,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#DescribeNodegroupResponse": { @@ -3896,6 +4001,9 @@ "smithy.api#documentation": "

The full description of your node group.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#DescribeUpdate": { @@ -3962,6 +4070,9 @@ "smithy.api#httpQuery": "addonName" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#DescribeUpdateResponse": { @@ -3973,6 +4084,9 @@ "smithy.api#documentation": "

The full description of the specified update.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#DisassociateIdentityProviderConfig": { @@ -4037,6 +4151,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#DisassociateIdentityProviderConfigResponse": { @@ -4045,6 +4162,9 @@ "update": { "target": "com.amazonaws.eks#Update" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#EncryptionConfig": { @@ -4669,6 +4789,9 @@ "smithy.api#httpQuery": "nextToken" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#ListAddonsRequestMaxResults": { @@ -4695,6 +4818,9 @@ "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n ListAddonsResponse where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

\n \n

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

\n " } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#ListClusters": { @@ -4758,6 +4884,9 @@ "smithy.api#httpQuery": "include" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#ListClustersRequestMaxResults": { @@ -4784,6 +4913,9 @@ "smithy.api#documentation": "

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

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#ListFargateProfiles": { @@ -4848,6 +4980,9 @@ "smithy.api#httpQuery": "nextToken" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#ListFargateProfilesResponse": { @@ -4865,6 +5000,9 @@ "smithy.api#documentation": "

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

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#ListIdentityProviderConfigs": { @@ -4932,6 +5070,9 @@ "smithy.api#httpQuery": "nextToken" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#ListIdentityProviderConfigsRequestMaxResults": { @@ -4958,6 +5099,9 @@ "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n ListIdentityProviderConfigsResponse where maxResults was\n used and the results exceeded the value of that parameter. Pagination continues from the\n end of the previous results that returned the nextToken value.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#ListNodegroups": { @@ -5025,6 +5169,9 @@ "smithy.api#httpQuery": "nextToken" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#ListNodegroupsRequestMaxResults": { @@ -5051,6 +5198,9 @@ "smithy.api#documentation": "

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

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#ListTagsForResource": { @@ -5089,6 +5239,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#ListTagsForResourceResponse": { @@ -5100,6 +5253,9 @@ "smithy.api#documentation": "

The tags for the resource.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#ListUpdates": { @@ -5178,6 +5334,9 @@ "smithy.api#httpQuery": "maxResults" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#ListUpdatesRequestMaxResults": { @@ -5204,6 +5363,9 @@ "smithy.api#documentation": "

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

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#LogSetup": { @@ -5524,6 +5686,12 @@ "smithy.api#enumValue": "IamInstanceProfileNotFound" } }, + "EC2_SUBNET_MISSING_IPV6_ASSIGNMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2SubnetMissingIpv6Assignment" + } + }, "IAM_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { @@ -5578,10 +5746,88 @@ "smithy.api#enumValue": "ClusterUnreachable" } }, - "EC2_SUBNET_MISSING_IPV6_ASSIGNMENT": { + "AMI_ID_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "Ec2SubnetMissingIpv6Assignment" + "smithy.api#enumValue": "AmiIdNotFound" + } + }, + "AUTO_SCALING_GROUP_OPT_IN_REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoScalingGroupOptInRequired" + } + }, + "AUTO_SCALING_GROUP_RATE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoScalingGroupRateLimitExceeded" + } + }, + "EC2_LAUNCH_TEMPLATE_DELETION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2LaunchTemplateDeletionFailure" + } + }, + "EC2_LAUNCH_TEMPLATE_INVALID_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2LaunchTemplateInvalidConfiguration" + } + }, + "EC2_LAUNCH_TEMPLATE_MAX_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2LaunchTemplateMaxLimitExceeded" + } + }, + "EC2_SUBNET_LIST_TOO_LONG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2SubnetListTooLong" + } + }, + "IAM_THROTTLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IamThrottling" + } + }, + "NODE_TERMINATION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NodeTerminationFailure" + } + }, + "POD_EVICTION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PodEvictionFailure" + } + }, + "SOURCE_EC2_LAUNCH_TEMPLATE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SourceEc2LaunchTemplateNotFound" + } + }, + "LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LimitExceeded" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + }, + "AUTO_SCALING_GROUP_INSTANCE_REFRESH_ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoScalingGroupInstanceRefreshActive" } } } @@ -6025,6 +6271,9 @@ "smithy.api#documentation": "

The metadata that you apply to the cluster to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you\n define. Cluster tags do not propagate to any other resources associated with the\n cluster.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#RegisterClusterResponse": { @@ -6033,6 +6282,9 @@ "cluster": { "target": "com.amazonaws.eks#Cluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#RemoteAccessConfig": { @@ -6316,11 +6568,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#TagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.eks#TagValue": { "type": "string", @@ -6458,11 +6716,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#UntagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.eks#Update": { "type": "structure", @@ -6595,6 +6859,9 @@ "smithy.api#documentation": "

The set of configuration values for the add-on that's created. The values that you\n provide are validated against the schema in DescribeAddonConfiguration.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#UpdateAddonResponse": { @@ -6603,6 +6870,9 @@ "update": { "target": "com.amazonaws.eks#Update" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#UpdateClusterConfig": { @@ -6669,6 +6939,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#UpdateClusterConfigResponse": { @@ -6677,6 +6950,9 @@ "update": { "target": "com.amazonaws.eks#Update" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#UpdateClusterVersion": { @@ -6741,6 +7017,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#UpdateClusterVersionResponse": { @@ -6752,6 +7031,9 @@ "smithy.api#documentation": "

The full description of the specified update

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#UpdateLabelsPayload": { @@ -6861,6 +7143,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#UpdateNodegroupConfigResponse": { @@ -6869,6 +7154,9 @@ "update": { "target": "com.amazonaws.eks#Update" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#UpdateNodegroupVersion": { @@ -6959,6 +7247,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.eks#UpdateNodegroupVersionResponse": { @@ -6967,6 +7258,9 @@ "update": { "target": "com.amazonaws.eks#Update" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.eks#UpdateParam": { diff --git a/codegen/sdk/aws-models/elastic-load-balancing-v2.json b/codegen/sdk/aws-models/elastic-load-balancing-v2.json index f26c91a92449..6908eedf3823 100644 --- a/codegen/sdk/aws-models/elastic-load-balancing-v2.json +++ b/codegen/sdk/aws-models/elastic-load-balancing-v2.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.

\n

Note: 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.

\n

For more information, see the following:

\n " } }, "com.amazonaws.elasticloadbalancingv2#Limits": { @@ -4093,6 +4113,12 @@ "traits": { "smithy.api#documentation": "

[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.

\n

Each 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.

" + "smithy.api#documentation": "

Information about a condition for a rule.

\n

Each 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.

\n

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.

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

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.

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

Associates the specified security groups with the specified Application Load Balancer. The\n specified security groups override the previously associated security groups.

\n

You 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.

\n

You 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.

\n

You 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.

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

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 .

" + "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.

" } } }, @@ -5926,7 +5964,7 @@ "Port": { "target": "com.amazonaws.elasticloadbalancingv2#Port", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "AvailabilityZone": { @@ -5970,7 +6008,7 @@ "Port": { "target": "com.amazonaws.elasticloadbalancingv2#Port", "traits": { - "smithy.api#documentation": "

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/aws-models/elasticache.json b/codegen/sdk/aws-models/elasticache.json index 19aaeae5a006..e50ed4082f03 100644 --- a/codegen/sdk/aws-models/elasticache.json +++ b/codegen/sdk/aws-models/elasticache.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.

\n

For 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.

\n

For 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.

\n

For 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.

\n

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.

\n

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.

\n

When scaling up a Redis cluster or replication group using ModifyCacheCluster or\n ModifyReplicationGroup, \n 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.

\n

When scaling up a Redis cluster or replication group using\n ModifyCacheCluster or ModifyReplicationGroup, use a value\n from this list for the CacheNodeType parameter.

" } }, "ScaleDownModifications": { "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 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\n

Amazon ElastiCache is a web service that makes it easier to set up, operate, \n and scale a distributed cache in the cloud.

\n

With 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.

\n

In 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\n

Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale\n a distributed cache in the cloud.

\n

With 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.

\n

In 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.

" + "smithy.api#documentation": "

Specifies the passwords to use for authentication if Type is set to\n password.

" } } }, @@ -1558,7 +1561,7 @@ "code": "AuthorizationAlreadyExists", "httpResponseCode": 400 }, - "smithy.api#documentation": "

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.

\n \n

You cannot authorize ingress from an Amazon EC2 security group in one region to an\n ElastiCache cluster in another region.

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

Allows 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.

\n \n

You cannot authorize ingress from an Amazon EC2 security group in one region to an\n ElastiCache cluster in another region.

\n " } }, "com.amazonaws.elasticache#AuthorizeCacheSecurityGroupIngressMessage": { @@ -1622,14 +1625,14 @@ "EC2SecurityGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The 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.

\n

Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211\n

" + "smithy.api#documentation": "

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.

\n

Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211\n

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

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.

\n

The 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.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \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

      \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

      \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

      \n
      • \n
    • \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

      \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

      \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

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous 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

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \n
      • \n
    • \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

      \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
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1 instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.

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

The name of the compute and memory capacity node type for the cluster.

\n

The 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.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \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

      \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

      \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

      \n
      • \n
    • \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

      \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

      \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

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous 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

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \n
      • \n
    • \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

      \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
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and\n appendfsync are not supported on Redis version 2.8.22 and\n later.

    \n
    • \n
" } }, "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the cache engine (memcached or \n redis) to be used for this cluster.

" + "smithy.api#documentation": "

The name of the cache engine (memcached or redis) to be used\n for this cluster.

" } }, "EngineVersion": { @@ -1840,19 +1846,19 @@ "CacheClusterStatus": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "NumCacheNodes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of cache nodes in the cluster.

\n

For 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.

\n

For 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.

\n

Valid values for ddd are:

\n
    \n
  • \n

    \n sun\n

    \n
    • \n
  • \n

    \n mon\n

    \n
    • \n
  • \n

    \n tue\n

    \n
    • \n
  • \n

    \n wed\n

    \n
    • \n
  • \n

    \n thu\n

    \n
    • \n
  • \n

    \n fri\n

    \n
    • \n
  • \n

    \n sat\n

    \n
    • \n
\n

Example: sun:23:00-mon:01:30\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.

\n

Valid values for ddd are:

\n
    \n
  • \n

    \n sun\n

    \n
    • \n
  • \n

    \n mon\n

    \n
    • \n
  • \n

    \n tue\n

    \n
    • \n
  • \n

    \n wed\n

    \n
    • \n
  • \n

    \n thu\n

    \n
    • \n
  • \n

    \n fri\n

    \n
    • \n
  • \n

    \n sat\n

    \n
    • \n
\n

Example: sun:23:00-mon:01:30\n

" } }, "PendingModifiedValues": { @@ -1879,13 +1885,13 @@ "NotificationConfiguration": { "target": "com.amazonaws.elasticache#NotificationConfiguration", "traits": { - "smithy.api#documentation": "

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 \n

\n If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

\n " + "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 \n

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned\n off.

\n " } }, "SnapshotWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a \n daily snapshot of your cluster.

\n

Example: 05:00-09:00\n

" + "smithy.api#documentation": "

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your cluster.

\n

Example: 05:00-09:00\n

" } }, "AuthTokenEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

A flag that enables using an AuthToken (password)\n when issuing Redis commands.

\n

Default: false\n

" + "smithy.api#documentation": "

A flag that enables using an AuthToken (password) when issuing Redis\n commands.

\n

Default: false\n

" } }, "AuthTokenLastModifiedDate": { @@ -1952,13 +1958,13 @@ "TransitEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

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.

\n

Default: false\n

" + "smithy.api#documentation": "

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.

\n

Default: false\n

" } }, "AtRestEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

A flag that enables encryption at-rest when set to true.

\n

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

\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

\n

Default: false\n

" + "smithy.api#documentation": "

A flag that enables encryption at-rest when set to true.

\n

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

\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.

\n

Default: false\n

" } }, "ARN": { @@ -1971,7 +1977,7 @@ "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "IpDiscovery": { "target": "com.amazonaws.elasticache#IpDiscovery", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "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.

" } } }, @@ -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.

\n

Valid 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

" + "smithy.api#documentation": "

The name of the cache parameter group family associated with this cache engine.

\n

Valid 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

" } }, "CacheEngineDescription": { @@ -2137,12 +2143,12 @@ "CacheEngineVersions": { "target": "com.amazonaws.elasticache#CacheEngineVersionList", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

The current state of this cache node, one of the following values:\n available, creating, rebooting, or\n deleting.

" } }, "CacheNodeCreateTime": { @@ -2181,7 +2187,7 @@ "SourceCacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

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.

\n

The 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.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \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

      \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

      \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

      \n
      • \n
    • \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

      \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

      \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

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous 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

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \n
      • \n
    • \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

      \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
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1 instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.

    \n
    • \n
" + "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.

\n

The 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.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \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

      \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

      \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

      \n
      • \n
    • \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

      \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

      \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

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous 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

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \n
      • \n
    • \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

      \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
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and\n appendfsync are not supported on Redis version 2.8.22 and\n later.

    \n
    • \n
" } }, "com.amazonaws.elasticache#CacheNodeIdsList": { @@ -2274,7 +2280,7 @@ "ChangeType": { "target": "com.amazonaws.elasticache#ChangeType", "traits": { - "smithy.api#documentation": "

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.

\n

Valid 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

" + "smithy.api#documentation": "

The name of the cache parameter group family that this cache parameter group is\n compatible with.

\n

Valid 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

" } }, "Description": { @@ -2459,7 +2465,7 @@ "CacheNodeTypeSpecificParameters": { "target": "com.amazonaws.elasticache#CacheNodeTypeSpecificParametersList", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } } }, @@ -2782,7 +2788,7 @@ "code": "CacheSubnetGroupAlreadyExists", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The requested cache subnet group name is already in use by an existing cache subnet group.

", + "smithy.api#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.

\n

The minimum number of replicas in a shard or replication group is:

\n
    \n
  • \n

    Redis (cluster mode disabled)

    \n
      \n
    • \n

      If Multi-AZ: 1

      \n
      • \n
    • \n

      If Multi-AZ: 0

      \n
      • \n
    \n
    • \n
  • \n

    Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

    \n
    • \n
", + "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. The minimum value depends upon\n the type of Redis replication group you are working with.

\n

The minimum number of replicas in a shard or replication group is:

\n
    \n
  • \n

    Redis (cluster mode disabled)

    \n
      \n
    • \n

      If Multi-AZ: 1

      \n
      • \n
    • \n

      If Multi-AZ: 0

      \n
      • \n
    \n
    • \n
  • \n

    Redis (cluster mode enabled): 0 (though you will not be able to failover to\n a replica if your primary node fails)

    \n
    • \n
", "smithy.api#required": {} } }, "PreferredAvailabilityZones": { "target": "com.amazonaws.elasticache#PreferredAvailabilityZoneList", "traits": { - "smithy.api#documentation": "

A 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.

" + "smithy.api#documentation": "

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.

" } }, "PreferredOutpostArns": { @@ -3049,7 +3055,7 @@ } }, "traits": { - "smithy.api#documentation": "

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.

\n \n

This operation is valid for Redis only.

\n \n \n

Users 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.

\n \n

You could receive the following error messages.

\n

\n Error Messages\n

\n
    \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
  • \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
  • \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
  • \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
  • \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
    • \n
  • \n

    \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
  • \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
  • \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.

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

Makes a copy of an existing snapshot.

\n \n

This operation is valid for Redis only.

\n \n \n

Users 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.

\n \n

You could receive the following error messages.

\n

\n Error Messages\n

\n
    \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
  • \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
  • \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
  • \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
  • \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
    • \n
  • \n

    \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
  • \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
  • \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.

    \n
    • \n
" } }, "com.amazonaws.elasticache#CopySnapshotMessage": { @@ -3100,14 +3106,14 @@ "TargetSnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

A 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.

\n

When 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.

\n

For 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.

\n

When 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.

\n

For 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.

\n

This 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.

\n

This 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

\n
    \n
  • \n

    A name must contain from 1 to 50 alphanumeric characters or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    A name cannot end with a hyphen or contain two consecutive hyphens.

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

The node group (shard) identifier. This parameter is stored as a lowercase\n string.

\n

\n Constraints:\n

\n
    \n
  • \n

    A name must contain from 1 to 50 alphanumeric characters or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    A name cannot end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
", "smithy.api#required": {} } }, "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The 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.

\n

If 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.

\n \n

This parameter is only valid if the Engine parameter is redis.

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

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.

\n

If 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.

\n \n

This parameter is only valid if the Engine parameter is\n redis.

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

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.

\n

This parameter is only supported for Memcached clusters.

\n

If the AZMode and PreferredAvailabilityZones are not specified, \n ElastiCache assumes single-az mode.

" + "smithy.api#documentation": "

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.

\n

This parameter is only supported for Memcached clusters.

\n

If the AZMode and PreferredAvailabilityZones are not\n specified, ElastiCache assumes single-az mode.

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

The EC2 Availability Zone in which the cluster is created.

\n

All 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.

\n

Default: System chosen Availability Zone.

" + "smithy.api#documentation": "

The EC2 Availability Zone in which the cluster is created.

\n

All 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.

\n

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.

\n

This option is only supported on Memcached.

\n \n

If 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.

\n

The number of Availability Zones listed must equal the value of NumCacheNodes.

\n \n

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.

\n

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.

\n

This option is only supported on Memcached.

\n \n

If 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.

\n

The number of Availability Zones listed must equal the value of\n NumCacheNodes.

\n \n

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.

\n

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.

\n

For clusters running Redis, this value must be 1. \n For clusters running Memcached, this value must be between 1 and 40.

\n

If 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.

\n

For clusters running Redis, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.

\n

If 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).

\n

The 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.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \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

      \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

      \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

      \n
      • \n
    • \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

      \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

      \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

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous 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

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \n
      • \n
    • \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

      \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
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1 instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.

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

The compute and memory capacity of the nodes in the node group (shard).

\n

The 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.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \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

      \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

      \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

      \n
      • \n
    • \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

      \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

      \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

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous 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

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \n
      • \n
    • \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

      \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
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and\n appendfsync are not supported on Redis version 2.8.22 and\n later.

    \n
    • \n
" } }, "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the cache engine to be used for this cluster.

\n

Valid values for this parameter are: memcached | redis\n

" + "smithy.api#documentation": "

The name of the cache engine to be used for this cluster.

\n

Valid values for this parameter are: memcached |\n redis\n

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

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.

" + "smithy.api#documentation": "

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.

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

The name of the subnet group to be used for the cluster.

\n

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

\n \n

If 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.

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

The name of the subnet group to be used for the cluster.

\n

Use this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (Amazon VPC).

\n \n

If 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.

\n " } }, "CacheSecurityGroupNames": { "target": "com.amazonaws.elasticache#CacheSecurityGroupNameList", "traits": { - "smithy.api#documentation": "

A list of security group names to associate with this cluster.

\n

Use 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.

\n

Use 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.

\n

Use 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.

\n

Use 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.

\n \n

This parameter is only valid if the Engine parameter is redis.

\n \n

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n

" + "smithy.api#documentation": "

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.

\n \n

This parameter is only valid if the Engine parameter is\n redis.

\n \n

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n

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

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.

\n \n

This parameter is only valid if the Engine parameter is redis.

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

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.

\n \n

This parameter is only valid if the Engine parameter is\n redis.

\n " } }, "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.\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.

\n \n

The Amazon SNS topic owner must be the same as the cluster owner.

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

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic\n to which notifications are sent.

\n \n

The Amazon SNS topic owner must be the same as the cluster owner.

\n " } }, "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 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.

\n \n

This parameter is only valid if the Engine parameter is redis.

\n \n

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.

\n \n

This parameter is only valid if the Engine parameter is\n redis.

\n \n

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).

\n

Example: 05:00-09:00\n

\n

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

\n \n

This parameter is only valid if the Engine parameter is redis.

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

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your node group (shard).

\n

Example: 05:00-09:00\n

\n

If you do not specify this parameter, ElastiCache automatically chooses an appropriate\n time range.

\n \n

This parameter is only valid if the Engine parameter is\n redis.

\n " } }, "AuthToken": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

\n Reserved parameter. \n The password used to access a password protected server.

\n

Password constraints:

\n
    \n
  • \n

    Must be only printable ASCII characters.

    \n
    • \n
  • \n

    Must be at least 16 characters and no more than 128\n characters in length.

    \n
    • \n
  • \n

    The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

    \n
    • \n
\n

For 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

Password constraints:

\n
    \n
  • \n

    Must be only printable ASCII characters.

    \n
    • \n
  • \n

    Must be at least 16 characters and no more than 128 characters in\n length.

    \n
    • \n
  • \n

    The only permitted printable special characters are !, &, #, $, ^, <,\n >, and -. Other printable special characters cannot be used in the AUTH\n token.

    \n
    • \n
\n

For 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.

" + "smithy.api#documentation": "

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.

" } }, "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.

" + "smithy.api#documentation": "

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.

" } } }, @@ -3386,6 +3395,9 @@ "CacheCluster": { "target": "com.amazonaws.elasticache#CacheCluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateCacheParameterGroup": { @@ -3417,7 +3429,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

\n

A 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 " + "smithy.api#documentation": "

Creates 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.

\n

A 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 " } }, "com.amazonaws.elasticache#CreateCacheParameterGroupMessage": { @@ -3433,7 +3445,7 @@ "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the cache parameter group family that the cache parameter group can be used with.

\n

Valid 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

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

The name of the cache parameter group family that the cache parameter group can be\n used with.

\n

Valid 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

", "smithy.api#required": {} } }, @@ -3447,7 +3459,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.

" } } }, @@ -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.

\n

Cache 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.

\n

Cache 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.

\n

Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word \"Default\".

\n

Example: mysecuritygroup\n

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

A name for the cache security group. This value is stored as a lowercase\n string.

\n

Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word\n \"Default\".

\n

Example: mysecuritygroup\n

", "smithy.api#required": {} } }, @@ -3512,7 +3527,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.

" } } }, @@ -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.

\n

Use 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.

\n

Use 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.

\n
    \n
  • \n

    The GlobalReplicationGroupIdSuffix is the name of the Global datastore.

    \n
    • \n
  • \n

    The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.

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

Global 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.

\n
    \n
  • \n

    The GlobalReplicationGroupIdSuffix is the\n name of the Global datastore.

    \n
    • \n
  • \n

    The PrimaryReplicationGroupId represents the\n name of the primary cluster that accepts writes and will replicate updates to\n the secondary cluster.

    \n
    • \n
" } }, "com.amazonaws.elasticache#CreateGlobalReplicationGroupMessage": { @@ -3638,7 +3659,7 @@ "GlobalReplicationGroupIdSuffix": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The 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.

\n

For 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.

\n

For 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.

\n

This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.

\n

A 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.

\n

A 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

\n

The 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.

\n

To request a limit increase, see \n Amazon Service Limits \n and choose the limit type Nodes per cluster per instance type.

\n

When 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.

\n \n

This operation is valid for Redis only.

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

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication\n group.

\n

This API can be used to create a standalone regional replication group or a secondary\n replication group associated with a Global datastore.

\n

A 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.

\n

A 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.

\n

The 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.

\n

To request a limit increase, see Amazon Service Limits and\n choose the limit type Nodes per cluster per instance\n type.

\n

When 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.

\n \n

This operation is valid for Redis only.

\n " } }, "com.amazonaws.elasticache#CreateReplicationGroupMessage": { @@ -3742,7 +3766,7 @@ "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The replication group identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    A name must contain from 1 to 40 alphanumeric characters or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    A name cannot end with a hyphen or contain two consecutive hyphens.

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

The replication group identifier. This parameter is stored as a lowercase\n string.

\n

Constraints:

\n
    \n
  • \n

    A name must contain from 1 to 40 alphanumeric characters or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    A name cannot end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -3762,79 +3786,79 @@ "PrimaryClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The 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.

\n

This parameter is not required if NumCacheClusters,\n NumNodeGroups, or\n ReplicasPerNodeGroup is specified.

" + "smithy.api#documentation": "

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.

\n

This parameter is not required if NumCacheClusters,\n NumNodeGroups, or ReplicasPerNodeGroup is\n specified.

" } }, "AutomaticFailoverEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

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.

\n

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.

\n

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.

\n

This parameter is not used if there is more than one node group (shard). \n You should use ReplicasPerNodeGroup instead.

\n

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.

\n

The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).

" + "smithy.api#documentation": "

The number of clusters this replication group initially has.

\n

This parameter is not used if there is more than one node group (shard). You should\n use ReplicasPerNodeGroup instead.

\n

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.

\n

The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5\n replicas).

" } }, "PreferredCacheClusterAZs": { "target": "com.amazonaws.elasticache#AvailabilityZonesList", "traits": { - "smithy.api#documentation": "

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.

\n

This parameter is not used if there is more than one node group (shard). \n You should use NodeGroupConfiguration instead.

\n \n

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.

\n

The number of Availability Zones listed must equal the value of NumCacheClusters.

\n \n

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.

\n

This parameter is not used if there is more than one node group (shard). You should\n use NodeGroupConfiguration instead.

\n \n

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.

\n

The number of Availability Zones listed must equal the value of\n NumCacheClusters.

\n \n

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.

\n

Default: 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.

\n

Default: 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.

\n

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.

\n

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).

\n

The 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.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \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

      \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

      \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

      \n
      • \n
    • \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

      \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

      \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

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous 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

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \n
      • \n
    • \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

      \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
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1 instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.

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

The compute and memory capacity of the nodes in the node group (shard).

\n

The 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.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \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

      \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

      \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

      \n
      • \n
    • \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

      \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

      \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

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous 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

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \n
      • \n
    • \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

      \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
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and\n appendfsync are not supported on Redis version 2.8.22 and\n later.

    \n
    • \n
" } }, "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the cache engine to be used for the clusters in this replication group. The value must be set to Redis.

" + "smithy.api#documentation": "

The name of the cache engine to be used for the clusters in this replication group.\n The value must be set to Redis.

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

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

\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

\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.

\n

If 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.

\n
    \n
  • \n

    To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.

    \n
    • \n
  • \n

    To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.

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

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.

\n

If 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.

\n
    \n
  • \n

    To create a Redis (cluster mode disabled) replication group, use\n CacheParameterGroupName=default.redis3.2.

    \n
    • \n
  • \n

    To create a Redis (cluster mode enabled) replication group, use\n CacheParameterGroupName=default.redis3.2.cluster.on.

    \n
    • \n
" } }, "CacheSubnetGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the cache subnet group to be used for the replication group.

\n \n

If 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.

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

The name of the cache subnet group to be used for the replication group.

\n \n

If 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.

\n " } }, "CacheSecurityGroupNames": { @@ -3846,79 +3870,79 @@ "SecurityGroupIds": { "target": "com.amazonaws.elasticache#SecurityGroupIdsList", "traits": { - "smithy.api#documentation": "

One or more Amazon VPC security groups associated with this replication group.

\n

Use 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.

\n

Use 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.

" + "smithy.api#documentation": "

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.

" } }, "SnapshotArns": { "target": "com.amazonaws.elasticache#SnapshotArnsList", "traits": { - "smithy.api#documentation": "

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.

\n

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n

" + "smithy.api#documentation": "

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.

\n

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n

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

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.

" + "smithy.api#documentation": "

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.

" } }, "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.\n Valid values for ddd are:

\n

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:

\n
    \n
  • \n

    \n sun\n

    \n
    • \n
  • \n

    \n mon\n

    \n
    • \n
  • \n

    \n tue\n

    \n
    • \n
  • \n

    \n wed\n

    \n
    • \n
  • \n

    \n thu\n

    \n
    • \n
  • \n

    \n fri\n

    \n
    • \n
  • \n

    \n sat\n

    \n
    • \n
\n

Example: sun:23:00-mon:01:30\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. Valid values for ddd\n are:

\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.

\n

Valid values for ddd are:

\n
    \n
  • \n

    \n sun\n

    \n
    • \n
  • \n

    \n mon\n

    \n
    • \n
  • \n

    \n tue\n

    \n
    • \n
  • \n

    \n wed\n

    \n
    • \n
  • \n

    \n thu\n

    \n
    • \n
  • \n

    \n fri\n

    \n
    • \n
  • \n

    \n sat\n

    \n
    • \n
\n

Example: sun:23:00-mon:01:30\n

" } }, "Port": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

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.

\n \n

The Amazon SNS topic owner must be the same as the cluster owner.

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

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic\n to which notifications are sent.

\n \n

The Amazon SNS topic owner must be the same as the cluster owner.

\n " } }, "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 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.

\n

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.

\n

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).

\n

Example: 05:00-09:00\n

\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).

\n

Example: 05:00-09:00\n

\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.

\n \n

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, \n an AuthToken, and a CacheSubnetGroup.

\n \n

Password constraints:

\n
    \n
  • \n

    Must be only printable ASCII characters.

    \n
    • \n
  • \n

    Must be at least 16 characters and no more than 128\n characters in length.

    \n
    • \n
  • \n

    The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

    \n
    • \n
\n

For 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.

\n \n

For HIPAA compliance, you must specify TransitEncryptionEnabled as\n true, an AuthToken, and a\n CacheSubnetGroup.

\n \n

Password constraints:

\n
    \n
  • \n

    Must be only printable ASCII characters.

    \n
    • \n
  • \n

    Must be at least 16 characters and no more than 128 characters in\n length.

    \n
    • \n
  • \n

    The only permitted printable special characters are !, &, #, $, ^, <,\n >, and -. Other printable special characters cannot be used in the AUTH\n token.

    \n
    • \n
\n

For 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.

\n

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.

\n

If you enable in-transit encryption, you must also specify a value for \n CacheSubnetGroup.

\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.

\n

Default: false\n

\n \n

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, \n an AuthToken, and a CacheSubnetGroup.

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

A flag that enables in-transit encryption when set to true.

\n

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.

\n

If you enable in-transit encryption, you must also specify a value for\n CacheSubnetGroup.

\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.

\n

Default: false\n

\n \n

For HIPAA compliance, you must specify TransitEncryptionEnabled as\n true, an AuthToken, and a\n CacheSubnetGroup.

\n " } }, "AtRestEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

A flag that enables encryption at rest when set to true.

\n

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

\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

\n

Default: false\n

" + "smithy.api#documentation": "

A flag that enables encryption at rest when set to true.

\n

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

\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.

\n

Default: false\n

" } }, "KmsKeyId": { @@ -3942,31 +3966,31 @@ "DataTieringEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "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.

" } }, "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.

" + "smithy.api#documentation": "

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.

" } }, "IpDiscovery": { "target": "com.amazonaws.elasticache#IpDiscovery", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "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.

\n

When 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.

\n

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.

\n

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.

\n

When 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.

\n

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.

\n

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.

\n \n

This operation is valid for Redis only.

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

Creates a copy of an entire cluster or replication group at a specific moment in\n time.

\n \n

This operation is valid for Redis only.

\n " } }, "com.amazonaws.elasticache#CreateSnapshotMessage": { @@ -4032,13 +4059,13 @@ "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The 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.

\n

The minimum number of replicas in a shard or replication group is:

\n
    \n
  • \n

    Redis (cluster mode disabled)

    \n
      \n
    • \n

      If Multi-AZ is enabled: 1

      \n
      • \n
    • \n

      If Multi-AZ is not enabled: 0

      \n
      • \n
    \n
    • \n
  • \n

    Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

    \n
    • \n
" + "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.

\n

The minimum number of replicas in a shard or replication group is:

\n
    \n
  • \n

    Redis (cluster mode disabled)

    \n
      \n
    • \n

      If Multi-AZ is enabled: 1

      \n
      • \n
    • \n

      If Multi-AZ is not enabled: 0

      \n
      • \n
    \n
    • \n
  • \n

    Redis (cluster mode enabled): 0 (though you will not be able to failover to\n a replica if your primary node fails)

    \n
    • \n
" } }, "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.

" + "smithy.api#documentation": "

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.

" } }, "ReplicasToRemove": { "target": "com.amazonaws.elasticache#RemoveReplicasList", "traits": { - "smithy.api#documentation": "

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.

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

If True, the number of replica nodes is decreased immediately.\n ApplyImmediately=False is not currently supported.

", "smithy.api#required": {} } } @@ -4445,6 +4478,9 @@ "ReplicationGroup": { "target": "com.amazonaws.elasticache#ReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#DefaultUserAssociatedToUserGroupFault": { @@ -4513,7 +4549,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

\n

This operation is not valid for:

\n
    \n
  • \n

    Redis (cluster mode enabled) clusters

    \n
    • \n
  • \n

    Redis (cluster mode disabled) clusters

    \n
    • \n
  • \n

    A cluster that is the last read replica of a replication group

    \n
    • \n
  • \n

    A cluster that is the primary node of a replication group

    \n
    • \n
  • \n

    A node group (shard) that has Multi-AZ mode enabled

    \n
    • \n
  • \n

    A cluster from a Redis (cluster mode enabled) replication group

    \n
    • \n
  • \n

    A cluster that is not in the available state

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

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.

\n

This operation is not valid for:

\n
    \n
  • \n

    Redis (cluster mode enabled) clusters

    \n
    • \n
  • \n

    Redis (cluster mode disabled) clusters

    \n
    • \n
  • \n

    A cluster that is the last read replica of a replication group

    \n
    • \n
  • \n

    A cluster that is the primary node of a replication group

    \n
    • \n
  • \n

    A node group (shard) that has Multi-AZ mode enabled

    \n
    • \n
  • \n

    A cluster from a Redis (cluster mode enabled) replication group

    \n
    • \n
  • \n

    A cluster that is not in the available state

    \n
    • \n
" } }, "com.amazonaws.elasticache#DeleteCacheClusterMessage": { @@ -4522,14 +4558,14 @@ "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

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.

\n \n

The specified cache security group must not be associated with any clusters.

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

The name of the cache parameter group to delete.

\n \n

The specified cache security group must not be associated with any\n clusters.

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

Deletes a cache security group.

\n \n

You cannot delete a cache security group if it is associated with any clusters.

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

Deletes a cache security group.

\n \n

You cannot delete a cache security group if it is associated with any\n clusters.

\n " } }, "com.amazonaws.elasticache#DeleteCacheSecurityGroupMessage": { @@ -4644,7 +4683,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a cache subnet group.

\n \n

You cannot delete a default cache subnet group or one that is associated with any clusters.

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

Deletes a cache subnet group.

\n \n

You cannot delete a default cache subnet group or one that is associated with any\n clusters.

\n " } }, "com.amazonaws.elasticache#DeleteCacheSubnetGroupMessage": { @@ -4682,7 +4721,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deleting a Global datastore is a two-step process:

\n
    \n
  • \n

    First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.

    \n
    • \n
  • \n

    Once 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.

    \n
    • \n
\n

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.

\n

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:

\n
    \n
  • \n

    First, you must DisassociateGlobalReplicationGroup to remove\n the secondary clusters in the Global datastore.

    \n
    • \n
  • \n

    Once 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.

    \n
    • \n
\n

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.

\n

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.

\n

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.

\n \n

This operation is valid for Redis only.

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

Deletes 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.

\n

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.

\n \n

This operation is valid for Redis only.

\n " } }, "com.amazonaws.elasticache#DeleteReplicationGroupMessage": { @@ -4754,20 +4796,20 @@ "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The 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.

" + "smithy.api#documentation": "

If set to true, all of the read replicas are deleted, but the primary\n node is retained.

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

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.

\n \n

This operation is valid for Redis only.

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

Deletes 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.

\n \n

This operation is valid for Redis only.

\n " } }, "com.amazonaws.elasticache#DeleteSnapshotMessage": { @@ -4830,6 +4875,9 @@ "Snapshot": { "target": "com.amazonaws.elasticache#Snapshot" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#DeleteUser": { @@ -4858,7 +4906,7 @@ } ], "traits": { - "smithy.api#documentation": "

For 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.

\n

By 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.

\n

If the cluster is in the creating state, only cluster-level information is displayed \n until all of the nodes are successfully provisioned.

\n

If the cluster is in the deleting state, only cluster-level information is displayed.

\n

If 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.

\n

If 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.

\n

By 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.

\n

If the cluster is in the creating state, only cluster-level\n information is displayed until all of the nodes are successfully provisioned.

\n

If the cluster is in the deleting state, only cluster-level\n information is displayed.

\n

If 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.

\n

If 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.

\n

Default: 100

\n

Constraints: 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.

\n

Default: 100

\n

Constraints: 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.

" + "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.

" } }, "ShowCacheNodeInfo": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

An optional flag that can be included in the DescribeCacheCluster request \n to retrieve information about the individual cache nodes.

" + "smithy.api#documentation": "

An optional flag that can be included in the DescribeCacheCluster request\n to retrieve information about the individual cache nodes.

" } }, "ShowCacheClustersNotInReplicationGroups": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } } }, @@ -5130,7 +5178,7 @@ "target": "com.amazonaws.elasticache#CacheEngineVersionMessage" }, "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

The cache engine to return. Valid values: memcached |\n redis\n

" } }, "EngineVersion": { @@ -5157,26 +5205,26 @@ "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of a specific cache parameter group family to return details for.

\n

Valid 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

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 alphanumeric characters

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens

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

The name of a specific cache parameter group family to return details for.

\n

Valid 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

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 alphanumeric characters

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens

    \n
    • \n
" } }, "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.

\n

Default: 100

\n

Constraints: 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.

\n

Default: 100

\n

Constraints: 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.

" + "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.

" } }, "DefaultOnly": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If true, specifies that only the default version of the specified engine or engine\n and major version combination is to be returned.

" + "smithy.api#documentation": "

If true, specifies that only the default version of the specified engine\n or engine and major version combination is to be returned.

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

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.

\n

Default: 100

\n

Constraints: 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.

\n

Default: 100

\n

Constraints: 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.

" + "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.

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

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.

\n

Valid values: user | system | engine-default\n

" + "smithy.api#documentation": "

The parameter types to return.

\n

Valid values: user | system |\n engine-default\n

" } }, "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.

\n

Default: 100

\n

Constraints: 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.

\n

Default: 100

\n

Constraints: 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.

" + "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.

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

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.

\n

Default: 100

\n

Constraints: 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.

\n

Default: 100

\n

Constraints: 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.

" + "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.

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

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.

\n

Default: 100

\n

Constraints: 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.

\n

Default: 100

\n

Constraints: 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.

" + "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.

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

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.

\n

Valid 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

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

The name of the cache parameter group family.

\n

Valid 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

", "smithy.api#required": {} } }, "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.

\n

Default: 100

\n

Constraints: 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.

\n

Default: 100

\n

Constraints: 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.

" + "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#documentation": "

Represents the input of a DescribeEngineDefaultParameters operation.

" + "smithy.api#documentation": "

Represents the input of a DescribeEngineDefaultParameters\n operation.

" } }, "com.amazonaws.elasticache#DescribeEngineDefaultParametersResult": { @@ -5464,6 +5512,9 @@ "EngineDefaults": { "target": "com.amazonaws.elasticache#EngineDefaults" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#DescribeEvents": { @@ -5483,7 +5534,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

\n

By 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.

\n

By 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.

\n

Default: 100

\n

Constraints: 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.

\n

Default: 100

\n

Constraints: 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.

" + "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.

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

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.

" + "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.

" } }, "ShowMemberInfo": { @@ -5606,7 +5657,7 @@ "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. >

" } }, "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.

\n \n

This operation is valid for Redis only.

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

Returns information about a particular replication group. If no identifier is\n specified, DescribeReplicationGroups returns information about all\n replication groups.

\n \n

This operation is valid for Redis only.

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5712,19 +5766,19 @@ "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The identifier for the replication group to be described. This parameter is not case sensitive.

\n

If 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.

\n

If 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.

\n

Default: 100

\n

Constraints: 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.

\n

Default: 100

\n

Constraints: 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.

" + "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.

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

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.

\n

The 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.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \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

      \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

      \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

      \n
      • \n
    • \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

      \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

      \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

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous 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

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \n
      • \n
    • \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

      \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
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1 instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.

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

The cache node type filter value. Use this parameter to show only those reservations\n matching the specified cache node type.

\n

The 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.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \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

      \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

      \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

      \n
      • \n
    • \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

      \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

      \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

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous 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

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \n
      • \n
    • \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

      \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
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and\n appendfsync are not supported on Redis version 2.8.22 and\n later.

    \n
    • \n
" } }, "Duration": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The duration filter value, specified in years or seconds. \n Use this parameter to show only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" + "smithy.api#documentation": "

The duration filter value, specified in years or seconds. Use this parameter to show\n only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

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

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.

\n

Valid values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\"|\"All Upfront\"|\"Partial Upfront\"| \"No Upfront\"\n

" + "smithy.api#documentation": "

The offering type filter value. Use this parameter to show only the available\n offerings matching the specified offering type.

\n

Valid values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\"|\"All\n Upfront\"|\"Partial Upfront\"| \"No Upfront\"\n

" } }, "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.

\n

Default: 100

\n

Constraints: 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.

\n

Default: 100

\n

Constraints: 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.

" + "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.

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

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.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n

" + "smithy.api#documentation": "

The offering identifier filter value. Use this parameter to show only the available\n offering that matches the specified reservation identifier.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n

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

The cache node type filter value. \n Use this parameter to show only the available offerings matching the specified cache node type.

\n

The 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.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \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

      \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

      \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

      \n
      • \n
    • \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

      \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

      \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

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous 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

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \n
      • \n
    • \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

      \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
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1 instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.

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

The cache node type filter value. Use this parameter to show only the available\n offerings matching the specified cache node type.

\n

The 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.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \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

      \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

      \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

      \n
      • \n
    • \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

      \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

      \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

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous 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

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \n
      • \n
    • \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

      \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
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and\n appendfsync are not supported on Redis version 2.8.22 and\n later.

    \n
    • \n
" } }, "Duration": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Duration filter value, specified in years or seconds. \n Use this parameter to show only reservations for a given duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" + "smithy.api#documentation": "

Duration filter value, specified in years or seconds. Use this parameter to show only\n reservations for a given duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

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

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.

\n

Valid Values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\" |\"All Upfront\"|\"Partial Upfront\"| \"No Upfront\"\n

" + "smithy.api#documentation": "

The offering type filter value. Use this parameter to show only the available\n offerings matching the specified offering type.

\n

Valid Values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\" |\"All\n Upfront\"|\"Partial Upfront\"| \"No Upfront\"\n

" } }, "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.

\n

Default: 100

\n

Constraints: 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.

\n

Default: 100

\n

Constraints: 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.

" + "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#documentation": "

Represents the input of a DescribeReservedCacheNodesOfferings operation.

" + "smithy.api#documentation": "

Represents the input of a DescribeReservedCacheNodesOfferings\n operation.

" } }, "com.amazonaws.elasticache#DescribeServiceUpdates": { @@ -5949,7 +6003,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.

" + "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.

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

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.

\n \n

This operation is valid for Redis only.

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

Returns 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.

\n \n

This operation is valid for Redis only.

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5992,13 +6046,13 @@ "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.

" + "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.

" } }, "Snapshots": { "target": "com.amazonaws.elasticache#SnapshotList", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "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.

" + "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.

" } }, "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.

\n

Default: 50

\n

Constraints: 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.

\n

Default: 50

\n

Constraints: 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.

" + "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.

" } } } @@ -6188,13 +6242,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. >

" } } } @@ -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.

\n

Valid 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

" + "smithy.api#documentation": "

Specifies the name of the cache parameter group family to which the engine default\n parameters apply.

\n

Valid 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

" } }, "Marker": { @@ -6497,12 +6560,12 @@ "CacheNodeTypeSpecificParameters": { "target": "com.amazonaws.elasticache#CacheNodeTypeSpecificParametersList", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

Represents the output of a DescribeEngineDefaultParameters\n operation.

" } }, "com.amazonaws.elasticache#EngineType": { @@ -6517,13 +6580,13 @@ "SourceIdentifier": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

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.

\n

Default: false\n

" + "smithy.api#documentation": "

A flag that enables using an AuthToken (password) when issuing Redis\n commands.

\n

Default: false\n

" } }, "TransitEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "AtRestEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

A flag that enables encryption at rest when set to true.

\n

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

\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

" + "smithy.api#documentation": "

A flag that enables encryption at rest when set to true.

\n

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

\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.

" } }, "ARN": { @@ -6807,7 +6873,7 @@ } }, "traits": { - "smithy.api#documentation": "

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.

\n
    \n
  • \n

    The GlobalReplicationGroupIdSuffix represents the name of the Global datastore,\n which is what you use to associate a secondary cluster.

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

Consists 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.

\n
    \n
  • \n

    The GlobalReplicationGroupIdSuffix represents\n the name of the Global datastore, which is what you use to associate a secondary\n cluster.

    \n
    • \n
" } }, "com.amazonaws.elasticache#GlobalReplicationGroupAlreadyExistsFault": { @@ -6839,12 +6905,12 @@ "GlobalReplicationGroupMemberRole": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The 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.

" + "smithy.api#documentation": "

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.

" } }, "ApplyImmediately": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If True, the number of replica nodes is increased immediately. \n\n ApplyImmediately=False is not currently supported.

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

If True, the number of replica nodes is increased immediately.\n ApplyImmediately=False is not currently supported.

", "smithy.api#required": {} } } @@ -7073,6 +7142,9 @@ "ReplicationGroup": { "target": "com.amazonaws.elasticache#ReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#InputAuthenticationType": { @@ -7110,7 +7182,7 @@ "code": "InsufficientCacheClusterCapacity", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The requested cache node type is not available in the specified Availability Zone.\n For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.

", + "smithy.api#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.

\n

When 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.

" + "smithy.api#documentation": "

Lists all available node types that you can scale your Redis cluster's or replication\n group's current node type.

\n

When 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.

" } }, "com.amazonaws.elasticache#ListAllowedNodeTypeModificationsMessage": { @@ -7437,18 +7509,18 @@ "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

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.

\n \n

You must provide a value for either the CacheClusterId or the\n ReplicationGroupId.

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

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.

\n \n

You must provide a value for either the CacheClusterId or the\n ReplicationGroupId.

\n " } }, "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

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.

\n \n

You must provide a value for either the CacheClusterId or the\n ReplicationGroupId.

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

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.

\n \n

You must provide a value for either the CacheClusterId or the\n ReplicationGroupId.

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

The input parameters for the ListAllowedNodeTypeModifications operation.

" + "smithy.api#documentation": "

The input parameters for the ListAllowedNodeTypeModifications\n operation.

" } }, "com.amazonaws.elasticache#ListTagsForResource": { @@ -7495,7 +7567,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all tags currently on a named resource.

\n

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

If the cluster is not in the available state, ListTagsForResource\n returns an error.

" + "smithy.api#documentation": "

Lists all tags currently on a named resource.

\n

A 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.

\n

If the cluster is not in the available state,\n ListTagsForResource returns an error.

" } }, "com.amazonaws.elasticache#ListTagsForResourceMessage": { @@ -7504,7 +7576,7 @@ "ResourceName": { "target": "com.amazonaws.elasticache#String", "traits": { - "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 \n or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

\n

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.

\n

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.

" + "smithy.api#documentation": "

Returns the destination type, either cloudwatch-logs or\n kinesis-firehose.

" } }, "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": { @@ -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

" + "smithy.api#documentation": "

Returns the log delivery configuration status. Values are one of enabling\n | disabling | modifying | active |\n error\n

" } }, "Message": { @@ -7572,19 +7644,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": "

Specify either cloudwatch-logs or kinesis-firehose as the destination type.

" + "smithy.api#documentation": "

Specify either cloudwatch-logs or kinesis-firehose as the\n destination type.

" } }, "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": { @@ -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.

\n

If you are removing cache nodes, you must\n use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

\n

For clusters running Redis, this value must be 1. \n For clusters running Memcached, this value must be between 1 and 40.

\n \n

Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).

\n

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.

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

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.

\n

If you are removing cache nodes, you must use the CacheNodeIdsToRemove\n parameter to provide the IDs of the specific cache nodes to remove.

\n

For clusters running Redis, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.

\n \n

Adding or removing Memcached cache nodes can be applied immediately or as a\n pending operation (see ApplyImmediately).

\n

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.

\n " } }, "CacheNodeIdsToRemove": { "target": "com.amazonaws.elasticache#CacheNodeIdsList", "traits": { - "smithy.api#documentation": "

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.

\n

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.

" + "smithy.api#documentation": "

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.

\n

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.

" } }, "AZMode": { "target": "com.amazonaws.elasticache#AZMode", "traits": { - "smithy.api#documentation": "

Specifies whether the new nodes in this Memcached cluster are all created in a \n single Availability Zone or created across multiple Availability Zones.

\n

Valid values: single-az | cross-az.

\n

This option is only supported for Memcached clusters.

\n \n

You 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.

\n

Only newly created nodes are located in different Availability Zones. \n

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

Specifies whether the new nodes in this Memcached cluster are all created in a single\n Availability Zone or created across multiple Availability Zones.

\n

Valid values: single-az | cross-az.

\n

This option is only supported for Memcached clusters.

\n \n

You 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.

\n

Only newly created nodes are located in different Availability Zones.

\n " } }, "NewAvailabilityZones": { "target": "com.amazonaws.elasticache#PreferredAvailabilityZoneList", "traits": { - "smithy.api#documentation": "\n

This option is only supported on Memcached clusters.

\n \n

The list of Availability Zones where the new Memcached cache nodes are created.

\n

This 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.

\n

Scenarios:

\n
    \n
  • \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
    • \n
  • \n

    \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
    • \n
  • \n

    \n Scenario 3: You want to cancel all pending operations. \n Specify NumCacheNodes=3 to cancel all pending operations.

    \n
    • \n
\n

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.

\n

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

\n Impact of new add/remove requests upon pending requests\n

\n
    \n
  • \n

    Scenario-1

    \n
      \n
    • \n

      Pending Action: Delete

      \n
      • \n
    • \n

      New Request: Delete

      \n
      • \n
    • \n

      Result: The new delete, pending or immediate, replaces the pending delete.

      \n
      • \n
    \n
    • \n
  • \n

    Scenario-2

    \n
      \n
    • \n

      Pending Action: Delete

      \n
      • \n
    • \n

      New Request: Create

      \n
      • \n
    • \n

      Result: The new create, pending or immediate, replaces the pending delete.

      \n
      • \n
    \n
    • \n
  • \n

    Scenario-3

    \n
      \n
    • \n

      Pending Action: Create

      \n
      • \n
    • \n

      New Request: Delete

      \n
      • \n
    • \n

      Result: The new delete, pending or immediate, replaces the pending create.

      \n
      • \n
    \n
    • \n
  • \n

    Scenario-4

    \n
      \n
    • \n

      Pending Action: Create

      \n
      • \n
    • \n

      New Request: Create

      \n
      • \n
    • \n

      Result: The new create is added to the pending create.

      \n \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.

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

This option is only supported on Memcached clusters.

\n \n

The list of Availability Zones where the new Memcached cache nodes are created.

\n

This 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.

\n

Scenarios:

\n
    \n
  • \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
    • \n
  • \n

    \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
    • \n
  • \n

    \n Scenario 3: You want to cancel all pending\n operations. Specify NumCacheNodes=3 to cancel all pending\n operations.

    \n
    • \n
\n

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.

\n

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

\n Impact of new add/remove requests upon pending requests\n

\n
    \n
  • \n

    Scenario-1

    \n
      \n
    • \n

      Pending Action: Delete

      \n
      • \n
    • \n

      New Request: Delete

      \n
      • \n
    • \n

      Result: The new delete, pending or immediate, replaces the pending\n delete.

      \n
      • \n
    \n
    • \n
  • \n

    Scenario-2

    \n
      \n
    • \n

      Pending Action: Delete

      \n
      • \n
    • \n

      New Request: Create

      \n
      • \n
    • \n

      Result: The new create, pending or immediate, replaces the pending\n delete.

      \n
      • \n
    \n
    • \n
  • \n

    Scenario-3

    \n
      \n
    • \n

      Pending Action: Create

      \n
      • \n
    • \n

      New Request: Delete

      \n
      • \n
    • \n

      Result: The new delete, pending or immediate, replaces the pending\n create.

      \n
      • \n
    \n
    • \n
  • \n

    Scenario-4

    \n
      \n
    • \n

      Pending Action: Create

      \n
      • \n
    • \n

      New Request: Create

      \n
      • \n
    • \n

      Result: The new create is added to the pending create.

      \n \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.

      \n       \n
      • \n
    \n
    • \n
" } }, "CacheSecurityGroupNames": { "target": "com.amazonaws.elasticache#CacheSecurityGroupNameList", "traits": { - "smithy.api#documentation": "

A list of cache security group names to authorize on this cluster. \n This change is asynchronously applied as soon as possible.

\n

You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

\n

Constraints: 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.

\n

You can use this parameter only with clusters that are created outside of an Amazon\n Virtual Private Cloud (Amazon VPC).

\n

Constraints: 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.

\n

This 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.

\n

This 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.

\n

Valid values for ddd are:

\n
    \n
  • \n

    \n sun\n

    \n
    • \n
  • \n

    \n mon\n

    \n
    • \n
  • \n

    \n tue\n

    \n
    • \n
  • \n

    \n wed\n

    \n
    • \n
  • \n

    \n thu\n

    \n
    • \n
  • \n

    \n fri\n

    \n
    • \n
  • \n

    \n sat\n

    \n
    • \n
\n

Example: sun:23:00-mon:01:30\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.

\n

Valid values for ddd are:

\n
    \n
  • \n

    \n sun\n

    \n
    • \n
  • \n

    \n mon\n

    \n
    • \n
  • \n

    \n tue\n

    \n
    • \n
  • \n

    \n wed\n

    \n
    • \n
  • \n

    \n thu\n

    \n
    • \n
  • \n

    \n fri\n

    \n
    • \n
  • \n

    \n sat\n

    \n
    • \n
\n

Example: sun:23:00-mon:01:30\n

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

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.

\n \n

The Amazon SNS topic owner must be same as the cluster owner.

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

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are\n sent.

\n \n

The Amazon SNS topic owner must be same as the cluster owner.

\n " } }, "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

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 request.

" + "smithy.api#documentation": "

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.

" } }, "NotificationTopicStatus": { @@ -7803,31 +7875,31 @@ "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

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.

\n

If false, changes to the cluster are applied on the next\n maintenance reboot, or the next failure reboot, whichever occurs first.

\n \n

If you perform a ModifyCacheCluster before a pending modification is applied, \n the pending modification is replaced by the newer modification.

\n \n

Valid values: true | false\n

\n

Default: false\n

" + "smithy.api#documentation": "

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.

\n

If false, changes to the cluster are applied on the next maintenance\n reboot, or the next failure reboot, whichever occurs first.

\n \n

If you perform a ModifyCacheCluster before a pending modification is\n applied, the pending modification is replaced by the newer modification.

\n \n

Valid values: true | false\n

\n

Default: false\n

" } }, "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { - "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 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.

\n \n

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

\n " + "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 \n

If the value of SnapshotRetentionLimit is set to zero (0), backups\n are turned off.

\n " } }, "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 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:

\n
    \n
  • \n

    Must be only printable ASCII characters

    \n
    • \n
  • \n

    Must be at least 16 characters and no more than 128 characters in length

    \n
    • \n
  • \n

    Cannot contain any of the following characters: '/', '\"', or '@', '%'

    \n
    • \n
\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:

\n
    \n
  • \n

    Must be only printable ASCII characters

    \n
    • \n
  • \n

    Must be at least 16 characters and no more than 128 characters in\n length

    \n
    • \n
  • \n

    Cannot contain any of the following characters: '/', '\"', or '@', '%'

    \n
    • \n
\n

For 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:

\n
    \n
  • \n

    Rotate

    \n
    • \n
  • \n

    Set

    \n
    • \n
\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:

\n
    \n
  • \n

    Rotate

    \n
    • \n
  • \n

    Set

    \n
    • \n
\n

For 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.

" + "smithy.api#documentation": "

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.

" } } }, @@ -7871,6 +7943,9 @@ "CacheCluster": { "target": "com.amazonaws.elasticache#CacheCluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#ModifyCacheParameterGroup": { @@ -7899,7 +7974,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

\n

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

\n

Example: mysubnetgroup\n

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

The name for the cache subnet group. This value is stored as a lowercase\n string.

\n

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

\n

Example: mysubnetgroup\n

", "smithy.api#required": {} } }, @@ -7986,6 +8061,9 @@ "CacheSubnetGroup": { "target": "com.amazonaws.elasticache#CacheSubnetGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#ModifyGlobalReplicationGroup": { @@ -8025,7 +8103,7 @@ "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

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 \n

This operation is valid for Redis only.

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

Modifies the settings for a replication group.

\n \n \n

This operation is valid for Redis only.

\n " } }, "com.amazonaws.elasticache#ModifyReplicationGroupMessage": { @@ -8150,7 +8231,7 @@ "PrimaryClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

For 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.

\n

Valid values: true | false\n

" + "smithy.api#documentation": "

Determines whether a read replica is automatically promoted to read/write primary if\n the existing primary encounters a failure.

\n

Valid values: true | false\n

" } }, "MultiAZEnabled": { @@ -8181,37 +8262,37 @@ "CacheSecurityGroupNames": { "target": "com.amazonaws.elasticache#CacheSecurityGroupNameList", "traits": { - "smithy.api#documentation": "

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.

\n

This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).

\n

Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.

" + "smithy.api#documentation": "

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.

\n

This parameter can be used only with replication group containing clusters running\n outside of an Amazon Virtual Private Cloud (Amazon VPC).

\n

Constraints: 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 clusters in the replication group.

\n

This 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.

\n

This 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.

\n

Valid values for ddd are:

\n
    \n
  • \n

    \n sun\n

    \n
    • \n
  • \n

    \n mon\n

    \n
    • \n
  • \n

    \n tue\n

    \n
    • \n
  • \n

    \n wed\n

    \n
    • \n
  • \n

    \n thu\n

    \n
    • \n
  • \n

    \n fri\n

    \n
    • \n
  • \n

    \n sat\n

    \n
    • \n
\n

Example: sun:23:00-mon:01:30\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.

\n

Valid values for ddd are:

\n
    \n
  • \n

    \n sun\n

    \n
    • \n
  • \n

    \n mon\n

    \n
    • \n
  • \n

    \n tue\n

    \n
    • \n
  • \n

    \n wed\n

    \n
    • \n
  • \n

    \n thu\n

    \n
    • \n
  • \n

    \n fri\n

    \n
    • \n
  • \n

    \n sat\n

    \n
    • \n
\n

Example: sun:23:00-mon:01:30\n

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

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.

\n \n

The Amazon SNS topic owner must be same as the replication group owner.

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

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are\n sent.

\n \n

The Amazon SNS topic owner must be same as the replication group owner.

\n " } }, "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The 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.

" + "smithy.api#documentation": "

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.

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

The status of the Amazon SNS notification topic for the replication group. \n Notifications are sent only if the status is active.

\n

Valid values: active | inactive\n

" + "smithy.api#documentation": "

The status of the Amazon SNS notification topic for the replication group.\n Notifications are sent only if the status is active.

\n

Valid values: active | inactive\n

" } }, "ApplyImmediately": { @@ -8224,25 +8305,25 @@ "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 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

\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

\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.

\n

Example: 05:00-09:00\n

\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.

\n

Example: 05:00-09:00\n

\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:

\n
    \n
  • \n

    Must be only printable ASCII characters

    \n
    • \n
  • \n

    Must be at least 16 characters and no more than 128 characters in length

    \n
    • \n
  • \n

    Cannot contain any of the following characters: '/', '\"', or '@', '%'

    \n
    • \n
\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:

\n
    \n
  • \n

    Must be only printable ASCII characters

    \n
    • \n
  • \n

    Must be at least 16 characters and no more than 128 characters in\n length

    \n
    • \n
  • \n

    Cannot contain any of the following characters: '/', '\"', or '@', '%'

    \n
    • \n
\n

For 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:

\n
    \n
  • \n

    Rotate

    \n
    • \n
  • \n

    Set

    \n
    • \n
\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:

\n
    \n
  • \n

    Rotate

    \n
    • \n
  • \n

    Set

    \n
    • \n
\n

For 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.

" + "smithy.api#documentation": "

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.

" } }, "TransitEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "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.

\n

You 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.

\n

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

" + "smithy.api#documentation": "

A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.

\n

You 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.

\n

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.

" } }, "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.

" } } }, @@ -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.

\n

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.

\n

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.

\n

You can specify this parameter only if the value of NodeGroupCount\n is greater than the current number of node groups (shards).

" + "smithy.api#documentation": "

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.

\n

You can specify this parameter only if the value of NodeGroupCount is\n greater than the current number of node groups (shards).

" } }, "NodeGroupsToRemove": { "target": "com.amazonaws.elasticache#NodeGroupsToRemoveList", "traits": { - "smithy.api#documentation": "

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.

\n

ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove\n from the cluster.

" + "smithy.api#documentation": "

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.

\n

ElastiCache for Redis will attempt to remove all node groups listed by\n NodeGroupsToRemove from the cluster.

" } }, "NodeGroupsToRetain": { "target": "com.amazonaws.elasticache#NodeGroupsToRetainList", "traits": { - "smithy.api#documentation": "

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.

\n

ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain\n from the cluster.

" + "smithy.api#documentation": "

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.

\n

ElastiCache for Redis will attempt to remove all node groups except those listed by\n NodeGroupsToRetain from the cluster.

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

Represents the input for a ModifyReplicationGroupShardConfiguration operation.

" + "smithy.api#documentation": "

Represents the input for a ModifyReplicationGroupShardConfiguration\n operation.

" } }, "com.amazonaws.elasticache#ModifyReplicationGroupShardConfigurationResult": { @@ -8423,6 +8507,9 @@ "ReplicationGroup": { "target": "com.amazonaws.elasticache#ReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#ModifyUser": { @@ -8627,13 +8714,13 @@ "NodeGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

The current state of this replication group - creating,\n available, modifying, deleting.

" } }, "PrimaryEndpoint": { @@ -8657,12 +8744,12 @@ "NodeGroupMembers": { "target": "com.amazonaws.elasticache#NodeGroupMemberList", "traits": { - "smithy.api#documentation": "

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.

\n

Example: \"0-3999\"\n

" + "smithy.api#documentation": "

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.

\n

Example: \"0-3999\"\n

" } }, "ReplicaCount": { @@ -8689,13 +8776,13 @@ "PrimaryAvailabilityZone": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "PrimaryOutpostArn": { @@ -8712,7 +8799,7 @@ } }, "traits": { - "smithy.api#documentation": "

Node group (shard) configuration options. \n Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.

" + "smithy.api#documentation": "

Node group (shard) configuration options. Each node group (shard) configuration has\n the following: Slots, PrimaryAvailabilityZone,\n ReplicaAvailabilityZones, ReplicaCount.

" } }, "com.amazonaws.elasticache#NodeGroupConfigurationList": { @@ -8745,7 +8832,7 @@ "CacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

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.

" + "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\n disabled) replication groups.

" } } }, @@ -8828,7 +8915,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": { @@ -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.

", + "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\n NodeGroupId value correctly.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -8915,7 +9002,7 @@ "code": "NodeGroupsPerReplicationGroupQuotaExceeded", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The request cannot be processed because it would exceed the maximum allowed number\n of node groups (shards) in a single replication group. The default maximum is 90

", + "smithy.api#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.

" + "smithy.api#documentation": "

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.

" } }, "MinimumEngineVersion": { @@ -9196,12 +9283,12 @@ "ChangeType": { "target": "com.amazonaws.elasticache#ChangeType", "traits": { - "smithy.api#documentation": "

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.

\n

For 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.

\n

For 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.

\n \n

The 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.

\n \n

Example: myreservationID

" + "smithy.api#documentation": "

A customer-specified identifier to track this reservation.

\n \n

The 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.

\n \n

Example: 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.

" + "smithy.api#documentation": "

Represents the input of a PurchaseReservedCacheNodesOffering\n operation.

" } }, "com.amazonaws.elasticache#PurchaseReservedCacheNodesOfferingResult": { @@ -9494,6 +9581,9 @@ "ReservedCacheNode": { "target": "com.amazonaws.elasticache#ReservedCacheNode" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#RebalanceSlotsInGlobalReplicationGroup": { @@ -9516,7 +9606,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

\n

The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

\n

When the reboot is complete, a cluster event is created.

\n

Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters.\n Rebooting is not supported on Redis (cluster mode enabled) clusters.

\n

If 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.

\n

The reboot causes the contents of the cache (for each cache node being rebooted) to be\n lost.

\n

When the reboot is complete, a cluster event is created.

\n

Rebooting 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.

\n

If 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.

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

A list of PreferredAvailabilityZones objects that specifies the\n configuration of a node group in the resharded cluster.

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

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.

" + "smithy.api#documentation": "

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.

" } }, "com.amazonaws.elasticache#RemoveTagsFromResourceMessage": { @@ -9727,14 +9823,14 @@ "ResourceName": { "target": "com.amazonaws.elasticache#String", "traits": { - "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 \n or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

\n

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.

\n

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.

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

A list of TagKeys identifying the tags you want removed from the named\n resource.

", "smithy.api#required": {} } } @@ -9770,19 +9866,19 @@ "GlobalReplicationGroupInfo": { "target": "com.amazonaws.elasticache#GlobalReplicationGroupInfo", "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.

" } }, "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.

" + "smithy.api#documentation": "

The current state of this replication group - creating,\n available, modifying, deleting,\n create-failed, snapshotting.

" } }, "PendingModifiedValues": { "target": "com.amazonaws.elasticache#ReplicationGroupPendingModifiedValues", "traits": { - "smithy.api#documentation": "

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 \n

\n If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

\n " + "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 \n

If the value of SnapshotRetentionLimit is set to zero (0), backups\n are turned off.

\n " } }, "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).

\n

Example: 05:00-09:00\n

\n

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

\n \n

This parameter is only valid if the Engine parameter is redis.

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

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your node group (shard).

\n

Example: 05:00-09:00\n

\n

If you do not specify this parameter, ElastiCache automatically chooses an appropriate\n time range.

\n \n

This parameter is only valid if the Engine parameter is\n redis.

\n " } }, "ClusterEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

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).

\n

Valid values: true | false\n

" + "smithy.api#documentation": "

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).

\n

Valid values: true | false\n

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

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.

\n

Default: false\n

" + "smithy.api#documentation": "

A flag that enables using an AuthToken (password) when issuing Redis\n commands.

\n

Default: false\n

" } }, "AuthTokenLastModifiedDate": { @@ -9860,13 +9956,13 @@ "TransitEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

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.

\n

Default: false\n

" + "smithy.api#documentation": "

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.

\n

Default: false\n

" } }, "AtRestEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

A flag that enables encryption at-rest when set to true.

\n

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

\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

\n

Default: false\n

" + "smithy.api#documentation": "

A flag that enables encryption at-rest when set to true.

\n

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

\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.

\n

Default: false\n

" } }, "MemberClustersOutpostArns": { @@ -9908,38 +10004,38 @@ "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.

" } }, "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.

" + "smithy.api#documentation": "

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.

" } }, "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.

" + "smithy.api#documentation": "

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.

" } }, "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.

" } }, "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.

" + "smithy.api#documentation": "

The primary cluster ID that is applied immediately (if\n --apply-immediately was specified), or during the next maintenance\n window.

" } }, "AutomaticFailoverStatus": { @@ -10113,18 +10209,18 @@ "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.

" } }, "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.

\n

The 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.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \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

      \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

      \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

      \n
      • \n
    • \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

      \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

      \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

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous 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

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \n
      • \n
    • \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

      \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
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1 instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.

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

The cache node type for the reserved cache nodes.

\n

The 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.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \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

      \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

      \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

      \n
      • \n
    • \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

      \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

      \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

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous 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

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \n
      • \n
    • \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

      \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
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and\n appendfsync are not supported on Redis version 2.8.22 and\n later.

    \n
    • \n
" } }, "StartTime": { @@ -10209,12 +10305,12 @@ "ReservationARN": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the reserved cache node.

\n

Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the reserved cache node.

\n

Example:\n arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582\n

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

Represents the output of a PurchaseReservedCacheNodesOffering operation.

" + "smithy.api#documentation": "

Represents the output of a PurchaseReservedCacheNodesOffering\n operation.

" } }, "com.amazonaws.elasticache#ReservedCacheNodeAlreadyExistsFault": { @@ -10255,7 +10351,7 @@ "ReservedCacheNodes": { "target": "com.amazonaws.elasticache#ReservedCacheNodeList", "traits": { - "smithy.api#documentation": "

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.

\n

The 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.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \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

      \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

      \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

      \n
      • \n
    • \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

      \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

      \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

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous 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

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \n
      • \n
    • \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

      \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
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1 instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.

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

The cache node type for the reserved cache node.

\n

The 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.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \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

      \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

      \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

      \n
      • \n
    • \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

      \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

      \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

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous 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

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \n
      • \n
    • \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

      \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
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and\n appendfsync are not supported on Redis version 2.8.22 and\n later.

    \n
    • \n
" } }, "Duration": { @@ -10377,12 +10473,12 @@ "ReservedCacheNodesOfferings": { "target": "com.amazonaws.elasticache#ReservedCacheNodesOfferingList", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

Represents the output of a DescribeReservedCacheNodesOfferings\n operation.

" } }, "com.amazonaws.elasticache#ReservedCacheNodesOfferingNotFoundFault": { @@ -10428,7 +10524,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "com.amazonaws.elasticache#ResetCacheParameterGroupMessage": { @@ -10445,13 +10541,13 @@ "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

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.

\n

Valid values: true | false\n

" + "smithy.api#documentation": "

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.

\n

Valid values: true | false\n

" } }, "ParameterNameValues": { "target": "com.amazonaws.elasticache#ParameterNameValueList", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } } }, @@ -10465,7 +10561,7 @@ "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.

" } }, "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.

" + "smithy.api#documentation": "

A list of PreferredAvailabilityZones objects that specifies the\n configuration of a node group in the resharded cluster.

" } }, "com.amazonaws.elasticache#ReshardingConfigurationList": { @@ -10528,7 +10624,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

Represents the input of a RevokeCacheSecurityGroupIngress\n operation.

" } }, "com.amazonaws.elasticache#RevokeCacheSecurityGroupIngressResult": { @@ -10566,6 +10662,9 @@ "CacheSecurityGroup": { "target": "com.amazonaws.elasticache#CacheSecurityGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#SecurityGroupIdsList": { @@ -10589,7 +10688,7 @@ "Status": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

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.

" + "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.

" } }, "ServiceUpdates": { @@ -10862,7 +10961,7 @@ "SnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

The status of the snapshot. Valid values: creating |\n available | restoring | copying |\n deleting.

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

Indicates whether the snapshot is from an automatic backup (automated) \n or was created manually (manual).

" + "smithy.api#documentation": "

Indicates whether the snapshot is from an automatic backup (automated) or\n was created manually (manual).

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

The name of the compute and memory capacity node type for the source cluster.

\n

The 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.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \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

      \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

      \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

      \n
      • \n
    • \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

      \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

      \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

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous 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

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \n
      • \n
    • \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

      \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
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1 instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and \n\t\t\t\tappendfsync are not supported on Redis version 2.8.22 and later.

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

The name of the compute and memory capacity node type for the source cluster.

\n

The 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.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \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

      \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

      \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

      \n
      • \n
    • \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

      \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

      \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

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous 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

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current 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

      \n \n

      For region availability, see Supported Node Types\n

      \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

      \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

      \n
      • \n
    • \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

      \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
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Redis append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    Redis configuration variables appendonly and\n appendfsync are not supported on Redis version 2.8.22 and\n later.

    \n
    • \n
" } }, "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the cache engine (memcached or \n redis) used by the source cluster.

" + "smithy.api#documentation": "

The name of the cache engine (memcached or redis) used by\n the source cluster.

" } }, "EngineVersion": { @@ -10916,7 +11015,7 @@ "NumCacheNodes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of cache nodes in the source cluster.

\n

For 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.

\n

For 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.

\n

Valid values for ddd are:

\n
    \n
  • \n

    \n sun\n

    \n
    • \n
  • \n

    \n mon\n

    \n
    • \n
  • \n

    \n tue\n

    \n
    • \n
  • \n

    \n wed\n

    \n
    • \n
  • \n

    \n thu\n

    \n
    • \n
  • \n

    \n fri\n

    \n
    • \n
  • \n

    \n sat\n

    \n
    • \n
\n

Example: sun:23:00-mon:01:30\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.

\n

Valid values for ddd are:

\n
    \n
  • \n

    \n sun\n

    \n
    • \n
  • \n

    \n mon\n

    \n
    • \n
  • \n

    \n tue\n

    \n
    • \n
  • \n

    \n wed\n

    \n
    • \n
  • \n

    \n thu\n

    \n
    • \n
  • \n

    \n fri\n

    \n
    • \n
  • \n

    \n sat\n

    \n
    • \n
\n

Example: sun:23:00-mon:01:30\n

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

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.

\n

For 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

\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.

\n

For 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

\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:

\n
    \n
  • \n

    Creating a snapshot of a Redis cluster running on a cache.t1.micro cache\n node.

    \n
    • \n
  • \n

    Creating a snapshot of a cluster that is running Memcached rather than Redis.

    \n
    • \n
\n

Neither of these are supported by ElastiCache.

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

You attempted one of the following operations:

\n
    \n
  • \n

    Creating a snapshot of a Redis cluster running on a\n cache.t1.micro cache node.

    \n
    • \n
  • \n

    Creating a snapshot of a cluster that is running Memcached rather than\n Redis.

    \n
    • \n
\n

Neither 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.

" + "smithy.api#documentation": "

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.

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

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.

" + "smithy.api#documentation": "

Represents the output from the AddTagsToResource,\n ListTagsForResource, and RemoveTagsFromResource\n operations.

" } }, "com.amazonaws.elasticache#TagNotFoundFault": { @@ -11398,7 +11497,7 @@ "code": "TagQuotaPerResourceExceeded", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

", + "smithy.api#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).

\n

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

\n
    \n
  • \n

    A 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.

    \n
    • \n
  • \n

    If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.

    \n

    \n
    • \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.

    \n
    • \n
  • \n

    To 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:

    \n
      \n
    1. \n

      Replication group message: Test Failover API called for node group \n

      \n
      2. \n
    2. \n

      Cache cluster message: Failover from primary node to replica node completed\n

      \n
      3. \n
    3. \n

      Replication group message: Failover from primary node to replica node completed\n

      \n
      4. \n
    4. \n

      Cache cluster message: Recovering cache nodes \n

      \n
      5. \n
    5. \n

      Cache cluster message: Finished recovery for cache nodes \n

      \n
      6. \n
    \n

    For more information see:

    \n \n
    • \n
\n

Also 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).

\n

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

\n
    \n
  • \n

    A 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.

    \n
    • \n
  • \n

    If 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
    • \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.

    \n
    • \n
  • \n

    To 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:

    \n
      \n
    1. \n

      Replication group message: Test Failover API called for node\n group \n

      \n
      2. \n
    2. \n

      Cache cluster message: Failover from primary node\n to replica node \n completed\n

      \n
      3. \n
    3. \n

      Replication group message: Failover from primary node\n to replica node \n completed\n

      \n
      4. \n
    4. \n

      Cache cluster message: Recovering cache nodes\n \n

      \n
      5. \n
    5. \n

      Cache cluster message: Finished recovery for cache nodes\n \n

      \n
      6. \n
    \n

    For more information see:

    \n \n
    • \n
\n

Also 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.

" + "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.

" } }, "UpdateActions": { @@ -11890,7 +12048,7 @@ "Status": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

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/aws-models/fsx.json b/codegen/sdk/aws-models/fsx.json index 2896b60298a7..f22591de0376 100644 --- a/codegen/sdk/aws-models/fsx.json +++ b/codegen/sdk/aws-models/fsx.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
  • \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
    • \n
  • \n

    \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.

    \n
      \n
    • \n

      For Windows and ONTAP, storage optimization is the process of migrating the file system data\n to newer larger disks.

      \n
      • \n
    • \n

      For Lustre, storage optimization consists of rebalancing the data across the existing and\n newly added file servers.

      \n
      • \n
    \n

    You 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
    • \n
  • \n

    \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
    • \n
  • \n

    \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
    • \n
  • \n

    \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
    • \n
  • \n

    \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
    • \n
  • \n

    \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
    • \n
  • \n

    \n RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System\n (NFS) V3 locks on an Amazon FSx for OpenZFS file system.

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

Describes the type of administrative action, as follows:

\n
    \n
  • \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
    • \n
  • \n

    \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.

    \n

    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
    • \n
  • \n

    \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.

    \n
      \n
    • \n

      For Windows and ONTAP, storage optimization is the process of migrating the file system data\n to newer larger disks.

      \n
      • \n
    • \n

      For Lustre, storage optimization consists of rebalancing the data across the existing and\n newly added file servers.

      \n
      • \n
    \n

    You 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
    • \n
  • \n

    \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
    • \n
  • \n

    \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
    • \n
  • \n

    \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.

    \n

    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
    • \n
  • \n

    \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.

    \n

    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
    • \n
  • \n

    \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
    • \n
  • \n

    \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
    • \n
  • \n

    \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
    • \n
  • \n

    \n RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System\n (NFS) V3 locks on an Amazon FSx for OpenZFS file system.

    \n
    • \n
" } }, "com.amazonaws.fsx#AdministrativeActions": { @@ -2053,7 +2035,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

\n
    \n
  • \n

    Any files that FSx has already exported are not reverted.

    \n
    • \n
  • \n

    FSx continues to export any files that are \"in-flight\" when the cancel operation is received.

    \n
    • \n
  • \n

    FSx does not export any files that have not yet been exported.

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

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 am export task, Amazon FSx\n does the following.

\n
    \n
  • \n

    Any files that FSx has already exported are not reverted.

    \n
    • \n
  • \n

    FSx continues to export any files that are in-flight when the cancel operation is received.

    \n
    • \n
  • \n

    FSx does not export any files that have not yet been exported.

    \n
    • \n
\n

For 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.

\n

You 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).

\n

You can also use backup copies to clone your file dataset to another Region or within\n the same Region.

\n

You 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).

\n

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.

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

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.

\n

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.

\n

You 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.

\n

To 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
  • \n

    \n EXPORT_TO_REPOSITORY tasks export from your\n Amazon FSx for Lustre file system to a linked data repository.

    \n
    • \n
  • \n

    \n IMPORT_METADATA_FROM_REPOSITORY tasks import metadata\n changes from a linked S3 bucket to your Amazon FSx for Lustre file system.

    \n
    • \n
  • \n

    \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
    • \n
  • \n

    \n AUTO_RELEASE_DATA tasks automatically release files from\n an Amazon File Cache resource.

    \n
    • \n
", "smithy.api#required": {} } }, "Paths": { "target": "com.amazonaws.fsx#DataRepositoryTaskPaths", "traits": { - "smithy.api#documentation": "

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.

\n
    \n
  • \n

    For 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.

    \n
    • \n
  • \n

    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).

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

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).

\n
    \n
  • \n

    For 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.

    \n
    • \n
  • \n

    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

    \n
    • \n
  • \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.

    \n \n

    A file must also meet the last accessed time criteria\n specified in for the\n file to be released.

    \n     \n
    • \n
" } }, "FileSystemId": { @@ -2524,6 +2546,12 @@ "traits": { "smithy.api#documentation": "

Specifies 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.

" } + }, + "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": { @@ -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
  • \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
    • \n
  • \n

    \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.

    \n
    • \n
\n

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
  • \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
    • \n
  • \n

    \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
    • \n
  • \n

    \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.

    \n
    • \n
\n

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.

" + } + }, + "EndpointIpAddressRange": { + "target": "com.amazonaws.fsx#IpAddressRange", + "traits": { + "smithy.api#documentation": "

(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.

\n

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.

\n

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
  • \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
    • \n
  • \n

    \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.

    \n
    • \n
", + "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
  • \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
    • \n
  • \n

    \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.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -4126,7 +4178,7 @@ "Type": { "target": "com.amazonaws.fsx#DataRepositoryTaskType", "traits": { - "smithy.api#documentation": "

The type of data repository task.

\n
    \n
  • \n

    \n EXPORT_TO_REPOSITORY tasks export from your\n Amazon FSx for Lustre file system to a linked data repository.

    \n
    • \n
  • \n

    \n IMPORT_METADATA_FROM_REPOSITORY tasks import metadata\n changes from a linked S3 bucket to your Amazon FSx for Lustre file system.

    \n
    • \n
  • \n

    \n AUTO_RELEASE_DATA tasks automatically release files from\n an Amazon File Cache resource.

    \n
    • \n
  • \n

    \n RELEASE_DATA_FROM_FILESYSTEM tasks are not supported.

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

The type of data repository task.

\n
    \n
  • \n

    \n EXPORT_TO_REPOSITORY tasks export from your\n Amazon FSx for Lustre file system to a linked data repository.

    \n
    • \n
  • \n

    \n IMPORT_METADATA_FROM_REPOSITORY tasks import metadata\n changes from a linked S3 bucket to your Amazon FSx for Lustre file system.

    \n
    • \n
  • \n

    \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
    • \n
  • \n

    \n AUTO_RELEASE_DATA tasks automatically release files from\n an Amazon File Cache resource.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -4192,10 +4244,16 @@ "traits": { "smithy.api#documentation": "

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.

\n
    \n
  • \n

    You 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.

    \n
    • \n
  • \n

    You use release data repository tasks to release archived files\n from your Amazon FSx for Lustre file system.

    \n
    • \n
  • \n

    An Amazon File Cache resource uses a task to automatically\n release files from the cache.

    \n
    • \n
\n

To 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.

\n

The DeleteBackup call returns instantly. The backup won't show up in\n later DescribeBackups calls.

\n \n

The data in a deleted backup is also deleted and can't be recovered by any\n means.

\n ", + "smithy.api#examples": [ + { + "title": "To delete a backup", + "documentation": "This operation deletes an Amazon FSx file system backup.", + "input": { + "BackupId": "backup-03e3c82e0183b7b6b" + }, + "output": { + "BackupId": "backup-03e3c82e0183b7b6b", + "Lifecycle": "DELETED" + } + } + ], "smithy.api#idempotent": {} } }, @@ -4734,6 +4805,19 @@ ], "traits": { "smithy.api#documentation": "

Deletes 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.

\n

To 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.

\n

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.

\n

The 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.

\n \n

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).

\n \n \n

The data in a deleted file system is also deleted and can't be recovered by\n any means.

\n ", + "smithy.api#examples": [ + { + "title": "To delete a file system", + "documentation": "This operation deletes an Amazon FSx file system.", + "input": { + "FileSystemId": "fs-0498eed5fe91001ec" + }, + "output": { + "FileSystemId": "fs-0498eed5fe91001ec", + "Lifecycle": "DELETING" + } + } + ], "smithy.api#idempotent": {} } }, @@ -5147,7 +5231,7 @@ "BypassSnaplockEnterpriseRetention": { "target": "com.amazonaws.fsx#Flag", "traits": { - "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.

\n

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.

\n

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.

" + } + }, + "Value": { + "target": "com.amazonaws.fsx#Value", + "traits": { + "smithy.api#documentation": "

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.

\n \n

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.

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

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.

\n

When 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.

\n

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.

\n

When using this action, keep the following in mind:

\n
    \n
  • \n

    The implementation might return fewer than MaxResults file\n system descriptions while still including a NextToken\n value.

    \n
    • \n
  • \n

    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.

    \n
    • \n
", + "smithy.api#examples": [ + { + "title": "To list tags for a resource", + "documentation": "This operation lists tags for an Amazon FSx resource.", + "input": { + "ResourceARN": "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec" + }, + "output": { + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8170,6 +8291,12 @@ "traits": { "smithy.api#enumValue": "SINGLE_AZ_2" } + }, + "MULTI_AZ_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_AZ_1" + } } } }, @@ -8197,7 +8324,7 @@ "DeploymentType": { "target": "com.amazonaws.fsx#OpenZFSDeploymentType", "traits": { - "smithy.api#documentation": "

Specifies the file-system deployment type. Amazon FSx for OpenZFS supports\u2028 SINGLE_AZ_1 and SINGLE_AZ_2.

" + "smithy.api#documentation": "

Specifies the file-system deployment type. Amazon FSx for OpenZFS supports\u2028 MULTI_AZ_1, SINGLE_AZ_1, and SINGLE_AZ_2.

" } }, "ThroughputCapacity": { @@ -8217,6 +8344,30 @@ "traits": { "smithy.api#documentation": "

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.

" + } + }, + "EndpointIpAddressRange": { + "target": "com.amazonaws.fsx#IpAddressRange", + "traits": { + "smithy.api#documentation": "

(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.

\n

Only 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.

\n \n

If 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.

\n " + } + }, "com.amazonaws.fsx#ReleaseFileSystemNfsV3Locks": { "type": "operation", "input": { @@ -9200,7 +9365,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.

\n

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.

\n

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
  • \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
    • \n
  • \n

    \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.

    \n
    • \n
" + "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
  • \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
    • \n
  • \n

    \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.

    \n
    • \n
" } }, "VolumeAppendModeEnabled": { @@ -10046,6 +10211,21 @@ ], "traits": { "smithy.api#documentation": "

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.

\n

For FSx for Windows File Server file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AuditLogConfiguration\n

    \n
    • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
    • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
    • \n
  • \n

    \n SelfManagedActiveDirectoryConfiguration\n

    \n
    • \n
  • \n

    \n StorageCapacity\n

    \n
    • \n
  • \n

    \n ThroughputCapacity\n

    \n
    • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
    • \n
\n

For FSx for Lustre file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AutoImportPolicy\n

    \n
    • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
    • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
    • \n
  • \n

    \n DataCompressionType\n

    \n
    • \n
  • \n

    \n LogConfiguration\n

    \n
    • \n
  • \n

    \n LustreRootSquashConfiguration\n

    \n
    • \n
  • \n

    \n StorageCapacity\n

    \n
    • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
    • \n
\n

For FSx for ONTAP file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AddRouteTableIds\n

    \n
    • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
    • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
    • \n
  • \n

    \n DiskIopsConfiguration\n

    \n
    • \n
  • \n

    \n FsxAdminPassword\n

    \n
    • \n
  • \n

    \n RemoveRouteTableIds\n

    \n
    • \n
  • \n

    \n StorageCapacity\n

    \n
    • \n
  • \n

    \n ThroughputCapacity\n

    \n
    • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
    • \n
\n

For FSx for OpenZFS file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
    • \n
  • \n

    \n CopyTagsToBackups\n

    \n
    • \n
  • \n

    \n CopyTagsToVolumes\n

    \n
    • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
    • \n
  • \n

    \n DiskIopsConfiguration\n

    \n
    • \n
  • \n

    \n StorageCapacity\n

    \n
    • \n
  • \n

    \n ThroughputCapacity\n

    \n
    • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
    • \n
" + "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.

\n

For FSx for Windows File Server file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AuditLogConfiguration\n

    \n
    • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
    • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
    • \n
  • \n

    \n SelfManagedActiveDirectoryConfiguration\n

    \n
    • \n
  • \n

    \n StorageCapacity\n

    \n
    • \n
  • \n

    \n StorageType\n

    \n
    • \n
  • \n

    \n ThroughputCapacity\n

    \n
    • \n
  • \n

    \n DiskIopsConfiguration\n

    \n
    • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
    • \n
\n

For FSx for Lustre file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AutoImportPolicy\n

    \n
    • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
    • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
    • \n
  • \n

    \n DataCompressionType\n

    \n
    • \n
  • \n

    \n LogConfiguration\n

    \n
    • \n
  • \n

    \n LustreRootSquashConfiguration\n

    \n
    • \n
  • \n

    \n StorageCapacity\n

    \n
    • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
    • \n
\n

For FSx for ONTAP file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AddRouteTableIds\n

    \n
    • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
    • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
    • \n
  • \n

    \n DiskIopsConfiguration\n

    \n
    • \n
  • \n

    \n FsxAdminPassword\n

    \n
    • \n
  • \n

    \n RemoveRouteTableIds\n

    \n
    • \n
  • \n

    \n StorageCapacity\n

    \n
    • \n
  • \n

    \n ThroughputCapacity\n

    \n
    • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
    • \n
\n

For FSx for OpenZFS file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
    • \n
  • \n

    \n CopyTagsToBackups\n

    \n
    • \n
  • \n

    \n CopyTagsToVolumes\n

    \n
    • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
    • \n
  • \n

    \n DiskIopsConfiguration\n

    \n
    • \n
  • \n

    \n StorageCapacity\n

    \n
    • \n
  • \n

    \n ThroughputCapacity\n

    \n
    • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
    • \n
" } }, "com.amazonaws.fsx#UpdateFileSystemLustreConfiguration": { @@ -10590,6 +10793,18 @@ }, "DiskIopsConfiguration": { "target": "com.amazonaws.fsx#DiskIopsConfiguration" + }, + "AddRouteTableIds": { + "target": "com.amazonaws.fsx#RouteTableIds", + "traits": { + "smithy.api#documentation": "

(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.

\n

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.

\n

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.

\n

The 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.

\n

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.

\n

The 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.

\n

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.

\n

The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis\n Data Firehose delivery stream ARN, with the following requirements:

\n
    \n
  • \n

    The 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.

    \n
    • \n
  • \n

    The 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.

    \n
    • \n
  • \n

    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.

    \n
    • \n
  • \n

    If AuditLogDestination is provided and the resource does not\n exist, the request will fail with a BadRequest error.

    \n
    • \n
  • \n

    If FileAccessAuditLogLevel and FileShareAccessAuditLogLevel\n are both set to DISABLED, you cannot specify a destination in\n AuditLogDestination.

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

The Amazon Resource Name (ARN) that specifies the destination of the audit logs.

\n

The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis\n Data Firehose delivery stream ARN, with the following requirements:

\n
    \n
  • \n

    The 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.

    \n
    • \n
  • \n

    The 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.

    \n
    • \n
  • \n

    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.

    \n
    • \n
  • \n

    If AuditLogDestination is provided and the resource does not\n exist, the request will fail with a BadRequest error.

    \n
    • \n
  • \n

    If FileAccessAuditLogLevel and FileShareAccessAuditLogLevel\n are both set to DISABLED, you cannot specify a destination in\n AuditLogDestination.

    \n
    • \n
" } } }, @@ -11569,6 +11801,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": { diff --git a/codegen/sdk/aws-models/global-accelerator.json b/codegen/sdk/aws-models/global-accelerator.json index 5b682ea9b232..ea3cded2c0cc 100644 --- a/codegen/sdk/aws-models/global-accelerator.json +++ b/codegen/sdk/aws-models/global-accelerator.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\t

If 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.

\n

If 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\t

The 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.

\n

If 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.

\n\t\t

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.

\n

The 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.

\n

If 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.

\n

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\t

The 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\t

Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses.

\n\t\t

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.

\n

The 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

Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses.

\n

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.

\n\t\t

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.

\n

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.

\n\t\t

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\t

s3-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.

\n

If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:

\n

s3-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\t

The 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\t

Note: 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\t

By 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.

\n

The 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

Note: 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

By 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).

\n\t\t

There are two advantages to using AddEndpoints to add endpoints:

\n\t\t\t
    \n
  • \n

    It's faster, because Global Accelerator only has to resolve the new endpoints that\n\t\t\t\t\tyou're adding.

    \n
    • \n
  • \n

    It'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.

    \n
    • \n
" + "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).

\n

There are two advantages to using AddEndpoints to add endpoints in Global Accelerator:

\n
    \n
  • \n

    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.

    \n
    • \n
  • \n

    It'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.

    \n
    • \n
\n

For 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\t

To stop advertising the BYOIP address range, use \n\t\t\tWithdrawByoipCidr.

\n\t\t

For 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.

\n

To stop advertising the BYOIP address range, use \n\t\t\tWithdrawByoipCidr.

\n

For 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\t

After 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.

\n

After 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.

" + "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

\n DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is\n\t\tnot specified.

" } }, "DestinationPorts": { @@ -463,9 +481,12 @@ "AllowAllTrafficToEndpoint": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { - "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.

\n\t\t

When 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\t

When 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\t

The 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.

\n

When 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

When 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

The 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\t

The following describes each BYOIP State that your IP address range can be in.

\n\t\t
    \n
  • \n

    \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
  • \n

    \n READY — The address range is provisioned \n\t\t\t with Global Accelerator and can be advertised.

    \n
    • \n
  • \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
  • \n

    \n ADVERTISING — The address range is \n\t\t\t being advertised by Global Accelerator.

    \n
    • \n
  • \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
  • \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
  • \n

    \n DEPROVISIONED — The address range is deprovisioned \n\t\t\t from Global Accelerator.

    \n
    • \n
  • \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
  • \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
  • \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
  • \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.

    \n
    • \n
" + "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

The following describes each BYOIP State that your IP address range can be in.

\n
    \n
  • \n

    \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
  • \n

    \n READY — The address range is provisioned \n\t\t\t with Global Accelerator and can be advertised.

    \n
    • \n
  • \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
  • \n

    \n ADVERTISING — The address range is \n\t\t\t being advertised by Global Accelerator.

    \n
    • \n
  • \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
  • \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
  • \n

    \n DEPROVISIONED — The address range is deprovisioned \n\t\t\t from Global Accelerator.

    \n
    • \n
  • \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
  • \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
  • \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
  • \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.

    \n
    • \n
" } }, "com.amazonaws.globalaccelerator#ByoipCidrEvent": { @@ -655,7 +676,7 @@ } }, "traits": { - "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).

\n\t\t

For 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).

\n

For 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\t \n\t\t\t

Global 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.

\n\t\t " + "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.

\n \n

Global 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.

\n " } }, "com.amazonaws.globalaccelerator#CreateAcceleratorRequest": { @@ -730,13 +751,13 @@ "IpAddresses": { "target": "com.amazonaws.globalaccelerator#IpAddresses", "traits": { - "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.

\n\t

After 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\t

You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

\n\t\t

Note 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\t

For 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.

\n

After 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

You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

\n

Note 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

For 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\t

If 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.

\n

If 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\t

For more information, see Tagging\n\t\t in Global Accelerator in the Global Accelerator Developer Guide.

" + "smithy.api#documentation": "

Create tags for an accelerator.

\n

For 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\t

Be 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\t \n\t\t

Global 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.

\n\t " + "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

Be 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 \n

Global 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.

\n " } }, "com.amazonaws.globalaccelerator#CreateCustomRoutingAcceleratorRequest": { @@ -811,13 +838,13 @@ "IpAddresses": { "target": "com.amazonaws.globalaccelerator#IpAddresses", "traits": { - "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.

\n\t\t

After 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\t

You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

\n\t\t

Note 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\t

For 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.

\n

After 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

You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

\n

Note 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

For 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\t

If 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.

\n

If 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\t

For more information, see Tagging\n\t in Global Accelerator in the Global Accelerator Developer Guide.

" + "smithy.api#documentation": "

Create tags for an accelerator.

\n

For 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\t

Separately, 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.

\n

Separately, 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.

\n

For 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\t

Use 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\t

The 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.

\n

Use 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

The 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\t

For 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.

\n

For 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\t

Global 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.

\n\t\t

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.

\n\t\t

The default value is NONE.

" + "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

Global 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.

\n

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.

\n

The default value is NONE.

" } }, "IdempotencyToken": { @@ -1185,6 +1236,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#CreateListenerResponse": { @@ -1196,6 +1250,9 @@ "smithy.api#documentation": "

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\t

If 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.

\n

If 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\t

The 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\t

If 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.

\n\t\t

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.

\n

The 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

If 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.

\n

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.

\n\t\t

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.

\n

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.

\n\t\t

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\t

DOC-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.

\n

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

DOC-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\t

Separately, 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.

\n

Separately, 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.

\n\t \n

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\t

The 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.

\n " + "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.

\n \n

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

The 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.

\n " } }, "com.amazonaws.globalaccelerator#DeleteAcceleratorRequest": { @@ -1577,6 +1634,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DeleteCustomRoutingAccelerator": { @@ -1605,7 +1665,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delete 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.

\n \n

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\t

The 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.

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

Delete 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.

\n \n

When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. \n\t

\n

The 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.

\n " } }, "com.amazonaws.globalaccelerator#DeleteCustomRoutingAcceleratorRequest": { @@ -1618,6 +1678,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DeleteCustomRoutingEndpointGroup": { @@ -1653,6 +1716,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DeleteCustomRoutingListener": { @@ -1691,6 +1757,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DeleteEndpointGroup": { @@ -1726,6 +1795,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DeleteListener": { @@ -1764,6 +1836,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#DenyCustomRoutingTraffic": { @@ -1786,7 +1861,7 @@ } ], "traits": { - "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.

\n\t\t

After 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.

\n

After 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\t

When 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\t

When 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\t

The 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.

\n

When 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

When 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

The 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\t

Before 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\t

For 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.

\n

Before 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

For 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\t

An 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.

\n

An 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\t

If 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.

\n\n\t\t\n\t\t

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\t

For 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.

\n

If 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.

\n

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

For 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\t

An 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.

\n

An 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\t

If 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.

\n\n\t\t

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\t

For 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.

\n

If 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.

\n

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

For 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\t

Use 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\t

The 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.

\n

Use 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

The 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\t

The 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.

\n

The 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\t

An 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.

\n

An 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\t

If 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.

" + "smithy.api#documentation": "

Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false.

\n

If 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.

" } } }, @@ -2767,7 +2899,7 @@ "name": "globalaccelerator" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Global Accelerator\n\t

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\t

Global 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\t
    \n
  • \n

    By 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.

    \n
    • \n
  • \n

    For 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.

    \n
    • \n
\n\t\t \n\t\t

Global 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.

\n\t\t \n\t\t\n\t\t\n\t\t

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\t

For 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\t \n

The 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.

\n \n\t

For 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\t

For more information about understanding and using Global Accelerator, see the\n\t\t\tGlobal Accelerator Developer Guide.

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

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

Global 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
    \n
  • \n

    By 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.

    \n
    • \n
  • \n

    For 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.

    \n
    • \n
\n \n

Global 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.

\n \n

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

For 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 \n

The 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.

\n \n

For 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

For 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.

\n

If 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\t

The 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.

\n

If 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

The 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\t

For 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.

\n

For 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\t

Global 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.

\n\t\t

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.

\n\t\t

The default value is NONE.

" + "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

Global 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.

\n

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.

\n

The default value is NONE.

" } } }, @@ -4522,7 +4678,7 @@ } }, "traits": { - "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.

\n\t\t

For 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.

\n

For 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\t

For 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.

\n

For 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\t

The 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:

\n\t\t
    \n
  • \n

    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.

    \n
    • \n
  • \n

    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.

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

Remove endpoints from an endpoint group.

\n

The 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:

\n
    \n
  • \n

    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.

    \n
    • \n
  • \n

    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.

    \n
    • \n
" } }, "com.amazonaws.globalaccelerator#RemoveEndpointsRequest": { @@ -4748,6 +4913,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#ResourceArn": { @@ -4848,7 +5016,7 @@ } ], "traits": { - "smithy.api#documentation": "

Add tags to an accelerator resource.

\n\t\t

For 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.

\n

For 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\t

For 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.

\n

For 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\t \n\t\t\t

Global 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.

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

Update an accelerator to make changes, such as the following:

\n
    \n
  • \n

    Change the name of the accelerator.

    \n
    • \n
  • \n

    Disable the accelerator so that it no longer accepts or routes traffic, or so that you can delete it.

    \n
    • \n
  • \n

    Enable the accelerator, if it is disabled.

    \n
    • \n
  • \n

    Change the IP address type to dual-stack if it is IPv4, or change the IP address type to IPv4 if it's dual-stack.

    \n
    • \n
\n

Be 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.

\n \n

Global 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.

\n " } }, "com.amazonaws.globalaccelerator#UpdateAcceleratorAttributes": { @@ -5034,7 +5214,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\t\t\tFlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

\n\t\t

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.

\n

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.

\n\t\t

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\t

s3-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.

\n

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

s3-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\t

If 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.

\n

If 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.

\n\t

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.

\n

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.

\n\t

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\t

DOC-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.

\n

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

DOC-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\t

If 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.

\n

If 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\t

Separately, 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.

\n

Separately, 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\t

Use 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\t

The 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.

\n

Use 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

The 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\t

For 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.

\n

For 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\t

Global 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.

\n\t\t

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.

\n\t\t

The default value is NONE.

" + "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

Global 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.

\n

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.

\n

The default value is NONE.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.globalaccelerator#UpdateListenerResponse": { @@ -5461,6 +5680,9 @@ "smithy.api#documentation": "

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\t

It 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\t

For 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.

\n

It 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

For 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/aws-models/glue.json b/codegen/sdk/aws-models/glue.json index 65381faed2d0..45fe91c7cd15 100644 --- a/codegen/sdk/aws-models/glue.json +++ b/codegen/sdk/aws-models/glue.json @@ -714,52 +714,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", @@ -767,13 +771,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -783,224 +796,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://glue-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://glue-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://glue-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://glue-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://glue.{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://glue.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://glue.{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://glue.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -6051,7 +6015,7 @@ "ConnectionProperties": { "target": "com.amazonaws.glue#ConnectionProperties", "traits": { - "smithy.api#documentation": "

These key-value pairs define parameters for the connection:

\n
    \n
  • \n

    \n HOST - The host URI: either the\n fully qualified domain name (FQDN) or the IPv4 address of\n the database host.

    \n
    • \n
  • \n

    \n PORT - The port number, between\n 1024 and 65535, of the port on which the database host is\n listening for database connections.

    \n
    • \n
  • \n

    \n USER_NAME - The name under which\n to log in to the database. The value string for USER_NAME is \"USERNAME\".

    \n
    • \n
  • \n

    \n PASSWORD - A password,\n if one is used, for the user name.

    \n
    • \n
  • \n

    \n ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.

    \n
    • \n
  • \n

    \n JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the\n JAR file that contains the JDBC driver to use.

    \n
    • \n
  • \n

    \n JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.

    \n
    • \n
  • \n

    \n JDBC_ENGINE - The name of the JDBC engine to use.

    \n
    • \n
  • \n

    \n JDBC_ENGINE_VERSION - The version of the JDBC engine to use.

    \n
    • \n
  • \n

    \n CONFIG_FILES - (Reserved for future use.)

    \n
    • \n
  • \n

    \n INSTANCE_ID - The instance ID to use.

    \n
    • \n
  • \n

    \n JDBC_CONNECTION_URL - The URL for connecting to a JDBC data source.

    \n
    • \n
  • \n

    \n JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure\n Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the\n client. The default is false.

    \n
    • \n
  • \n

    \n CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.

    \n
    • \n
  • \n

    \n SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true to skip Glue’s validation of the customer certificate.

    \n
    • \n
  • \n

    \n CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate.

    \n
    • \n
  • \n

    \n CONNECTION_URL - The URL for connecting to a general (non-JDBC) data source.

    \n
    • \n
  • \n

    \n SECRET_ID - The secret ID used for the secret manager of credentials.

    \n
    • \n
  • \n

    \n CONNECTOR_URL - The connector URL for a MARKETPLACE or CUSTOM connection.

    \n
    • \n
  • \n

    \n CONNECTOR_TYPE - The connector type for a MARKETPLACE or CUSTOM connection.

    \n
    • \n
  • \n

    \n CONNECTOR_CLASS_NAME - The connector class name for a MARKETPLACE or CUSTOM connection.

    \n
    • \n
  • \n

    \n KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.

    \n
    • \n
  • \n

    \n KAFKA_SSL_ENABLED - Whether to enable or disable SSL on an Apache Kafka connection. Default value is \"true\".

    \n
    • \n
  • \n

    \n KAFKA_CUSTOM_CERT - The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.

    \n
    • \n
  • \n

    \n KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is \"false\".

    \n
    • \n
  • \n

    \n KAFKA_CLIENT_KEYSTORE - The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).

    \n
    • \n
  • \n

    \n KAFKA_CLIENT_KEYSTORE_PASSWORD - The password to access the provided keystore (Optional).

    \n
    • \n
  • \n

    \n KAFKA_CLIENT_KEY_PASSWORD - A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).

    \n
    • \n
  • \n

    \n ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD - The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).

    \n
    • \n
  • \n

    \n ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).

    \n
    • \n
  • \n

    \n KAFKA_SASL_MECHANISM - \"SCRAM-SHA-512\", \"GSSAPI\", or \"AWS_MSK_IAM\". These are the supported SASL Mechanisms.

    \n
    • \n
  • \n

    \n KAFKA_SASL_SCRAM_USERNAME - A plaintext username used to authenticate with the \"SCRAM-SHA-512\" mechanism.

    \n
    • \n
  • \n

    \n KAFKA_SASL_SCRAM_PASSWORD - A plaintext password used to authenticate with the \"SCRAM-SHA-512\" mechanism.

    \n
    • \n
  • \n

    \n ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).

    \n
    • \n
  • \n

    \n KAFKA_SASL_GSSAPI_KEYTAB - The S3 location of a Kerberos keytab file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.

    \n
    • \n
  • \n

    \n KAFKA_SASL_GSSAPI_KRB5_CONF - The S3 location of a Kerberos krb5.conf file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.

    \n
    • \n
  • \n

    \n KAFKA_SASL_GSSAPI_SERVICE - The Kerberos service name, as set with sasl.kerberos.service.name in your Kafka Configuration.

    \n
    • \n
  • \n

    \n KAFKA_SASL_GSSAPI_PRINCIPAL - The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.

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

These key-value pairs define parameters for the connection:

\n
    \n
  • \n

    \n HOST - The host URI: either the\n fully qualified domain name (FQDN) or the IPv4 address of\n the database host.

    \n
    • \n
  • \n

    \n PORT - The port number, between\n 1024 and 65535, of the port on which the database host is\n listening for database connections.

    \n
    • \n
  • \n

    \n USER_NAME - The name under which\n to log in to the database. The value string for USER_NAME is \"USERNAME\".

    \n
    • \n
  • \n

    \n PASSWORD - A password,\n if one is used, for the user name.

    \n
    • \n
  • \n

    \n ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.

    \n
    • \n
  • \n

    \n JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the\n JAR file that contains the JDBC driver to use.

    \n
    • \n
  • \n

    \n JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.

    \n
    • \n
  • \n

    \n JDBC_ENGINE - The name of the JDBC engine to use.

    \n
    • \n
  • \n

    \n JDBC_ENGINE_VERSION - The version of the JDBC engine to use.

    \n
    • \n
  • \n

    \n CONFIG_FILES - (Reserved for future use.)

    \n
    • \n
  • \n

    \n INSTANCE_ID - The instance ID to use.

    \n
    • \n
  • \n

    \n JDBC_CONNECTION_URL - The URL for connecting to a JDBC data source.

    \n
    • \n
  • \n

    \n JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure\n Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the\n client. The default is false.

    \n
    • \n
  • \n

    \n CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.

    \n
    • \n
  • \n

    \n SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true to skip Glue’s validation of the customer certificate.

    \n
    • \n
  • \n

    \n CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate.

    \n
    • \n
  • \n

    \n CONNECTION_URL - The URL for connecting to a general (non-JDBC) data source.

    \n
    • \n
  • \n

    \n SECRET_ID - The secret ID used for the secret manager of credentials.

    \n
    • \n
  • \n

    \n CONNECTOR_URL - The connector URL for a MARKETPLACE or CUSTOM connection.

    \n
    • \n
  • \n

    \n CONNECTOR_TYPE - The connector type for a MARKETPLACE or CUSTOM connection.

    \n
    • \n
  • \n

    \n CONNECTOR_CLASS_NAME - The connector class name for a MARKETPLACE or CUSTOM connection.

    \n
    • \n
  • \n

    \n KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.

    \n
    • \n
  • \n

    \n KAFKA_SSL_ENABLED - Whether to enable or disable SSL on an Apache Kafka connection. Default value is \"true\".

    \n
    • \n
  • \n

    \n KAFKA_CUSTOM_CERT - The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.

    \n
    • \n
  • \n

    \n KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is \"false\".

    \n
    • \n
  • \n

    \n KAFKA_CLIENT_KEYSTORE - The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).

    \n
    • \n
  • \n

    \n KAFKA_CLIENT_KEYSTORE_PASSWORD - The password to access the provided keystore (Optional).

    \n
    • \n
  • \n

    \n KAFKA_CLIENT_KEY_PASSWORD - A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).

    \n
    • \n
  • \n

    \n ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD - The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected).

    \n
    • \n
  • \n

    \n ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected).

    \n
    • \n
  • \n

    \n KAFKA_SASL_MECHANISM - \"SCRAM-SHA-512\", \"GSSAPI\", or \"AWS_MSK_IAM\". These are the supported SASL Mechanisms.

    \n
    • \n
  • \n

    \n KAFKA_SASL_SCRAM_USERNAME - A plaintext username used to authenticate with the \"SCRAM-SHA-512\" mechanism.

    \n
    • \n
  • \n

    \n KAFKA_SASL_SCRAM_PASSWORD - A plaintext password used to authenticate with the \"SCRAM-SHA-512\" mechanism.

    \n
    • \n
  • \n

    \n ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected).

    \n
    • \n
  • \n

    \n KAFKA_SASL_SCRAM_SECRETS_ARN - The Amazon Resource Name of a secret in Amazon Web Services Secrets Manager.

    \n
    • \n
  • \n

    \n KAFKA_SASL_GSSAPI_KEYTAB - The S3 location of a Kerberos keytab file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.

    \n
    • \n
  • \n

    \n KAFKA_SASL_GSSAPI_KRB5_CONF - The S3 location of a Kerberos krb5.conf file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.

    \n
    • \n
  • \n

    \n KAFKA_SASL_GSSAPI_SERVICE - The Kerberos service name, as set with sasl.kerberos.service.name in your Kafka Configuration.

    \n
    • \n
  • \n

    \n KAFKA_SASL_GSSAPI_PRINCIPAL - The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.

    \n
    • \n
" } }, "PhysicalConnectionRequirements": { @@ -6358,6 +6322,60 @@ "traits": { "smithy.api#enumValue": "CONNECTOR_CLASS_NAME" } + }, + "KAFKA_SASL_MECHANISM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KAFKA_SASL_MECHANISM" + } + }, + "KAFKA_SASL_SCRAM_USERNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KAFKA_SASL_SCRAM_USERNAME" + } + }, + "KAFKA_SASL_SCRAM_PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KAFKA_SASL_SCRAM_PASSWORD" + } + }, + "KAFKA_SASL_SCRAM_SECRETS_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KAFKA_SASL_SCRAM_SECRETS_ARN" + } + }, + "ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD" + } + }, + "KAFKA_SASL_GSSAPI_KEYTAB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KAFKA_SASL_GSSAPI_KEYTAB" + } + }, + "KAFKA_SASL_GSSAPI_KRB5_CONF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KAFKA_SASL_GSSAPI_KRB5_CONF" + } + }, + "KAFKA_SASL_GSSAPI_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KAFKA_SASL_GSSAPI_SERVICE" + } + }, + "KAFKA_SASL_GSSAPI_PRINCIPAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KAFKA_SASL_GSSAPI_PRINCIPAL" + } } } }, diff --git a/codegen/sdk/aws-models/guardduty.json b/codegen/sdk/aws-models/guardduty.json index 77f2357fd5bd..6db7ff394fef 100644 --- a/codegen/sdk/aws-models/guardduty.json +++ b/codegen/sdk/aws-models/guardduty.json @@ -1626,7 +1626,7 @@ "FindingCriteria": { "target": "com.amazonaws.guardduty#FindingCriteria", "traits": { - "smithy.api#documentation": "

Represents the criteria to be used in the filter for querying findings.

\n

You can only use the following attributes to query findings:

\n
    \n
  • \n

    accountId

    \n
    • \n
  • \n

    region

    \n
    • \n
  • \n

    id

    \n
    • \n
  • \n

    resource.accessKeyDetails.accessKeyId

    \n
    • \n
  • \n

    resource.accessKeyDetails.principalId

    \n
    • \n
  • \n

    resource.accessKeyDetails.userName

    \n
    • \n
  • \n

    resource.accessKeyDetails.userType

    \n
    • \n
  • \n

    resource.instanceDetails.iamInstanceProfile.id

    \n
    • \n
  • \n

    resource.instanceDetails.imageId

    \n
    • \n
  • \n

    resource.instanceDetails.instanceId

    \n
    • \n
  • \n

    resource.instanceDetails.outpostArn

    \n
    • \n
  • \n

    resource.instanceDetails.networkInterfaces.ipv6Addresses

    \n
    • \n
  • \n

    resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress

    \n
    • \n
  • \n

    resource.instanceDetails.networkInterfaces.publicDnsName

    \n
    • \n
  • \n

    resource.instanceDetails.networkInterfaces.publicIp

    \n
    • \n
  • \n

    resource.instanceDetails.networkInterfaces.securityGroups.groupId

    \n
    • \n
  • \n

    resource.instanceDetails.networkInterfaces.securityGroups.groupName

    \n
    • \n
  • \n

    resource.instanceDetails.networkInterfaces.subnetId

    \n
    • \n
  • \n

    resource.instanceDetails.networkInterfaces.vpcId

    \n
    • \n
  • \n

    resource.instanceDetails.tags.key

    \n
    • \n
  • \n

    resource.instanceDetails.tags.value

    \n
    • \n
  • \n

    resource.resourceType

    \n
    • \n
  • \n

    service.action.actionType

    \n
    • \n
  • \n

    service.action.awsApiCallAction.api

    \n
    • \n
  • \n

    service.action.awsApiCallAction.callerType

    \n
    • \n
  • \n

    service.action.awsApiCallAction.errorCode

    \n
    • \n
  • \n

    service.action.awsApiCallAction.userAgent

    \n
    • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.city.cityName

    \n
    • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.country.countryName

    \n
    • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.ipAddressV4

    \n
    • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.organization.asn

    \n
    • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg

    \n
    • \n
  • \n

    service.action.awsApiCallAction.serviceName

    \n
    • \n
  • \n

    service.action.dnsRequestAction.domain

    \n
    • \n
  • \n

    service.action.networkConnectionAction.blocked

    \n
    • \n
  • \n

    service.action.networkConnectionAction.connectionDirection

    \n
    • \n
  • \n

    service.action.networkConnectionAction.localPortDetails.port

    \n
    • \n
  • \n

    service.action.networkConnectionAction.protocol

    \n
    • \n
  • \n

    service.action.networkConnectionAction.localIpDetails.ipAddressV4

    \n
    • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.city.cityName

    \n
    • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.country.countryName

    \n
    • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.ipAddressV4

    \n
    • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.organization.asn

    \n
    • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg

    \n
    • \n
  • \n

    service.action.networkConnectionAction.remotePortDetails.port

    \n
    • \n
  • \n

    service.additionalInfo.threatListName

    \n
    • \n
  • \n

    resource.s3BucketDetails.publicAccess.effectivePermissions

    \n
    • \n
  • \n

    resource.s3BucketDetails.name

    \n
    • \n
  • \n

    resource.s3BucketDetails.tags.key

    \n
    • \n
  • \n

    resource.s3BucketDetails.tags.value

    \n
    • \n
  • \n

    resource.s3BucketDetails.type

    \n
    • \n
  • \n

    service.resourceRole

    \n
    • \n
  • \n

    severity

    \n
    • \n
  • \n

    type

    \n
    • \n
  • \n

    updatedAt

    \n

    Type: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ\n depending on whether the value contains milliseconds.

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

Represents the criteria to be used in the filter for querying findings.

\n

You can only use the following attributes to query findings:

\n
    \n
  • \n

    accountId

    \n
    • \n
  • \n

    id

    \n
    • \n
  • \n

    region

    \n
    • \n
  • \n

    severity

    \n

    To filter on the basis of severity, the API and CLI use the following input list for\n the FindingCriteria\n condition:

    \n
      \n
    • \n

      \n Low: [\"1\", \"2\", \"3\"]\n

      \n
      • \n
    • \n

      \n Medium: [\"4\", \"5\", \"6\"]\n

      \n
      • \n
    • \n

      \n High: [\"7\", \"8\", \"9\"]\n

      \n
      • \n
    \n

    For more information, see Severity\n levels for GuardDuty findings.

    \n
    • \n
  • \n

    type

    \n
    • \n
  • \n

    updatedAt

    \n

    Type: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ\n depending on whether the value contains milliseconds.

    \n
    • \n
  • \n

    resource.accessKeyDetails.accessKeyId

    \n
    • \n
  • \n

    resource.accessKeyDetails.principalId

    \n
    • \n
  • \n

    resource.accessKeyDetails.userName

    \n
    • \n
  • \n

    resource.accessKeyDetails.userType

    \n
    • \n
  • \n

    resource.instanceDetails.iamInstanceProfile.id

    \n
    • \n
  • \n

    resource.instanceDetails.imageId

    \n
    • \n
  • \n

    resource.instanceDetails.instanceId

    \n
    • \n
  • \n

    resource.instanceDetails.tags.key

    \n
    • \n
  • \n

    resource.instanceDetails.tags.value

    \n
    • \n
  • \n

    resource.instanceDetails.networkInterfaces.ipv6Addresses

    \n
    • \n
  • \n

    resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress

    \n
    • \n
  • \n

    resource.instanceDetails.networkInterfaces.publicDnsName

    \n
    • \n
  • \n

    resource.instanceDetails.networkInterfaces.publicIp

    \n
    • \n
  • \n

    resource.instanceDetails.networkInterfaces.securityGroups.groupId

    \n
    • \n
  • \n

    resource.instanceDetails.networkInterfaces.securityGroups.groupName

    \n
    • \n
  • \n

    resource.instanceDetails.networkInterfaces.subnetId

    \n
    • \n
  • \n

    resource.instanceDetails.networkInterfaces.vpcId

    \n
    • \n
  • \n

    resource.instanceDetails.outpostArn

    \n
    • \n
  • \n

    resource.resourceType

    \n
    • \n
  • \n

    resource.s3BucketDetails.publicAccess.effectivePermissions

    \n
    • \n
  • \n

    resource.s3BucketDetails.name

    \n
    • \n
  • \n

    resource.s3BucketDetails.tags.key

    \n
    • \n
  • \n

    resource.s3BucketDetails.tags.value

    \n
    • \n
  • \n

    resource.s3BucketDetails.type

    \n
    • \n
  • \n

    service.action.actionType

    \n
    • \n
  • \n

    service.action.awsApiCallAction.api

    \n
    • \n
  • \n

    service.action.awsApiCallAction.callerType

    \n
    • \n
  • \n

    service.action.awsApiCallAction.errorCode

    \n
    • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.city.cityName

    \n
    • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.country.countryName

    \n
    • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.ipAddressV4

    \n
    • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.organization.asn

    \n
    • \n
  • \n

    service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg

    \n
    • \n
  • \n

    service.action.awsApiCallAction.serviceName

    \n
    • \n
  • \n

    service.action.dnsRequestAction.domain

    \n
    • \n
  • \n

    service.action.networkConnectionAction.blocked

    \n
    • \n
  • \n

    service.action.networkConnectionAction.connectionDirection

    \n
    • \n
  • \n

    service.action.networkConnectionAction.localPortDetails.port

    \n
    • \n
  • \n

    service.action.networkConnectionAction.protocol

    \n
    • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.city.cityName

    \n
    • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.country.countryName

    \n
    • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.ipAddressV4

    \n
    • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.organization.asn

    \n
    • \n
  • \n

    service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg

    \n
    • \n
  • \n

    service.action.networkConnectionAction.remotePortDetails.port

    \n
    • \n
  • \n

    service.action.awsApiCallAction.remoteAccountDetails.affiliated

    \n
    • \n
  • \n

    service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4

    \n
    • \n
  • \n

    service.action.kubernetesApiCallAction.requestUri

    \n
    • \n
  • \n

    service.action.networkConnectionAction.localIpDetails.ipAddressV4

    \n
    • \n
  • \n

    service.action.networkConnectionAction.protocol

    \n
    • \n
  • \n

    service.action.awsApiCallAction.serviceName

    \n
    • \n
  • \n

    service.action.awsApiCallAction.remoteAccountDetails.accountId

    \n
    • \n
  • \n

    service.additionalInfo.threatListName

    \n
    • \n
  • \n

    service.resourceRole

    \n
    • \n
  • \n

    resource.eksClusterDetails.name

    \n
    • \n
  • \n

    resource.kubernetesDetails.kubernetesWorkloadDetails.name

    \n
    • \n
  • \n

    resource.kubernetesDetails.kubernetesWorkloadDetails.namespace

    \n
    • \n
  • \n

    resource.kubernetesDetails.kubernetesUserDetails.username

    \n
    • \n
  • \n

    resource.kubernetesDetails.kubernetesWorkloadDetails.containers.image

    \n
    • \n
  • \n

    resource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix

    \n
    • \n
  • \n

    service.ebsVolumeScanDetails.scanId

    \n
    • \n
  • \n

    service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name

    \n
    • \n
  • \n

    service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity

    \n
    • \n
  • \n

    service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash

    \n
    • \n
  • \n

    resource.ecsClusterDetails.name

    \n
    • \n
  • \n

    resource.ecsClusterDetails.taskDetails.containers.image

    \n
    • \n
  • \n

    resource.ecsClusterDetails.taskDetails.definitionArn

    \n
    • \n
  • \n

    resource.containerDetails.image

    \n
    • \n
  • \n

    resource.rdsDbInstanceDetails.dbInstanceIdentifier

    \n
    • \n
  • \n

    resource.rdsDbInstanceDetails.dbClusterIdentifier

    \n
    • \n
  • \n

    resource.rdsDbInstanceDetails.engine

    \n
    • \n
  • \n

    resource.rdsDbUserDetails.user

    \n
    • \n
  • \n

    resource.rdsDbInstanceDetails.tags.key

    \n
    • \n
  • \n

    resource.rdsDbInstanceDetails.tags.value

    \n
    • \n
  • \n

    service.runtimeDetails.process.executableSha256

    \n
    • \n
  • \n

    service.runtimeDetails.process.name

    \n
    • \n
  • \n

    service.runtimeDetails.process.name

    \n
    • \n
  • \n

    resource.lambdaDetails.functionName

    \n
    • \n
  • \n

    resource.lambdaDetails.functionArn

    \n
    • \n
  • \n

    resource.lambdaDetails.tags.key

    \n
    • \n
  • \n

    resource.lambdaDetails.tags.value

    \n
    • \n
", "smithy.api#jsonName": "findingCriteria", "smithy.api#required": {} } @@ -1790,7 +1790,7 @@ } ], "traits": { - "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.

\n

As 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.

\n

If you are adding accounts by invitation, before using InviteMembers, use \n CreateMembers after GuardDuty has been enabled in potential member accounts.

\n

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.

\n

As 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.

\n

If you are adding accounts by invitation, before using InviteMembers, use\n CreateMembers after GuardDuty has been enabled in potential member accounts.

\n

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.

\n

When 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.

\n

With 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.

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

Disassociates the current GuardDuty member account from its administrator account.

\n

When 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.

\n

With 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.

", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/administrator/disassociate", @@ -3658,7 +3658,7 @@ "smithy.api#deprecated": { "message": "This operation is deprecated, use DisassociateFromAdministratorAccount instead" }, - "smithy.api#documentation": "

Disassociates the current GuardDuty member account from its administrator account.

\n

When 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.

\n

When 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.

\n

When 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.

\n

With 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.

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

Disassociates GuardDuty member accounts (from the current administrator account)\n specified by the account IDs.

\n

When 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.

\n

With 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.

", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/member/disassociate", @@ -6211,7 +6211,7 @@ "name": "guardduty" }, "aws.protocols#restJson1": {}, - "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.

\n

GuardDuty 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.

\n

GuardDuty 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.

\n

GuardDuty 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.

\n

GuardDuty 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.

\n

To 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.

\n

After 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.

\n

To 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.

\n

After 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).

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

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).

", "smithy.api#jsonName": "lastModifiedAt" } }, @@ -8035,7 +7999,7 @@ "Tags": { "target": "com.amazonaws.guardduty#Tags", "traits": { - "smithy.api#documentation": "

A list of tags attached to this resource, listed in the format of \n key:value pair.

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

A list of tags attached to this resource, listed in the format of\n key:value pair.

", "smithy.api#jsonName": "tags" } } @@ -8938,7 +8902,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

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

Represents the communication protocol associated with the address. For example, the\n address family AF_INET is used for IP version of 4 protocol.

", "smithy.api#jsonName": "addressFamily" } }, @@ -11839,7 +11809,7 @@ } ], "traits": { - "smithy.api#documentation": "

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/aws-models/inspector2.json b/codegen/sdk/aws-models/inspector2.json index 151eb6e49161..7e294dda22d5 100644 --- a/codegen/sdk/aws-models/inspector2.json +++ b/codegen/sdk/aws-models/inspector2.json @@ -1150,6 +1150,128 @@ "smithy.api#output": {} } }, + "com.amazonaws.inspector2#BatchGetFindingDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#BatchGetFindingDetailsRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#BatchGetFindingDetailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets vulnerability details for findings.

", + "smithy.api#examples": [ + { + "title": "Sample BatchGetFindingDetails Call", + "input": { + "findingArns": [ + "arn:aws:inspector2:eu-west-1:123456789012:finding/78b88cc9aa1d78b6e14fde90d774dde7", + "arn:aws:inspector2:eu-west-1:111111111111:finding/78b88cc9aa1d78b6e14fde90d874dde7" + ] + }, + "output": { + "findingDetails": [ + { + "findingArn": "arn:aws:inspector2:eu-west-1:123456789012:finding/78b88cc9aa1d78b6e14fde90d774dde7", + "cisaData": { + "dateAdded": 1688580990, + "dateDue": 1688580999, + "action": "For all affected software assets for which updates exist, the only acceptable remediation actions are: 1) Apply updates; OR 2) remove affected assets from agency networks." + }, + "riskScore": 66, + "evidences": [ + { + "evidenceRule": "Historically Linked to Penetration Testing Tools", + "evidenceDetail": "2 sightings on 1 source", + "severity": "Low" + } + ], + "ttps": [ + "TA0001", + "TA0002" + ], + "tools": [ + "Metasploit" + ], + "exploitObserved": { + "lastSeen": 1688580990, + "firstSeen": 1688580800 + }, + "referenceUrls": [ + "https://nvd.nist.gov/vuln/detail/CVE-2019-20367" + ], + "cwes": [ + "cwe-1234" + ], + "epssScore": 0.85 + } + ], + "errors": [ + { + "findingArn": "arn:aws:inspector2:eu-west-1:111111111111:finding/78b88cc9aa1d78b6e14fde90d874dde7", + "errorCode": "ACCESS_DENIED", + "errorMessage": "You don't have permission to access this finding" + } + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/findings/details/batch/get" + } + } + }, + "com.amazonaws.inspector2#BatchGetFindingDetailsRequest": { + "type": "structure", + "members": { + "findingArns": { + "target": "com.amazonaws.inspector2#FindingArnList", + "traits": { + "smithy.api#documentation": "

A list of finding ARNs.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#BatchGetFindingDetailsResponse": { + "type": "structure", + "members": { + "findingDetails": { + "target": "com.amazonaws.inspector2#FindingDetails", + "traits": { + "smithy.api#documentation": "

A finding's vulnerability details.

" + } + }, + "errors": { + "target": "com.amazonaws.inspector2#FindingDetailsErrorList", + "traits": { + "smithy.api#documentation": "

Error information for findings that details could not be returned for.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.inspector2#BatchGetFreeTrialInfo": { "type": "operation", "input": { @@ -2829,7 +2951,7 @@ "keyPrefix": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The prefix of the Amazon S3 bucket used to export findings.

" + "smithy.api#documentation": "

The prefix that the findings will be written under.

" } }, "kmsKeyArn": { @@ -3666,6 +3788,62 @@ "com.amazonaws.inspector2#ErrorMessage": { "type": "string" }, + "com.amazonaws.inspector2#Evidence": { + "type": "structure", + "members": { + "evidenceRule": { + "target": "com.amazonaws.inspector2#EvidenceRule", + "traits": { + "smithy.api#documentation": "

The evidence rule.

" + } + }, + "evidenceDetail": { + "target": "com.amazonaws.inspector2#EvidenceDetail", + "traits": { + "smithy.api#documentation": "

The evidence details.

" + } + }, + "severity": { + "target": "com.amazonaws.inspector2#EvidenceSeverity", + "traits": { + "smithy.api#documentation": "

The evidence severity.

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

Details of the evidence for a vulnerability identified in a finding.

" + } + }, + "com.amazonaws.inspector2#EvidenceDetail": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#EvidenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Evidence" + } + }, + "com.amazonaws.inspector2#EvidenceRule": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#EvidenceSeverity": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, "com.amazonaws.inspector2#ExecutionRoleArn": { "type": "string", "traits": { @@ -4094,7 +4272,7 @@ "networkProtocol": { "target": "com.amazonaws.inspector2#StringFilterList", "traits": { - "smithy.api#documentation": "

Details on the ingress source addresses used to filter findings.

" + "smithy.api#documentation": "

Details on network protocol used to filter findings.

" } }, "componentId": { @@ -4397,6 +4575,18 @@ "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:inspector2:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:finding/[a-f0-9]{32}$" } }, + "com.amazonaws.inspector2#FindingArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FindingArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.inspector2#FindingArns": { "type": "list", "member": { @@ -4412,6 +4602,137 @@ } } }, + "com.amazonaws.inspector2#FindingDetail": { + "type": "structure", + "members": { + "findingArn": { + "target": "com.amazonaws.inspector2#FindingArn", + "traits": { + "smithy.api#documentation": "

The finding ARN that the vulnerability details are associated with.

" + } + }, + "cisaData": { + "target": "com.amazonaws.inspector2#CisaData" + }, + "riskScore": { + "target": "com.amazonaws.inspector2#RiskScore", + "traits": { + "smithy.api#documentation": "

The risk score of the vulnerability.

" + } + }, + "evidences": { + "target": "com.amazonaws.inspector2#EvidenceList", + "traits": { + "smithy.api#documentation": "

Information on the evidence of the vulnerability.

" + } + }, + "ttps": { + "target": "com.amazonaws.inspector2#Ttps", + "traits": { + "smithy.api#documentation": "

The MITRE adversary tactics, techniques, or procedures (TTPs) associated with the vulnerability.

" + } + }, + "tools": { + "target": "com.amazonaws.inspector2#Tools", + "traits": { + "smithy.api#documentation": "

The known malware tools or kits that can exploit the vulnerability.

" + } + }, + "exploitObserved": { + "target": "com.amazonaws.inspector2#ExploitObserved" + }, + "referenceUrls": { + "target": "com.amazonaws.inspector2#VulnerabilityReferenceUrls", + "traits": { + "smithy.api#documentation": "

The reference URLs for the vulnerability data.

" + } + }, + "cwes": { + "target": "com.amazonaws.inspector2#Cwes", + "traits": { + "smithy.api#documentation": "

The Common Weakness Enumerations (CWEs) associated with the vulnerability.

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

The Exploit Prediction Scoring System (EPSS) score of the vulnerability.

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

Details of the vulnerability identified in a finding.

" + } + }, + "com.amazonaws.inspector2#FindingDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FindingDetail" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#FindingDetailsError": { + "type": "structure", + "members": { + "findingArn": { + "target": "com.amazonaws.inspector2#FindingArn", + "traits": { + "smithy.api#documentation": "

The finding ARN that returned an error.

", + "smithy.api#required": {} + } + }, + "errorCode": { + "target": "com.amazonaws.inspector2#FindingDetailsErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The error message.

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

Details about an error encountered when trying to return vulnerability data for a finding.

" + } + }, + "com.amazonaws.inspector2#FindingDetailsErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INTERNAL_ERROR", + "name": "INTERNAL_ERROR" + }, + { + "value": "ACCESS_DENIED", + "name": "ACCESS_DENIED" + }, + { + "value": "FINDING_DETAILS_NOT_FOUND", + "name": "FINDING_DETAILS_NOT_FOUND" + }, + { + "value": "INVALID_INPUT", + "name": "INVALID_INPUT" + } + ] + } + }, + "com.amazonaws.inspector2#FindingDetailsErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FindingDetailsError" + } + }, "com.amazonaws.inspector2#FindingList": { "type": "list", "member": { @@ -5358,6 +5679,9 @@ { "target": "com.amazonaws.inspector2#BatchGetCodeSnippet" }, + { + "target": "com.amazonaws.inspector2#BatchGetFindingDetails" + }, { "target": "com.amazonaws.inspector2#BatchGetFreeTrialInfo" }, @@ -5563,52 +5887,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", @@ -5616,13 +5944,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -5632,224 +5969,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://inspector2-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://inspector2-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://inspector2-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://inspector2-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://inspector2.{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://inspector2.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://inspector2.{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://inspector2.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -9171,6 +9459,9 @@ ] } }, + "com.amazonaws.inspector2#RiskScore": { + "type": "integer" + }, "com.amazonaws.inspector2#Runtime": { "type": "string", "traits": { @@ -10205,6 +10496,20 @@ ] } }, + "com.amazonaws.inspector2#Tool": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#Tools": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Tool" + } + }, "com.amazonaws.inspector2#Ttp": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/internetmonitor.json b/codegen/sdk/aws-models/internetmonitor.json index 7bd1fc710970..2a7c77c9fbea 100644 --- a/codegen/sdk/aws-models/internetmonitor.json +++ b/codegen/sdk/aws-models/internetmonitor.json @@ -36,7 +36,7 @@ "PercentOfTotalTrafficImpacted": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

The percentage of impact caused by a health event for total traffic globally.

\n

For information about how Internet Monitor calculates impact, see Inside Internet Monitor in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User\n\t\t\tGuide.

" + "smithy.api#documentation": "

The impact on total traffic that a health event has, in increased latency or reduced availability. This is the \n\t\t\tpercentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this \n\t\t\tclient location to the Amazon Web Services location using this client network.

\n

For information about how Internet Monitor calculates impact, see How Internet Monitor works in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User\n\t\t\tGuide.

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

Measurements about the availability for your application on the internet, calculated by Amazon CloudWatch Internet Monitor. Amazon Web Services has substantial historical data about internet\n\t\t\tperformance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor\n\t\t\tcan detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it\n\t\t\teasier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.

\n

Availability in Internet Monitor represents the estimated percentage of traffic that is not seeing an availability drop. For example, an availability score of 99%\n\t\t\tfor an end user and service location pair is equivalent to 1% of the traffic experiencing an availability drop for that pair.

\n

For more information, see How Internet Monitor calculates performance and availability\n\t\t\t\tscores in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide.

" + "smithy.api#documentation": "

Amazon CloudWatch Internet Monitor calculates measurements about the availability for your application's internet traffic between client locations and Amazon Web Services.\n\t\t\tAmazon Web Services has substantial historical data about internet\n\t\t\tperformance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor\n\t\t\tcan detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it\n\t\t\teasier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.

\n

Availability in Internet Monitor represents the estimated percentage of traffic that is not seeing an availability drop. For example, an availability score of 99%\n\t\t\tfor an end user and service location pair is equivalent to 1% of the traffic experiencing an availability drop for that pair.

\n

For more information, see How Internet Monitor calculates performance and availability\n\t\t\t\tscores in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide.

" } }, "com.amazonaws.internetmonitor#BadRequestException": { @@ -109,7 +109,7 @@ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], - "smithy.api#documentation": "

Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: Amazon Virtual Private Clouds (VPCs),\n\t\t\tAmazon CloudFront distributions, and WorkSpaces directories. Internet Monitor then publishes internet measurements from Amazon Web Services that are specific to \n\t\t\tthe city-networks, that is, the locations and ASNs (typically internet service providers or ISPs),\n\t\t\twhere clients access your application. For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.

\n

When you create a monitor, you set a maximum limit for the number of city-networks where client traffic is monitored. The city-network maximum \n\t\t\tthat you choose is the limit, but you only pay for the number of city-networks that are actually monitored. You can change the maximum at any time \n\t\t\tby updating your monitor. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.

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

Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: VPCs,\n\t\t\tNetwork Load Balancers (NLBs), Amazon CloudFront distributions, and Amazon WorkSpaces directories. Internet Monitor then publishes internet measurements from Amazon Web Services \n\t\t\tthat are specific to the city-networks. That is, the locations and ASNs (typically internet service providers or ISPs),\n\t\t\twhere clients access your application. For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User \n\t\t\t\t\tGuide.

\n

When you create a monitor, you choose the percentage of traffic that you want to monitor. You can also set a maximum limit for the \n\t\t\tnumber of city-networks where client traffic is monitored, that caps the total traffic that Internet Monitor monitors. A city-network \n\t\t\tmaximum is the limit of city-networks, but you only pay for the number of city-networks that are actually monitored. You can update your monitor\n\t\t\tat any time to change the percentage of traffic to monitor or the city-networks maximum. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.

", "smithy.api#http": { "uri": "/v20210603/Monitors", "method": "POST" @@ -130,7 +130,7 @@ "Resources": { "target": "com.amazonaws.internetmonitor#SetOfARNs", "traits": { - "smithy.api#documentation": "

The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).

\n

You can add a combination of Amazon Virtual Private Clouds (VPCs) and Amazon CloudFront distributions, or you can add Amazon WorkSpaces directories. You can't add all three types of\n\t\t\tresources.

\n \n

If you add only VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

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

The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs,\n\t\t\tAmazon CloudFront distributions, or Amazon WorkSpaces directories.

\n

You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add \n\t\t\tNLBs or WorkSpaces directories together with any other resources.

\n \n

If you add only Amazon VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has \n\t\t\tinternet connectivity.

\n " } }, "ClientToken": { @@ -150,7 +150,7 @@ "target": "com.amazonaws.internetmonitor#MaxCityNetworksToMonitor", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and \n\t\t\tthe network or ASN, such as an internet service provider (ISP), that clients access the resources through. This limit helps control billing costs.

\n

To learn more, see Choosing a city-network maximum value\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

" + "smithy.api#documentation": "

The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your \n\t\t\tapplication resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources \n\t\t\tthrough. Setting this limit can help control billing costs.

\n

To learn more, see Choosing a city-network maximum value\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

" } }, "InternetMeasurementsLogDelivery": { @@ -163,13 +163,13 @@ "target": "com.amazonaws.internetmonitor#TrafficPercentageToMonitor", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.

" + "smithy.api#documentation": "

The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks\n\t\t\tmaximum, that limit overrides the traffic percentage that you set.

\n

To learn more, see Choosing an application traffic percentage to monitor\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

" } }, "HealthEventsConfig": { "target": "com.amazonaws.internetmonitor#HealthEventsConfig", "traits": { - "smithy.api#documentation": "

Defines the health event threshold percentages, for performance score and availability score. Internet Monitor creates a health event when \n\t\t\tthere's an internet issue that affects your application end users where a health score percentage is at or below a set threshold. If you \n\t\t\tdon't set a health event threshold, the default calue is 95%.

" + "smithy.api#documentation": "

Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event. Internet Monitor creates a\n\t\t\thealth event when an internet issue that affects your application end users has a health score percentage that is at or below a \n\t\t\tspecific threshold, and, sometimes, when other criteria are met.

\n

If you don't set a health event threshold, the default value is 95%.

\n

For more information, see \n\t\t\tChange health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

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

Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations,\n\t\t\tand all of the information related to the event by location.

\n

The information returned includes the performance, availability, and round-trip time impact, information about the network providers, the event type,\n\t\t\tand so on.

\n

Information rolled up at the global traffic level is also returned, including the impact type and total traffic impact.

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

Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations,\n\t\t\tand all the information related to the event, by location.

\n

The information returned includes the impact on performance, availability, and round-trip time, information about the network providers (ASNs),\n\t\t\tthe event type, and so on.

\n

Information rolled up at the global traffic level is also returned, including the impact type and total traffic impact.

", "smithy.api#http": { "uri": "/v20210603/Monitors/{MonitorName}/HealthEvents/{EventId}", "method": "GET" @@ -357,7 +357,7 @@ "PercentOfTotalTrafficImpacted": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

The impact on total traffic that a health event has.

" + "smithy.api#documentation": "

The impact on total traffic that a health event has, in increased latency or reduced availability. This is the \n\t\t\tpercentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this \n\t\t\tclient location to the Amazon Web Services location using this client network.

" } }, "ImpactType": { @@ -371,7 +371,7 @@ "target": "com.amazonaws.internetmonitor#Percentage", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The threshold percentage for health events when Amazon CloudWatch Internet Monitor creates a health event.

" + "smithy.api#documentation": "

The threshold percentage for a health score that determines, along with other configuration information,\n\t\t\twhen Internet Monitor creates a health event when there's an internet issue that affects your application end users.

" } } } @@ -440,7 +440,7 @@ "Resources": { "target": "com.amazonaws.internetmonitor#SetOfARNs", "traits": { - "smithy.api#documentation": "

The resources that have been added for the monitor. Resources are listed by their Amazon Resource Names (ARNs).

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

The resources monitored by the monitor. Resources are listed by their Amazon Resource Names (ARNs).

", "smithy.api#required": {} } }, @@ -489,7 +489,7 @@ "target": "com.amazonaws.internetmonitor#MaxCityNetworksToMonitor", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and \n\t\t\tthe network or ASN, such as an internet service provider (ISP), that clients access the resources through. This limit helps control billing costs.

\n

To learn more, see Choosing a city-network maximum value\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

" + "smithy.api#documentation": "

The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your \n\t\t\tapplication resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources \n\t\t\tthrough. This limit can help control billing costs.

\n

To learn more, see Choosing a city-network maximum value\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

" } }, "InternetMeasurementsLogDelivery": { @@ -502,13 +502,13 @@ "target": "com.amazonaws.internetmonitor#TrafficPercentageToMonitor", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.

" + "smithy.api#documentation": "

The percentage of the internet-facing traffic for your application to monitor with this monitor. If you set a city-networks\n\t\t\tmaximum, that limit overrides the traffic percentage that you set.

\n

To learn more, see Choosing an application traffic percentage to monitor\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

" } }, "HealthEventsConfig": { "target": "com.amazonaws.internetmonitor#HealthEventsConfig", "traits": { - "smithy.api#documentation": "

The list of health event thresholds. A health event threshold percentage, for performance and availability, determines the level\n\t\t\tof impact at which Amazon CloudWatch Internet Monitor creates a health event when there's an internet issue that affects your application end users.

" + "smithy.api#documentation": "

The list of health event threshold configurations. The threshold percentage for a health score determines, along with other configuration \n\t\t\tinformation, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.

\n

For more information, see \n\t\t\tChange health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

" } } } @@ -577,7 +577,7 @@ "PercentOfTotalTrafficImpacted": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

The impact on global traffic monitored by this monitor for this health event.

" + "smithy.api#documentation": "

The impact on total traffic that a health event has, in increased latency or reduced availability. This is the \n\t\t\tpercentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this \n\t\t\tclient location to the Amazon Web Services location using this client network.

" } }, "ImpactType": { @@ -610,6 +610,14 @@ { "value": "PERFORMANCE", "name": "PERFORMANCE" + }, + { + "value": "LOCAL_AVAILABILITY", + "name": "LOCAL_AVAILABILITY" + }, + { + "value": "LOCAL_PERFORMANCE", + "name": "LOCAL_PERFORMANCE" } ] } @@ -684,10 +692,22 @@ "smithy.api#default": 0, "smithy.api#documentation": "

The health event threshold percentage set for performance scores.

" } + }, + "AvailabilityLocalHealthEventsConfig": { + "target": "com.amazonaws.internetmonitor#LocalHealthEventsConfig", + "traits": { + "smithy.api#documentation": "

The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.

" + } + }, + "PerformanceLocalHealthEventsConfig": { + "target": "com.amazonaws.internetmonitor#LocalHealthEventsConfig", + "traits": { + "smithy.api#documentation": "

The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.

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

A complex type for the configuration. Defines the health event threshold percentages, for performance score and availability score. Amazon CloudWatch Internet Monitor creates a health event when \n\t\t\tthere's an internet issue that affects your application end users where a health score percentage is at or below a set threshold. If you \n\t\t\tdon't set a health event threshold, the default value is 95%.

" + "smithy.api#documentation": "

A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event \n\t\t\tfor an overall performance or availability issue, across an application's geographies.

\n

Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds\n\t\t\tfor when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores,\n\t\t\tor both.

\n

You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks,\n\t\t\tin addition to creating an event when an overall score crosses a threshold.

\n

If you don't set a health event threshold, the default value is 95%.

\n

For local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event.\n\t\t\tIn addition, you can disable local thresholds, for performance scores, availability scores, or both.

\n

For more information, see \n\t\t\tChange health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

" } }, "com.amazonaws.internetmonitor#ImpactedLocation": { @@ -837,7 +857,7 @@ } }, "traits": { - "smithy.api#documentation": "

Internet health includes measurements calculated by Amazon CloudWatch Internet Monitor about the performance and availability for your application on the internet. Amazon Web Services has\n\t\t\tsubstantial historical data about internet performance and availability between Amazon Web Services services and different network providers and geographies. By\n\t\t\tapplying statistical analysis to the data, Internet Monitor can detect when the performance and availability for your application has dropped, compared to an\n\t\t\testimated baseline that's already calculated. To make it easier to see those drops, we report that information to you in the form of health scores: a\n\t\t\tperformance score and an availability score.

" + "smithy.api#documentation": "

Internet health includes measurements calculated by Amazon CloudWatch Internet Monitor about the performance and availability for your application on the internet. Amazon Web Services has\n\t\t\tsubstantial historical data about internet performance and availability between Amazon Web Services services and different network providers and geographies. By\n\t\t\tapplying statistical analysis to the data, Internet Monitor can detect when the performance and availability for your application has dropped, compared to an\n\t\t\testimated baseline that's already calculated. To make it easier to see those drops, Internet Monitor reports the information to you in the form of health scores: a\n\t\t\tperformance score and an availability score.

" } }, "com.amazonaws.internetmonitor#InternetMeasurementsLogDelivery": { @@ -913,7 +933,7 @@ "X-Amz-Requested-Operation" ] }, - "smithy.api#documentation": "

Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability \n\t\t\tbetween your applications hosted on Amazon Web Services and your end users. It reduces the time it takes for you to diagnose \n\t\t\tinternet issues from days to minutes. Internet Monitor uses the connectivity data that Amazon Web Services captures from its global \n\t\t\tnetworking footprint to calculate a baseline of performance and availability for internet traffic. This \n\t\t\tis the same data that Amazon Web Services uses to monitor internet uptime and availability. With those measurements \n\t\t\tas a baseline, Internet Monitor raises awareness for you when there are significant problems for your \n\t\t\tend users in the different geographic locations where your application runs.

\n

Internet Monitor publishes internet measurements to CloudWatch Logs and CloudWatch Metrics, \n\t\t\tto easily support using CloudWatch tools with health information for geographies and networks specific to your application.\n\t\t\tInternet Monitor sends health events to Amazon EventBridge so that you can set up notifications. If an issue is caused by the Amazon Web Services network, \n\t\t\tyou also automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking to mitigate the problem.

\n

To use Internet Monitor, you create a monitor and associate your application's resources \n\t\t\twith it, VPCs, CloudFront distributions, or WorkSpaces directories, to enable Internet Monitor to know \n\t\t\twhere your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to \n\t\t\tthe locations and networks that communicate with your application.

\n

For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.

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

Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability \n\t\t\tbetween your applications hosted on Amazon Web Services and your end users. It can reduce the time it takes for you to diagnose \n\t\t\tinternet issues from days to minutes. Internet Monitor uses the connectivity data that Amazon Web Services captures from its global \n\t\t\tnetworking footprint to calculate a baseline of performance and availability for internet traffic. This \n\t\t\tis the same data that Amazon Web Services uses to monitor internet uptime and availability. With those measurements \n\t\t\tas a baseline, Internet Monitor raises awareness for you when there are significant problems for your \n\t\t\tend users in the different geographic locations where your application runs.

\n

Internet Monitor publishes internet measurements to CloudWatch Logs and CloudWatch Metrics, \n\t\t\tto easily support using CloudWatch tools with health information for geographies and networks specific to your application.\n\t\t\tInternet Monitor sends health events to Amazon EventBridge so that you can set up notifications. If an issue is caused by the Amazon Web Services network, \n\t\t\tyou also automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking to mitigate the problem.

\n

To use Internet Monitor, you create a monitor and associate your application's resources \n\t\t\twith it - VPCs, NLBs, CloudFront distributions, or WorkSpaces directories - so Internet Monitor can determine \n\t\t\twhere your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to \n\t\t\tthe locations and ASNs (typically, internet service providers or ISPs) that communicate with your application.

\n

For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.

", "smithy.api#title": "Amazon CloudWatch Internet Monitor", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -981,18 +1001,28 @@ ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -1000,19 +1030,35 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ + true, { - "ref": "Region" + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", "rules": [ { - "conditions": [], + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], "type": "tree", "rules": [ { @@ -1027,7 +1073,7 @@ { "ref": "PartitionResult" }, - "supportsDualStack" + "supportsFIPS" ] } ] @@ -1035,62 +1081,10 @@ ], "type": "tree", "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://internetmonitor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, { "conditions": [], "endpoint": { - "url": "https://internetmonitor.{Region}.{PartitionResult#dualStackDnsSuffix}", + "url": "https://internetmonitor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, @@ -1100,95 +1094,91 @@ }, { "conditions": [], - "type": "tree", - "rules": [ + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://internetmonitor.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ + "fn": "getAttr", + "argv": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://internetmonitor-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] + "ref": "PartitionResult" }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://internetmonitor.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "supportsFIPS" ] } ] } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://internetmonitor-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://internetmonitor.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -1349,7 +1339,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns all information for health events including the client location information the network\n\t\t\tcause and status, event start and end time, percentage of total traffic impacted, and status.

\n \n

Health events that have start times during the time frame that is requested are not included in the list of health events.

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

Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns information for health events including the event start and end time and \n\t\t\tthe status.

\n \n

Health events that have start times during the time frame that is requested are not included in the list of health events.

\n ", "smithy.api#http": { "uri": "/v20210603/Monitors/{MonitorName}/HealthEvents", "method": "GET" @@ -1582,6 +1572,49 @@ } } }, + "com.amazonaws.internetmonitor#LocalHealthEventsConfig": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.internetmonitor#LocalHealthEventsConfigStatus", + "traits": { + "smithy.api#documentation": "

The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED\n\t\tor DISABLED.

" + } + }, + "HealthScoreThreshold": { + "target": "com.amazonaws.internetmonitor#Percentage", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The health event threshold percentage set for a local health score.

" + } + }, + "MinTrafficImpact": { + "target": "com.amazonaws.internetmonitor#Percentage", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a\n\t\t\tthreshold is crossed for a local health score.

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

A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event \n\t\t\tfor a local performance or availability issue, when scores cross a threshold for one or more city-networks.

\n

Defines the percentages, for performance scores or availability scores, that are the local thresholds\n\t\t\tfor when Amazon CloudWatch Internet Monitor creates a health event. Also defines whether a local threshold is enabled or disabled, and the minimum percentage\n\t\t\tof overall traffic that must be impacted by an issue before Internet Monitor creates an event when a\tthreshold is crossed for a local health score.

\n

For more information, see \n\t\t\tChange health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

" + } + }, + "com.amazonaws.internetmonitor#LocalHealthEventsConfigStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ENABLED", + "value": "ENABLED" + }, + { + "name": "DISABLED", + "value": "DISABLED" + } + ] + } + }, "com.amazonaws.internetmonitor#LogDeliveryStatus": { "type": "string", "traits": { @@ -1854,7 +1887,7 @@ "PercentOfTotalTrafficImpacted": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

How much performance impact was caused by a health event for total traffic globally. For performance, this is the percentage of how much latency\n\t\t\tincreased during the event compared to typical performance for your application traffic globally.

\n

For more information, see When Amazon Web Services creates and resolves health\n\t\t\tevents in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

" + "smithy.api#documentation": "

The impact on total traffic that a health event has, in increased latency or reduced availability. This is the \n\t\t\tpercentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this \n\t\t\tclient location to the Amazon Web Services location using this client network.

\n

For more information, see When Amazon Web Services creates and resolves health\n\t\t\tevents in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

" } }, "PercentOfClientLocationImpacted": { @@ -1871,7 +1904,7 @@ } }, "traits": { - "smithy.api#documentation": "

Measurements about the performance for your application on the internet calculated by Amazon CloudWatch Internet Monitor. Amazon Web Services has substantial historical data about internet\n\t\t\tperformance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor\n\t\t\tcan detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it\n\t\t\teasier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.

\n

Performance in Internet Monitor represents the estimated percentage of traffic that is not seeing a performance drop. For example, a performance score of 99% for\n\t\t\tan end user and service location pair is equivalent to 1% of the traffic experiencing a performance drop for that pair.

\n

For more information, see How Internet Monitor calculates performance and availability\n\t\t\tscores in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

" + "smithy.api#documentation": "

Amazon CloudWatch Internet Monitor calculates measurements about the performance for your application's internet traffic between client locations and Amazon Web Services. \n\t\t\tAmazon Web Services has substantial historical data about internet\n\t\t\tperformance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor\n\t\t\tcan detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it\n\t\t\teasier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.

\n

Performance in Internet Monitor represents the estimated percentage of traffic that is not seeing a performance drop. For example, a performance score of 99% for\n\t\t\tan end user and service location pair is equivalent to 1% of the traffic experiencing a performance drop for that pair.

\n

For more information, see How Internet Monitor calculates performance and availability\n\t\t\tscores in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

" } }, "com.amazonaws.internetmonitor#ResourceName": { @@ -2237,7 +2270,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a monitor. You can update a monitor to change the maximum number of city-networks (locations and ASNs or \n\t\t\tinternet service providers), to add or remove resources, \n\t\t\tor to change the status of the monitor. Note that you can't change the name of a monitor.

\n

The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. \n\t\t\tFor more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.

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

Updates a monitor. You can update a monitor to change the percentage of traffic to monitor or the maximum number of city-networks \n\t\t\t(locations and ASNs), to add or remove resources, or to change the status of the monitor. Note that you can't change the name of a monitor.

\n

The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. \n\t\t\tFor more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.

", "smithy.api#http": { "uri": "/v20210603/Monitors/{MonitorName}", "method": "PATCH" @@ -2259,7 +2292,7 @@ "ResourcesToAdd": { "target": "com.amazonaws.internetmonitor#SetOfARNs", "traits": { - "smithy.api#documentation": "

The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).

\n

You can add a combination of Amazon Virtual Private Clouds (VPCs) and Amazon CloudFront distributions, or you can add Amazon WorkSpaces directories. You can't add all three types of\n\t\t\tresources.

\n \n

If you add only VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet\n\t\t\tconnectivity.

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

The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs,\n\t\t\tAmazon CloudFront distributions, or Amazon WorkSpaces directories.

\n

You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add \n\t\t\tNLBs or WorkSpaces directories together with any other resources.

\n \n

If you add only Amazon Virtual Private Clouds resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet\n\t\t\tconnectivity.

\n " } }, "ResourcesToRemove": { @@ -2285,7 +2318,7 @@ "target": "com.amazonaws.internetmonitor#MaxCityNetworksToMonitor", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from \n\t\t\tand the network or ASN, \n\t\t\tsuch as an internet service provider, that clients access the resources through.

" + "smithy.api#documentation": "

The maximum number of city-networks to monitor for your application. A city-network is the location (city) where clients access your \n\t\t\tapplication resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources \n\t\t\tthrough. Setting this limit can help control billing costs.

" } }, "InternetMeasurementsLogDelivery": { @@ -2298,13 +2331,13 @@ "target": "com.amazonaws.internetmonitor#TrafficPercentageToMonitor", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.

" + "smithy.api#documentation": "

The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks\n\t\t\tmaximum, that limit overrides the traffic percentage that you set.

\n

To learn more, see Choosing an application traffic percentage to monitor\n\t\t in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

" } }, "HealthEventsConfig": { "target": "com.amazonaws.internetmonitor#HealthEventsConfig", "traits": { - "smithy.api#documentation": "

The list of health event thresholds. A health event threshold percentage, for performance and availability, determines when Internet Monitor creates \n\t\t\ta health event when there's an internet issue that affects your application end users.

" + "smithy.api#documentation": "

The list of health score thresholds. A threshold percentage for health scores, along with other configuration information,\n\t\t\tdetermines when Internet Monitor creates a health event when there's an internet issue that affects your application end users.

\n

For more information, see \n\t\t\tChange health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

" } } } diff --git a/codegen/sdk/aws-models/ivs-realtime.json b/codegen/sdk/aws-models/ivs-realtime.json index cdffbf491c0c..66fc64bb869f 100644 --- a/codegen/sdk/aws-models/ivs-realtime.json +++ b/codegen/sdk/aws-models/ivs-realtime.json @@ -98,7 +98,7 @@ "date" ] }, - "smithy.api#documentation": "

\n Introduction\n

\n

The 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

\n

Terminology:

\n
    \n
  • \n

    The IVS stage API sometimes is referred to as the IVS RealTime\n API.

    \n
    • \n
  • \n

    A participant token is an authorization token used to publish/subscribe\n to a stage.

    \n
    • \n
  • \n

    A 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
\n

\n Resources\n

\n

The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS):

\n
    \n
  • \n

    \n Stage — A stage is a virtual space where multiple participants can exchange audio and video in real time.

    \n
    • \n
\n

\n Tagging\n

\n

A 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.

\n

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).

\n

The Amazon IVS stage API has these tag-related endpoints: TagResource, UntagResource, and\n ListTagsForResource. The following resource supports tagging: Stage.

\n

At most 50 tags can be applied to a resource.

\n

\n Stages Endpoints\n

\n
    \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
  • \n

    \n CreateStage — Creates a new stage (and optionally participant tokens).

    \n
    • \n
  • \n

    \n DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).

    \n
    • \n
  • \n

    \n DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.

    \n
    • \n
  • \n

    \n GetParticipant — Gets information about the specified\n participant token.

    \n
    • \n
  • \n

    \n GetStage — Gets information for the specified stage.

    \n
    • \n
  • \n

    \n GetStageSession — Gets information for the specified stage\n session.

    \n
    • \n
  • \n

    \n ListParticipantEvents — Lists events for a specified\n participant that occurred during a specified stage session.

    \n
    • \n
  • \n

    \n ListParticipants — Lists all participants in a specified stage\n session.

    \n
    • \n
  • \n

    \n ListStages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.

    \n
    • \n
  • \n

    \n ListStageSessions — Gets all sessions for a specified stage.

    \n
    • \n
  • \n

    \n UpdateStage — Updates a stage’s configuration.

    \n
    • \n
\n

\n Tags Endpoints\n

\n
    \n
  • \n

    \n ListTagsForResource — Gets information about AWS tags for the\n specified ARN.

    \n
    • \n
  • \n

    \n TagResource — Adds or updates tags for the AWS resource with\n the specified ARN.

    \n
    • \n
  • \n

    \n UntagResource — Removes tags from the resource with the\n specified ARN.

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

\n Introduction\n

\n

The 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

\n

Terminology:

\n
    \n
  • \n

    A stage is a virtual space where participants can exchange video in real time.

    \n
    • \n
  • \n

    A participant token is a token that authenticates a participant when they join a stage.

    \n
    • \n
  • \n

    A 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
\n

\n Resources\n

\n

The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):

\n
    \n
  • \n

    \n Stage — A stage is a virtual space where participants can exchange video in real time.

    \n
    • \n
\n

\n Tagging\n

\n

A 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.

\n

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).

\n

The Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and\n ListTagsForResource. The following resource supports tagging: Stage.

\n

At most 50 tags can be applied to a resource.

\n

\n Stages Endpoints\n

\n
    \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
  • \n

    \n CreateStage — Creates a new stage (and optionally participant tokens).

    \n
    • \n
  • \n

    \n DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).

    \n
    • \n
  • \n

    \n DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.

    \n
    • \n
  • \n

    \n GetParticipant — Gets information about the specified\n participant token.

    \n
    • \n
  • \n

    \n GetStage — Gets information for the specified stage.

    \n
    • \n
  • \n

    \n GetStageSession — Gets information for the specified stage\n session.

    \n
    • \n
  • \n

    \n ListParticipantEvents — Lists events for a specified\n participant that occurred during a specified stage session.

    \n
    • \n
  • \n

    \n ListParticipants — Lists all participants in a specified stage\n session.

    \n
    • \n
  • \n

    \n ListStages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.

    \n
    • \n
  • \n

    \n ListStageSessions — Gets all sessions for a specified stage.

    \n
    • \n
  • \n

    \n UpdateStage — Updates a stage’s configuration.

    \n
    • \n
\n

\n Tags Endpoints\n

\n
    \n
  • \n

    \n ListTagsForResource — Gets information about AWS tags for the\n specified ARN.

    \n
    • \n
  • \n

    \n TagResource — Adds or updates tags for the AWS resource with\n the specified ARN.

    \n
    • \n
  • \n

    \n UntagResource — Removes tags from the resource with the\n specified ARN.

    \n
    • \n
", "smithy.api#title": "Amazon Interactive Video Service RealTime", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -453,54 +453,54 @@ "smithy.rules#endpointTests": { "testCases": [ { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://ivsrealtime-fips.us-gov-east-1.api.aws" + "url": "https://ivsrealtime-fips.us-east-1.api.aws" } }, "params": { + "Region": "us-east-1", "UseFIPS": true, - "Region": "us-gov-east-1", "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://ivsrealtime-fips.us-gov-east-1.amazonaws.com" + "url": "https://ivsrealtime-fips.us-east-1.amazonaws.com" } }, "params": { + "Region": "us-east-1", "UseFIPS": true, - "Region": "us-gov-east-1", "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://ivsrealtime.us-gov-east-1.api.aws" + "url": "https://ivsrealtime.us-east-1.api.aws" } }, "params": { + "Region": "us-east-1", "UseFIPS": false, - "Region": "us-gov-east-1", "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://ivsrealtime.us-gov-east-1.amazonaws.com" + "url": "https://ivsrealtime.us-east-1.amazonaws.com" } }, "params": { + "Region": "us-east-1", "UseFIPS": false, - "Region": "us-gov-east-1", "UseDualStack": false } }, @@ -512,8 +512,8 @@ } }, "params": { - "UseFIPS": true, "Region": "cn-north-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -525,8 +525,8 @@ } }, "params": { - "UseFIPS": true, "Region": "cn-north-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -538,8 +538,8 @@ } }, "params": { - "UseFIPS": false, "Region": "cn-north-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -551,108 +551,108 @@ } }, "params": { - "UseFIPS": false, "Region": "cn-north-1", + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "url": "https://ivsrealtime-fips.us-gov-east-1.api.aws" + } }, "params": { + "Region": "us-gov-east-1", "UseFIPS": true, - "Region": "us-iso-east-1", "UseDualStack": true } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://ivsrealtime-fips.us-iso-east-1.c2s.ic.gov" + "url": "https://ivsrealtime-fips.us-gov-east-1.amazonaws.com" } }, "params": { + "Region": "us-gov-east-1", "UseFIPS": true, - "Region": "us-iso-east-1", "UseDualStack": false } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://ivsrealtime.us-gov-east-1.api.aws" + } }, "params": { + "Region": "us-gov-east-1", "UseFIPS": false, - "Region": "us-iso-east-1", "UseDualStack": true } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://ivsrealtime.us-iso-east-1.c2s.ic.gov" + "url": "https://ivsrealtime.us-gov-east-1.amazonaws.com" } }, "params": { + "Region": "us-gov-east-1", "UseFIPS": false, - "Region": "us-iso-east-1", "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://ivsrealtime-fips.us-east-1.api.aws" - } + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { + "Region": "us-iso-east-1", "UseFIPS": true, - "Region": "us-east-1", "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://ivsrealtime-fips.us-east-1.amazonaws.com" + "url": "https://ivsrealtime-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { + "Region": "us-iso-east-1", "UseFIPS": true, - "Region": "us-east-1", "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://ivsrealtime.us-east-1.api.aws" - } + "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { + "Region": "us-iso-east-1", "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://ivsrealtime.us-east-1.amazonaws.com" + "url": "https://ivsrealtime.us-iso-east-1.c2s.ic.gov" } }, "params": { + "Region": "us-iso-east-1", "UseFIPS": false, - "Region": "us-east-1", "UseDualStack": false } }, @@ -662,8 +662,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseFIPS": true, "Region": "us-isob-east-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -675,8 +675,8 @@ } }, "params": { - "UseFIPS": true, "Region": "us-isob-east-1", + "UseFIPS": true, "UseDualStack": false } }, @@ -686,8 +686,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseFIPS": false, "Region": "us-isob-east-1", + "UseFIPS": false, "UseDualStack": true } }, @@ -699,21 +699,34 @@ } }, "params": { - "UseFIPS": false, "Region": "us-isob-east-1", + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } @@ -724,8 +737,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseFIPS": true, "Region": "us-east-1", + "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } @@ -736,11 +749,17 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseFIPS": false, "Region": "us-east-1", + "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" @@ -1061,7 +1080,7 @@ "errorCode": { "target": "com.amazonaws.ivsrealtime#EventErrorCode", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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

" } } }, @@ -1076,6 +1095,14 @@ { "value": "INSUFFICIENT_CAPABILITIES", "name": "INSUFFICIENT_CAPABILITIES" + }, + { + "value": "QUOTA_EXCEEDED", + "name": "QUOTA_EXCEEDED" + }, + { + "value": "PUBLISHER_NOT_FOUND", + "name": "PUBLISHER_NOT_FOUND" } ] } diff --git a/codegen/sdk/aws-models/kafka.json b/codegen/sdk/aws-models/kafka.json index 1eb33d545c32..866e4a8e1863 100644 --- a/codegen/sdk/aws-models/kafka.json +++ b/codegen/sdk/aws-models/kafka.json @@ -902,6 +902,192 @@ "smithy.api#documentation": "

State information about the operation step.

" } }, + "com.amazonaws.kafka#ClusterOperationV2": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

ARN of the cluster.

", + "smithy.api#jsonName": "clusterArn" + } + }, + "ClusterType": { + "target": "com.amazonaws.kafka#ClusterType", + "traits": { + "smithy.api#documentation": "

Type of the backend cluster.

", + "smithy.api#jsonName": "clusterType" + } + }, + "StartTime": { + "target": "com.amazonaws.kafka#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The time at which operation was started.

", + "smithy.api#jsonName": "startTime" + } + }, + "EndTime": { + "target": "com.amazonaws.kafka#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The time at which the operation finished.

", + "smithy.api#jsonName": "endTime" + } + }, + "ErrorInfo": { + "target": "com.amazonaws.kafka#ErrorInfo", + "traits": { + "smithy.api#documentation": "

If cluster operation failed from an error, it describes the error.

", + "smithy.api#jsonName": "errorInfo" + } + }, + "OperationArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

ARN of the cluster operation.

", + "smithy.api#jsonName": "operationArn" + } + }, + "OperationState": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

State of the cluster operation.

", + "smithy.api#jsonName": "operationState" + } + }, + "OperationType": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

Type of the cluster operation.

", + "smithy.api#jsonName": "operationType" + } + }, + "Provisioned": { + "target": "com.amazonaws.kafka#ClusterOperationV2Provisioned", + "traits": { + "smithy.api#documentation": "

Properties of a provisioned cluster.

", + "smithy.api#jsonName": "provisioned" + } + }, + "Serverless": { + "target": "com.amazonaws.kafka#ClusterOperationV2Serverless", + "traits": { + "smithy.api#documentation": "

Properties of a serverless cluster.

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

Returns information about a cluster operation.

" + } + }, + "com.amazonaws.kafka#ClusterOperationV2Provisioned": { + "type": "structure", + "members": { + "OperationSteps": { + "target": "com.amazonaws.kafka#__listOfClusterOperationStep", + "traits": { + "smithy.api#documentation": "

Steps completed during the operation.

", + "smithy.api#jsonName": "operationSteps" + } + }, + "SourceClusterInfo": { + "target": "com.amazonaws.kafka#MutableClusterInfo", + "traits": { + "smithy.api#documentation": "

Information about cluster attributes before a cluster is updated.

", + "smithy.api#jsonName": "sourceClusterInfo" + } + }, + "TargetClusterInfo": { + "target": "com.amazonaws.kafka#MutableClusterInfo", + "traits": { + "smithy.api#documentation": "

Information about cluster attributes after a cluster is updated.

", + "smithy.api#jsonName": "targetClusterInfo" + } + }, + "VpcConnectionInfo": { + "target": "com.amazonaws.kafka#VpcConnectionInfo", + "traits": { + "smithy.api#documentation": "

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

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

Returns information about a provisioned cluster operation.

" + } + }, + "com.amazonaws.kafka#ClusterOperationV2Serverless": { + "type": "structure", + "members": { + "VpcConnectionInfo": { + "target": "com.amazonaws.kafka#VpcConnectionInfoServerless", + "traits": { + "smithy.api#documentation": "

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

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

Returns information about a serverless cluster operation.

" + } + }, + "com.amazonaws.kafka#ClusterOperationV2Summary": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

ARN of the cluster.

", + "smithy.api#jsonName": "clusterArn" + } + }, + "ClusterType": { + "target": "com.amazonaws.kafka#ClusterType", + "traits": { + "smithy.api#documentation": "

Type of the backend cluster.

", + "smithy.api#jsonName": "clusterType" + } + }, + "StartTime": { + "target": "com.amazonaws.kafka#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The time at which operation was started.

", + "smithy.api#jsonName": "startTime" + } + }, + "EndTime": { + "target": "com.amazonaws.kafka#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The time at which the operation finished.

", + "smithy.api#jsonName": "endTime" + } + }, + "OperationArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

ARN of the cluster operation.

", + "smithy.api#jsonName": "operationArn" + } + }, + "OperationState": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

State of the cluster operation.

", + "smithy.api#jsonName": "operationState" + } + }, + "OperationType": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

Type of the cluster operation.

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

Returns information about a cluster operation.

" + } + }, "com.amazonaws.kafka#ClusterState": { "type": "enum", "members": { @@ -2112,6 +2298,77 @@ "smithy.api#output": {} } }, + "com.amazonaws.kafka#DescribeClusterOperationV2": { + "type": "operation", + "input": { + "target": "com.amazonaws.kafka#DescribeClusterOperationV2Request" + }, + "output": { + "target": "com.amazonaws.kafka#DescribeClusterOperationV2Response" + }, + "errors": [ + { + "target": "com.amazonaws.kafka#BadRequestException" + }, + { + "target": "com.amazonaws.kafka#ForbiddenException" + }, + { + "target": "com.amazonaws.kafka#InternalServerErrorException" + }, + { + "target": "com.amazonaws.kafka#NotFoundException" + }, + { + "target": "com.amazonaws.kafka#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.kafka#TooManyRequestsException" + }, + { + "target": "com.amazonaws.kafka#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a description of the cluster operation specified by the ARN.

", + "smithy.api#http": { + "method": "GET", + "uri": "/api/v2/operations/{ClusterOperationArn}", + "code": 200 + } + } + }, + "com.amazonaws.kafka#DescribeClusterOperationV2Request": { + "type": "structure", + "members": { + "ClusterOperationArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "ARN of the cluster operation to describe.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.kafka#DescribeClusterOperationV2Response": { + "type": "structure", + "members": { + "ClusterOperationInfo": { + "target": "com.amazonaws.kafka#ClusterOperationV2", + "traits": { + "smithy.api#documentation": "

Cluster operation information

", + "smithy.api#jsonName": "clusterOperationInfo" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.kafka#DescribeClusterRequest": { "type": "structure", "members": { @@ -3102,6 +3359,9 @@ { "target": "com.amazonaws.kafka#DescribeClusterOperation" }, + { + "target": "com.amazonaws.kafka#DescribeClusterOperationV2" + }, { "target": "com.amazonaws.kafka#DescribeClusterV2" }, @@ -3129,6 +3389,9 @@ { "target": "com.amazonaws.kafka#ListClusterOperations" }, + { + "target": "com.amazonaws.kafka#ListClusterOperationsV2" + }, { "target": "com.amazonaws.kafka#ListClusters" }, @@ -4421,6 +4684,104 @@ "smithy.api#output": {} } }, + "com.amazonaws.kafka#ListClusterOperationsV2": { + "type": "operation", + "input": { + "target": "com.amazonaws.kafka#ListClusterOperationsV2Request" + }, + "output": { + "target": "com.amazonaws.kafka#ListClusterOperationsV2Response" + }, + "errors": [ + { + "target": "com.amazonaws.kafka#BadRequestException" + }, + { + "target": "com.amazonaws.kafka#ForbiddenException" + }, + { + "target": "com.amazonaws.kafka#InternalServerErrorException" + }, + { + "target": "com.amazonaws.kafka#NotFoundException" + }, + { + "target": "com.amazonaws.kafka#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.kafka#TooManyRequestsException" + }, + { + "target": "com.amazonaws.kafka#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all the operations that have been performed on the specified MSK cluster.

", + "smithy.api#http": { + "method": "GET", + "uri": "/api/v2/clusters/{ClusterArn}/operations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ClusterOperationInfoList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.kafka#ListClusterOperationsV2Request": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "The arn of the cluster whose operations are being requested.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.kafka#MaxResults", + "traits": { + "smithy.api#documentation": "The maxResults of the query.", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "The nextToken of the query.", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.kafka#ListClusterOperationsV2Response": { + "type": "structure", + "members": { + "ClusterOperationInfoList": { + "target": "com.amazonaws.kafka#__listOfClusterOperationV2Summary", + "traits": { + "smithy.api#documentation": "

An array of cluster operation information objects.

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

If the response of ListClusterOperationsV2 is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListClusterOperationsV2.

", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.kafka#ListClusters": { "type": "operation", "input": { @@ -7466,6 +7827,42 @@ "smithy.api#documentation": "

Description of the VPC connection.

" } }, + "com.amazonaws.kafka#VpcConnectionInfoServerless": { + "type": "structure", + "members": { + "CreationTime": { + "target": "com.amazonaws.kafka#__timestampIso8601", + "traits": { + "smithy.api#documentation": "

The time when Amazon MSK creates the VPC Connnection.

", + "smithy.api#jsonName": "creationTime" + } + }, + "Owner": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The owner of the VPC Connection.

", + "smithy.api#jsonName": "owner" + } + }, + "UserIdentity": { + "target": "com.amazonaws.kafka#UserIdentity", + "traits": { + "smithy.api#documentation": "

Description of the requester that calls the API operation.

", + "smithy.api#jsonName": "userIdentity" + } + }, + "VpcConnectionArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

", + "smithy.api#jsonName": "vpcConnectionArn" + } + } + }, + "traits": { + "smithy.api#documentation": "Description of the VPC connection." + } + }, "com.amazonaws.kafka#VpcConnectionState": { "type": "enum", "members": { @@ -7735,6 +8132,12 @@ "target": "com.amazonaws.kafka#ClusterOperationStep" } }, + "com.amazonaws.kafka#__listOfClusterOperationV2Summary": { + "type": "list", + "member": { + "target": "com.amazonaws.kafka#ClusterOperationV2Summary" + } + }, "com.amazonaws.kafka#__listOfCompatibleKafkaVersion": { "type": "list", "member": { diff --git a/codegen/sdk/aws-models/kinesis-video-archived-media.json b/codegen/sdk/aws-models/kinesis-video-archived-media.json index 15ffeafe0aac..58f4391edec5 100644 --- a/codegen/sdk/aws-models/kinesis-video-archived-media.json +++ b/codegen/sdk/aws-models/kinesis-video-archived-media.json @@ -959,22 +959,24 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the timestamp range and timestamp origin of a range of fragments.

\n

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 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.

\n

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 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.

\n

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.

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

The starting timestamp in the range of timestamps for which to return fragments.

\n

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.

", "smithy.api#required": {} } }, "EndTimestamp": { "target": "com.amazonaws.kinesisvideoarchivedmedia#Timestamp", "traits": { - "smithy.api#documentation": "

The end of the timestamp range for the requested media.

\n

This 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.

\n

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.

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

The end of the timestamp range for the requested media.

\n

This 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.

\n

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.

", "smithy.api#required": {} } } @@ -1000,18 +1002,20 @@ } }, "com.amazonaws.kinesisvideoarchivedmedia#ContainerFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FRAGMENTED_MP4", - "name": "FRAGMENTED_MP4" - }, - { - "value": "MPEG_TS", - "name": "MPEG_TS" + "type": "enum", + "members": { + "FRAGMENTED_MP4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FRAGMENTED_MP4" + } + }, + "MPEG_TS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MPEG_TS" } - ] + } } }, "com.amazonaws.kinesisvideoarchivedmedia#ContentType": { @@ -1025,33 +1029,37 @@ } }, "com.amazonaws.kinesisvideoarchivedmedia#DASHDisplayFragmentNumber": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ALWAYS", - "name": "ALWAYS" - }, - { - "value": "NEVER", - "name": "NEVER" + "type": "enum", + "members": { + "ALWAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALWAYS" + } + }, + "NEVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEVER" } - ] + } } }, "com.amazonaws.kinesisvideoarchivedmedia#DASHDisplayFragmentTimestamp": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ALWAYS", - "name": "ALWAYS" - }, - { - "value": "NEVER", - "name": "NEVER" + "type": "enum", + "members": { + "ALWAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALWAYS" + } + }, + "NEVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEVER" } - ] + } } }, "com.amazonaws.kinesisvideoarchivedmedia#DASHFragmentSelector": { @@ -1060,13 +1068,13 @@ "FragmentSelectorType": { "target": "com.amazonaws.kinesisvideoarchivedmedia#DASHFragmentSelectorType", "traits": { - "smithy.api#documentation": "

The source of the timestamps for the requested media.

\n

When 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.

\n

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.

\n

When 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.

\n

The default is SERVER_TIMESTAMP.

" + "smithy.api#documentation": "

The source of the timestamps for the requested media.

\n

When 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.

\n

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.

\n

When 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.

\n

The default is SERVER_TIMESTAMP.

" } }, "TimestampRange": { "target": "com.amazonaws.kinesisvideoarchivedmedia#DASHTimestampRange", "traits": { - "smithy.api#documentation": "

The start and end of the timestamp range for the requested media.

\n

This value should not be present if PlaybackType is\n LIVE.

" + "smithy.api#documentation": "

The start and end of the timestamp range for the requested media.

\n

This value should not be present if PlaybackType is\n LIVE.

" } } }, @@ -1075,18 +1083,20 @@ } }, "com.amazonaws.kinesisvideoarchivedmedia#DASHFragmentSelectorType": { - "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#DASHMaxResults": { @@ -1099,22 +1109,26 @@ } }, "com.amazonaws.kinesisvideoarchivedmedia#DASHPlaybackMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LIVE", - "name": "LIVE" - }, - { - "value": "LIVE_REPLAY", - "name": "LIVE_REPLAY" - }, - { - "value": "ON_DEMAND", - "name": "ON_DEMAND" + "type": "enum", + "members": { + "LIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIVE" + } + }, + "LIVE_REPLAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIVE_REPLAY" + } + }, + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND" } - ] + } } }, "com.amazonaws.kinesisvideoarchivedmedia#DASHStreamingSessionURL": { @@ -1126,18 +1140,18 @@ "StartTimestamp": { "target": "com.amazonaws.kinesisvideoarchivedmedia#Timestamp", "traits": { - "smithy.api#documentation": "

The start of the timestamp range for the requested media.

\n

If the DASHTimestampRange value is specified, the\n StartTimestamp value is required.

\n

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.

" + "smithy.api#documentation": "

The start of the timestamp range for the requested media.

\n

If the DASHTimestampRange value is specified, the\n StartTimestamp value is required.

\n

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.

" } }, "EndTimestamp": { "target": "com.amazonaws.kinesisvideoarchivedmedia#Timestamp", "traits": { - "smithy.api#documentation": "

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.

\n

If FragmentSelectorType for the request is SERVER_TIMESTAMP,\n this value must be in the past.

\n\n

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.

\n \n

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.

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

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.

\n

If FragmentSelectorType for the request is SERVER_TIMESTAMP,\n this value must be in the past.

\n

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.

\n \n

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.

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

The start and end of the timestamp range for the requested media.

\n

This value should not be present if PlaybackType is\n LIVE.

\n

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.

" + "smithy.api#documentation": "

The start and end of the timestamp range for the requested media.

\n

This value should not be present if PlaybackType is\n LIVE.

\n

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.

" } }, "com.amazonaws.kinesisvideoarchivedmedia#ErrorMessage": { @@ -1153,18 +1167,20 @@ } }, "com.amazonaws.kinesisvideoarchivedmedia#Format": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "JPEG", - "name": "JPEG" - }, - { - "value": "PNG", - "name": "PNG" + "type": "enum", + "members": { + "JPEG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JPEG" + } + }, + "PNG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PNG" } - ] + } } }, "com.amazonaws.kinesisvideoarchivedmedia#FormatConfig": { @@ -1183,14 +1199,14 @@ } }, "com.amazonaws.kinesisvideoarchivedmedia#FormatConfigKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "JPEGQuality", - "name": "JPEGQuality" + "type": "enum", + "members": { + "JPEGQuality": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JPEGQuality" } - ] + } } }, "com.amazonaws.kinesisvideoarchivedmedia#FormatConfigValue": { @@ -1228,7 +1244,7 @@ "ServerTimestamp": { "target": "com.amazonaws.kinesisvideoarchivedmedia#Timestamp", "traits": { - "smithy.api#documentation": "

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.

\n

Only 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:

\n
    \n
  • \n

    00:00:00

    \n
    • \n
  • \n

    00:00:02

    \n
    • \n
  • \n

    00:00:04

    \n
    • \n
  • \n

    00:00:06

    \n
    • \n
\n

A 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.

\n

Only 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:

\n
    \n
  • \n

    00:00:00

    \n
    • \n
  • \n

    00:00:02

    \n
    • \n
  • \n

    00:00:04

    \n
    • \n
  • \n

    00:00:06

    \n
    • \n
\n

A 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.

\n

Both 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\n

As a prerequisite to using GetCLip API, you must obtain an endpoint using\n GetDataEndpoint, specifying GET_CLIP for the\n APIName parameter.

\n

An Amazon Kinesis video stream has the following requirements for providing data\n through MP4:

\n
    \n
  • \n

    The 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).

    \n
    • \n
  • \n

    Data retention must be greater than 0.

    \n
    • \n
  • \n

    The 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.

    \n
    • \n
  • \n

    The 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.

    \n
    • \n
\n\n

You 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.

", + "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.

\n

Both 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

As a prerequisite to using GetCLip API, you must obtain an endpoint using\n GetDataEndpoint, specifying GET_CLIP for the\n APIName parameter.

\n

An Amazon Kinesis video stream has the following requirements for providing data\n through MP4:

\n
    \n
  • \n

    The 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).

    \n
    • \n
  • \n

    Data retention must be greater than 0.

    \n
    • \n
  • \n

    The 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.

    \n
    • \n
  • \n

    The 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.

    \n
    • \n
\n

You 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.

", "smithy.api#http": { "method": "POST", "uri": "/getClip", @@ -1360,13 +1378,13 @@ "StreamName": { "target": "com.amazonaws.kinesisvideoarchivedmedia#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream for which to retrieve the media clip.

\n

You must specify either the StreamName or the StreamARN.

" + "smithy.api#documentation": "

The name of the stream for which to retrieve the media clip.

\n

You 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.

\n

You 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.

\n

You 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 \n

Both 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.

\n

An Amazon Kinesis video stream has the following requirements for providing data\n through MPEG-DASH:

\n
    \n
  • \n

    The 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).

    \n
    • \n
  • \n

    Data retention must be greater than 0.

    \n
    • \n
  • \n

    The 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.

    \n
    • \n
  • \n

    The 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.

    \n
    • \n
\n\n

The following procedure shows how to use MPEG-DASH with Kinesis Video Streams:

\n
    \n
  1. \n

    Get an endpoint using GetDataEndpoint, specifying\n GET_DASH_STREAMING_SESSION_URL for the APIName\n parameter.

    \n
    2. \n
  2. \n

    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).

    \n \n

    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.

    \n     \n

    The 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.

    \n
    3. \n
  3. \n

    Provide 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.

    \n
    4. \n
  4. \n

    The 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
    • \n

      \n GetDASHManifest: Retrieves an MPEG DASH\n manifest, which contains the metadata for the media that you want to\n playback.

      \n
      • \n
    • \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.

      \n

      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
    • \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.

      \n \n

      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.

      \n       \n

      Data retrieved with this action is billable. See Pricing for details.

      \n
      • \n
    \n
    5. \n
\n \n

For restrictions that apply to MPEG-DASH sessions, see Kinesis Video Streams Limits.

\n \n

You 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.

\n

For more information about HLS, see HTTP Live Streaming on the\n Apple Developer site.

\n\n \n

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
  • \n

    \n x-amz-ErrorType HTTP header – contains a more specific error\n type in addition to what the HTTP status code provides.

    \n
    • \n
  • \n

    \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.

    \n
    • \n
\n

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.

\n

For more information, see the Errors section at\n the bottom of this topic, as well as Common Errors.\n

\n ", + "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

Both 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.

\n

An Amazon Kinesis video stream has the following requirements for providing data\n through MPEG-DASH:

\n
    \n
  • \n

    The 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).

    \n
    • \n
  • \n

    Data retention must be greater than 0.

    \n
    • \n
  • \n

    The 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.

    \n
    • \n
  • \n

    The 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.

    \n
    • \n
\n

The following procedure shows how to use MPEG-DASH with Kinesis Video Streams:

\n
    \n
  1. \n

    Get an endpoint using GetDataEndpoint, specifying\n GET_DASH_STREAMING_SESSION_URL for the APIName\n parameter.

    \n
    2. \n
  2. \n

    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).

    \n \n

    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.

    \n     \n

    The 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.

    \n
    3. \n
  3. \n

    Provide 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.

    \n
    4. \n
  4. \n

    The 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
    • \n

      \n GetDASHManifest: Retrieves an MPEG DASH\n manifest, which contains the metadata for the media that you want to\n playback.

      \n
      • \n
    • \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.

      \n

      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
    • \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.

      \n \n

      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.

      \n       \n

      Data retrieved with this action is billable. See Pricing for details.

      \n
      • \n
    \n
    5. \n
\n \n

For restrictions that apply to MPEG-DASH sessions, see Kinesis Video Streams Limits.

\n \n

You 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.

\n

For more information about HLS, see HTTP Live Streaming on the\n Apple Developer site.

\n \n

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
  • \n

    \n x-amz-ErrorType HTTP header – contains a more specific error\n type in addition to what the HTTP status code provides.

    \n
    • \n
  • \n

    \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.

    \n
    • \n
\n

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.

\n

For more information, see the Errors section at\n the bottom of this topic, as well as Common Errors.\n

\n ", "smithy.api#http": { "method": "POST", "uri": "/getDASHStreamingSessionURL", @@ -1447,51 +1471,54 @@ "StreamName": { "target": "com.amazonaws.kinesisvideoarchivedmedia#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream for which to retrieve the MPEG-DASH manifest URL.

\n

You must specify either the StreamName or the\n StreamARN.

" + "smithy.api#documentation": "

The name of the stream for which to retrieve the MPEG-DASH manifest URL.

\n

You must specify either the StreamName or the\n StreamARN.

" } }, "StreamARN": { "target": "com.amazonaws.kinesisvideoarchivedmedia#ResourceARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH\n manifest URL.

\n

You must specify either the StreamName or the\n StreamARN.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH\n manifest URL.

\n

You must specify either the StreamName or the\n StreamARN.

" } }, "PlaybackMode": { "target": "com.amazonaws.kinesisvideoarchivedmedia#DASHPlaybackMode", "traits": { - "smithy.api#documentation": "

Whether to retrieve live, live replay, or archived, on-demand data.

\n

Features of the three types of sessions include the following:

\n
    \n
  • \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.

    \n \n

    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
    • \n
  • \n

    \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
  • \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.

    \n
    • \n
\n

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.

\n

The default is LIVE.

" + "smithy.api#documentation": "

Whether to retrieve live, live replay, or archived, on-demand data.

\n

Features of the three types of sessions include the following:

\n
    \n
  • \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.

    \n \n

    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
    • \n
  • \n

    \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
  • \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.

    \n
    • \n
\n

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.

\n

The default is LIVE.

" } }, "DisplayFragmentTimestamp": { "target": "com.amazonaws.kinesisvideoarchivedmedia#DASHDisplayFragmentTimestamp", "traits": { - "smithy.api#documentation": "

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.

\n

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.

" + "smithy.api#documentation": "

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.

\n

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.

" } }, "DisplayFragmentNumber": { "target": "com.amazonaws.kinesisvideoarchivedmedia#DASHDisplayFragmentNumber", "traits": { - "smithy.api#documentation": "

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.

\n

The default value is NEVER.

" + "smithy.api#documentation": "

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.

\n

The default value is NEVER.

" } }, "DASHFragmentSelector": { "target": "com.amazonaws.kinesisvideoarchivedmedia#DASHFragmentSelector", "traits": { - "smithy.api#documentation": "

The time range of the requested fragment and the source of the timestamps.

\n

This 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.

" + "smithy.api#documentation": "

The time range of the requested fragment and the source of the timestamps.

\n

This 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.

" } }, "Expires": { "target": "com.amazonaws.kinesisvideoarchivedmedia#Expires", "traits": { - "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).

\n

When a session expires, no new calls to GetDashManifest,\n GetMP4InitFragment, or GetMP4MediaFragment can be made for\n that session.

\n

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).

\n

When a session expires, no new calls to GetDashManifest,\n GetMP4InitFragment, or GetMP4MediaFragment can be made for\n that session.

\n

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.

\n

When 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.

\n

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.

\n

The default is 5 fragments if PlaybackMode is LIVE or\n LIVE_REPLAY, and 1,000 if PlaybackMode is\n ON_DEMAND.

\n

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.

\n

When 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.

\n

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.

\n

The default is 5 fragments if PlaybackMode is LIVE or\n LIVE_REPLAY, and 1,000 if PlaybackMode is\n ON_DEMAND.

\n

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.

\n

Both 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.

\n

An Amazon Kinesis video stream has the following requirements for providing data\n through HLS:

\n
    \n
  • \n

    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.

    \n
    • \n
  • \n

    Data retention must be greater than 0.

    \n
    • \n
  • \n

    The 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.

    \n
    • \n
  • \n

    The audio track (if present) of each fragment must contain codec private data\n in the AAC format (AAC\n specification ISO/IEC 13818-7).

    \n
    • \n
\n

Kinesis 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.

\n

The following procedure shows how to use HLS with Kinesis Video Streams:

\n
    \n
  1. \n

    Get an endpoint using GetDataEndpoint, specifying\n GET_HLS_STREAMING_SESSION_URL for the APIName\n parameter.

    \n
    2. \n
  2. \n

    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).

    \n \n

    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.

    \n     \n

    The 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.

    \n
    3. \n
  3. \n

    Provide 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.

    \n
    4. \n
  4. \n

    The 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
    • \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
      • \n
    • \n

      \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
      • \n
    • \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.

      \n

      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
    • \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.

      \n \n

      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.

      \n       \n

      Data retrieved with this action is billable. See Pricing for details.

      \n
      • \n
    • \n

      \n GetTSFragment: Retrieves MPEG TS\n fragments containing both initialization and media data for all tracks\n in the stream.

      \n \n

      If the ContainerFormat is MPEG_TS, this\n API is used instead of GetMP4InitFragment and\n GetMP4MediaFragment to retrieve stream\n media.

      \n       \n

      Data retrieved with this action is billable. For more information, see\n Kinesis Video Streams pricing.

      \n
      • \n
    \n
    5. \n
\n

A 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.

\n

You 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.

\n

For more information about HLS, see HTTP Live Streaming on the\n Apple Developer site.

\n\n \n

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
  • \n

    \n x-amz-ErrorType HTTP header – contains a more specific error\n type in addition to what the HTTP status code provides.

    \n
    • \n
  • \n

    \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.

    \n
    • \n
\n

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.

\n

For more information, see the Errors section at\n the bottom of this topic, as well as Common Errors.\n

\n ", + "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.

\n

Both 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.

\n

An Amazon Kinesis video stream has the following requirements for providing data\n through HLS:

\n
    \n
  • \n

    For 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.

    \n
    • \n
  • \n

    Data retention must be greater than 0.

    \n
    • \n
  • \n

    The 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.

    \n
    • \n
  • \n

    The audio track (if present) of each fragment must contain codec private data\n in the AAC format (AAC\n specification ISO/IEC 13818-7).

    \n
    • \n
\n

Kinesis 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.

\n

The following procedure shows how to use HLS with Kinesis Video Streams:

\n
    \n
  1. \n

    Get an endpoint using GetDataEndpoint, specifying\n GET_HLS_STREAMING_SESSION_URL for the APIName\n parameter.

    \n
    2. \n
  2. \n

    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).

    \n \n

    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.

    \n     \n

    The 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.

    \n
    3. \n
  3. \n

    Provide 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.

    \n
    4. \n
  4. \n

    The 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
    • \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
      • \n
    • \n

      \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
      • \n
    • \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.

      \n

      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
    • \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.

      \n \n

      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.

      \n       \n

      Data retrieved with this action is billable. For information, see\n Pricing.

      \n
      • \n
    • \n

      \n GetTSFragment: Retrieves MPEG TS\n fragments containing both initialization and media data for all tracks\n in the stream.

      \n \n

      If the ContainerFormat is MPEG_TS, this\n API is used instead of GetMP4InitFragment and\n GetMP4MediaFragment to retrieve stream\n media.

      \n       \n

      Data retrieved with this action is billable. For more information, see\n Kinesis Video Streams pricing.

      \n
      • \n
    \n
    5. \n
\n

A 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.

\n

You 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.

\n

For more information about HLS, see HTTP Live Streaming on the\n Apple Developer site.

\n \n

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
  • \n

    \n x-amz-ErrorType HTTP header – contains a more specific error\n type in addition to what the HTTP status code provides.

    \n
    • \n
  • \n

    \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.

    \n
    • \n
\n

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.

\n

For more information, see the Errors section at\n the bottom of this topic, as well as Common Errors.\n

\n ", "smithy.api#http": { "method": "POST", "uri": "/getHLSStreamingSessionURL", @@ -1554,57 +1584,60 @@ "StreamName": { "target": "com.amazonaws.kinesisvideoarchivedmedia#StreamName", "traits": { - "smithy.api#documentation": "

The name of the stream for which to retrieve the HLS master playlist URL.

\n

You must specify either the StreamName or the\n StreamARN.

" + "smithy.api#documentation": "

The name of the stream for which to retrieve the HLS master playlist URL.

\n

You must specify either the StreamName or the\n StreamARN.

" } }, "StreamARN": { "target": "com.amazonaws.kinesisvideoarchivedmedia#ResourceARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master\n playlist URL.

\n

You must specify either the StreamName or the\n StreamARN.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master\n playlist URL.

\n

You must specify either the StreamName or the\n StreamARN.

" } }, "PlaybackMode": { "target": "com.amazonaws.kinesisvideoarchivedmedia#HLSPlaybackMode", "traits": { - "smithy.api#documentation": "

Whether to retrieve live, live replay, or archived, on-demand data.

\n

Features of the three types of sessions include the following:

\n
    \n
  • \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.

    \n \n

    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
    • \n
  • \n

    \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
  • \n

    \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.

    \n
    • \n
\n

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.

\n

The default is LIVE.

" + "smithy.api#documentation": "

Whether to retrieve live, live replay, or archived, on-demand data.

\n

Features of the three types of sessions include the following:

\n
    \n
  • \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.

    \n \n

    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
    • \n
  • \n

    \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
  • \n

    \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.

    \n
    • \n
\n

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.

\n

The default is LIVE.

" } }, "HLSFragmentSelector": { "target": "com.amazonaws.kinesisvideoarchivedmedia#HLSFragmentSelector", "traits": { - "smithy.api#documentation": "

The time range of the requested fragment and the source of the timestamps.

\n

This 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.

" + "smithy.api#documentation": "

The time range of the requested fragment and the source of the timestamps.

\n

This 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.

" } }, "ContainerFormat": { "target": "com.amazonaws.kinesisvideoarchivedmedia#ContainerFormat", "traits": { - "smithy.api#documentation": "

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.

\n

The default is FRAGMENTED_MP4.

" + "smithy.api#documentation": "

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.

\n

The default is FRAGMENTED_MP4.

" } }, "DiscontinuityMode": { "target": "com.amazonaws.kinesisvideoarchivedmedia#HLSDiscontinuityMode", "traits": { - "smithy.api#documentation": "

Specifies when flags marking discontinuities between fragments are added to the media\n playlists.

\n

Media 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.

\n

The following modes are supported:

\n
    \n
  • \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
    • \n
  • \n

    \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
    • \n
  • \n

    \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).

    \n
    • \n
\n

The default is ALWAYS when HLSFragmentSelector is set\n to SERVER_TIMESTAMP, and NEVER when it is set to\n PRODUCER_TIMESTAMP.

" + "smithy.api#documentation": "

Specifies when flags marking discontinuities between fragments are added to the media\n playlists.

\n

Media 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.

\n

The following modes are supported:

\n
    \n
  • \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
    • \n
  • \n

    \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
    • \n
  • \n

    \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).

    \n
    • \n
\n

The default is ALWAYS when HLSFragmentSelector is set\n to SERVER_TIMESTAMP, and NEVER when it is set to\n PRODUCER_TIMESTAMP.

" } }, "DisplayFragmentTimestamp": { "target": "com.amazonaws.kinesisvideoarchivedmedia#HLSDisplayFragmentTimestamp", "traits": { - "smithy.api#documentation": "

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.

\n

The 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

" + "smithy.api#documentation": "

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.

\n

The 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

" } }, "Expires": { "target": "com.amazonaws.kinesisvideoarchivedmedia#Expires", "traits": { - "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).

\n

When a session expires, no new calls to GetHLSMasterPlaylist,\n GetHLSMediaPlaylist, GetMP4InitFragment,\n GetMP4MediaFragment, or GetTSFragment can be made for that\n session.

\n

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).

\n

When a session expires, no new calls to GetHLSMasterPlaylist,\n GetHLSMediaPlaylist, GetMP4InitFragment,\n GetMP4MediaFragment, or GetTSFragment can be made for that\n session.

\n

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.

\n

When 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.

\n

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.

\n

The default is 5 fragments if PlaybackMode is LIVE or\n LIVE_REPLAY, and 1,000 if PlaybackMode is\n ON_DEMAND.

\n

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.

\n

When 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.

\n

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.

\n

The default is 5 fragments if PlaybackMode is LIVE or\n LIVE_REPLAY, and 1,000 if PlaybackMode is\n ON_DEMAND.

\n

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.

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

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

\n \n

The minimum value of 3000 ms is a soft limit. If needed, a lower sampling frequency can be requested.

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

The 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.

\n \n

The minimum value of 200 ms is a hard limit.

\n " } }, "Format": { @@ -1720,7 +1755,7 @@ "MaxResults": { "target": "com.amazonaws.kinesisvideoarchivedmedia#GetImagesMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of images to be returned by the API.

\n \n

The default limit is 100 images per API response. The additional results will be paginated.

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

The maximum number of images to be returned by the API.

\n \n

The 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.

\n " } }, "NextToken": { @@ -1729,6 +1764,9 @@ "smithy.api#documentation": "

A token that specifies where to start paginating the next set of Images. This is the GetImages:NextToken from a previously truncated response.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideoarchivedmedia#GetImagesMaxResults": { @@ -1755,6 +1793,9 @@ "smithy.api#documentation": "

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\n \n

You 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.

\n \n\n

For limits, see Kinesis Video Streams Limits.

\n\n \n

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
  • \n

    \n x-amz-ErrorType HTTP header – contains a more specific error\n type in addition to what the HTTP status code provides.

    \n
    • \n
  • \n

    \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.

    \n
    • \n
\n

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.

\n

For more information, see the Errors section at\n the bottom of this topic, as well as Common Errors.\n

\n ", + "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 \n

You 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.

\n \n

For limits, see Kinesis Video Streams Limits.

\n \n

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
  • \n

    \n x-amz-ErrorType HTTP header – contains a more specific error\n type in addition to what the HTTP status code provides.

    \n
    • \n
  • \n

    \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.

    \n
    • \n
\n

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.

\n

For more information, see the Errors section at\n the bottom of this topic, as well as Common Errors.\n

\n ", "smithy.api#http": { "method": "POST", "uri": "/getMediaForFragmentList", @@ -1810,6 +1851,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.kinesisvideoarchivedmedia#GetMediaForFragmentListOutput": { @@ -1826,44 +1870,53 @@ "target": "com.amazonaws.kinesisvideoarchivedmedia#Payload", "traits": { "smithy.api#default": "", - "smithy.api#documentation": "

The 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:

\n
    \n
  • \n

    AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the\n chunk.

    \n
    • \n
  • \n

    AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side timestamp of the\n fragment.

    \n
    • \n
  • \n

    AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp of the\n fragment.

    \n
    • \n
\n

The following tags will be included if an exception occurs:

\n
    \n
  • \n

    AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the\n exception

    \n
    • \n
  • \n

    AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the\n exception

    \n
    • \n
  • \n

    AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the\n exception

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

The 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:

\n
    \n
  • \n

    AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the\n chunk.

    \n
    • \n
  • \n

    AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side timestamp of the\n fragment.

    \n
    • \n
  • \n

    AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp of the\n fragment.

    \n
    • \n
\n

The following tags will be included if an exception occurs:

\n
    \n
  • \n

    AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the exception\n

    \n
    • \n
  • \n

    AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the\n

    \n
    • \n
  • \n

    AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception\n

    \n
    • \n
", "smithy.api#httpPayload": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideoarchivedmedia#HLSDiscontinuityMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ALWAYS", - "name": "ALWAYS" - }, - { - "value": "NEVER", - "name": "NEVER" - }, - { - "value": "ON_DISCONTINUITY", - "name": "ON_DISCONTINUITY" + "type": "enum", + "members": { + "ALWAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALWAYS" } - ] + }, + "NEVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEVER" + } + }, + "ON_DISCONTINUITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DISCONTINUITY" + } + } } }, "com.amazonaws.kinesisvideoarchivedmedia#HLSDisplayFragmentTimestamp": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ALWAYS", - "name": "ALWAYS" - }, - { - "value": "NEVER", - "name": "NEVER" + "type": "enum", + "members": { + "ALWAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALWAYS" } - ] + }, + "NEVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEVER" + } + } } }, "com.amazonaws.kinesisvideoarchivedmedia#HLSFragmentSelector": { @@ -1872,13 +1925,13 @@ "FragmentSelectorType": { "target": "com.amazonaws.kinesisvideoarchivedmedia#HLSFragmentSelectorType", "traits": { - "smithy.api#documentation": "

The source of the timestamps for the requested media.

\n

When 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.

\n

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.

\n

When 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.

\n

The default is SERVER_TIMESTAMP.

" + "smithy.api#documentation": "

The source of the timestamps for the requested media.

\n

When 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.

\n

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.

\n

When 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.

\n

The default is SERVER_TIMESTAMP.

" } }, "TimestampRange": { "target": "com.amazonaws.kinesisvideoarchivedmedia#HLSTimestampRange", "traits": { - "smithy.api#documentation": "

The start and end of the timestamp range for the requested media.

\n

This value should not be present if PlaybackType is\n LIVE.

" + "smithy.api#documentation": "

The start and end of the timestamp range for the requested media.

\n

This value should not be present if PlaybackType is\n LIVE.

" } } }, @@ -1887,18 +1940,20 @@ } }, "com.amazonaws.kinesisvideoarchivedmedia#HLSFragmentSelectorType": { - "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#HLSMaxResults": { @@ -1911,22 +1966,26 @@ } }, "com.amazonaws.kinesisvideoarchivedmedia#HLSPlaybackMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LIVE", - "name": "LIVE" - }, - { - "value": "LIVE_REPLAY", - "name": "LIVE_REPLAY" - }, - { - "value": "ON_DEMAND", - "name": "ON_DEMAND" + "type": "enum", + "members": { + "LIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIVE" + } + }, + "LIVE_REPLAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIVE_REPLAY" + } + }, + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND" } - ] + } } }, "com.amazonaws.kinesisvideoarchivedmedia#HLSStreamingSessionURL": { @@ -1938,18 +1997,18 @@ "StartTimestamp": { "target": "com.amazonaws.kinesisvideoarchivedmedia#Timestamp", "traits": { - "smithy.api#documentation": "

The start of the timestamp range for the requested media.

\n

If the HLSTimestampRange value is specified, the\n StartTimestamp value is required.

\n

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.

" + "smithy.api#documentation": "

The start of the timestamp range for the requested media.

\n

If the HLSTimestampRange value is specified, the\n StartTimestamp value is required.

\n

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.

" } }, "EndTimestamp": { "target": "com.amazonaws.kinesisvideoarchivedmedia#Timestamp", "traits": { - "smithy.api#documentation": "

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.

\n

If FragmentSelectorType for the request is SERVER_TIMESTAMP,\n this value must be in the past.

\n

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.

\n \n

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.

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

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.

\n

If FragmentSelectorType for the request is SERVER_TIMESTAMP,\n this value must be in the past.

\n

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.

\n \n

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.

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

The start and end of the timestamp range for the requested media.

\n

This value should not be present if PlaybackType is\n LIVE.

" + "smithy.api#documentation": "

The start and end of the timestamp range for the requested media.

\n

This value should not be present if PlaybackType is\n LIVE.

" } }, "com.amazonaws.kinesisvideoarchivedmedia#HeightPixels": { @@ -1973,7 +2032,7 @@ "Error": { "target": "com.amazonaws.kinesisvideoarchivedmedia#ImageError", "traits": { - "smithy.api#documentation": "

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:

\n
    \n
  • \n

    There is no media that exists for the specified Timestamp.

    \n
    • \n
\n
    \n
  • \n

    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.

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

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:

\n
    \n
  • \n

    There is no media that exists for the specified Timestamp.

    \n
    • \n
\n
    \n
  • \n

    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.

    \n
    • \n
" } }, "ImageContent": { @@ -1997,33 +2056,37 @@ } }, "com.amazonaws.kinesisvideoarchivedmedia#ImageError": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NO_MEDIA", - "name": "NO_MEDIA" - }, - { - "value": "MEDIA_ERROR", - "name": "MEDIA_ERROR" + "type": "enum", + "members": { + "NO_MEDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_MEDIA" } - ] + }, + "MEDIA_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIA_ERROR" + } + } } }, "com.amazonaws.kinesisvideoarchivedmedia#ImageSelectorType": { - "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#Images": { @@ -2094,7 +2157,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of Fragment objects from the specified stream and\n timestamp range within the archived data.

\n

Listing 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.

\n \n

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.

\n \n\n \n

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
  • \n

    \n x-amz-ErrorType HTTP header – contains a more specific error\n type in addition to what the HTTP status code provides.

    \n
    • \n
  • \n

    \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.

    \n
    • \n
\n

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.

\n

For more information, see the Errors section at\n the bottom of this topic, as well as Common Errors.\n

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

Returns a list of Fragment objects from the specified stream and\n timestamp range within the archived data.

\n

Listing 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.

\n \n

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.

\n \n \n

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
  • \n

    \n x-amz-ErrorType HTTP header – contains a more specific error\n type in addition to what the HTTP status code provides.

    \n
    • \n
  • \n

    \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.

    \n
    • \n
\n

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.

\n

For more information, see the Errors section at\n the bottom of this topic, as well as Common Errors.\n

\n ", "smithy.api#http": { "method": "POST", "uri": "/listFragments", @@ -2135,6 +2198,9 @@ "smithy.api#documentation": "

Describes 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.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.kinesisvideoarchivedmedia#Long": { @@ -2242,19 +2311,13 @@ } }, "traits": { - "smithy.api#documentation": "

\n GetMedia throws this error when Kinesis Video Streams can't find the stream\n that you specified.

\n

\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.

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

\n GetImages will throw this error when Kinesis Video Streams can't find the stream\n that you specified.

\n

\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.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.kinesisvideoarchivedmedia#SamplingInterval": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 3000, - "max": 20000 - } - } + "type": "integer" }, "com.amazonaws.kinesisvideoarchivedmedia#StreamName": { "type": "string", diff --git a/codegen/sdk/aws-models/kinesis-video.json b/codegen/sdk/aws-models/kinesis-video.json index b4f82b6a02d1..164994cb4b49 100644 --- a/codegen/sdk/aws-models/kinesis-video.json +++ b/codegen/sdk/aws-models/kinesis-video.json @@ -1899,52 +1899,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", @@ -1952,13 +1956,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -1968,224 +1981,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://kinesisvideo-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://kinesisvideo-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://kinesisvideo-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://kinesisvideo-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://kinesisvideo.{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://kinesisvideo.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://kinesisvideo.{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://kinesisvideo.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -3622,13 +3586,7 @@ } }, "com.amazonaws.kinesisvideo#SamplingInterval": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 3000, - "max": 20000 - } - } + "type": "integer" }, "com.amazonaws.kinesisvideo#ScheduleConfig": { "type": "structure", @@ -4574,7 +4532,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that \n can specified :

\n
    \n
  • \n

    If the StorageStatus is disabled, no data will be stored,\n and the StreamARN parameter will not be needed.

    \n
    • \n
  • \n

    If the StorageStatus is enabled, the data will be stored in the \n StreamARN provided.

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

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that \n can specified :

\n
    \n
  • \n

    If the StorageStatus is disabled, no data will be stored,\n and the StreamARN parameter will not be needed.

    \n
    • \n
  • \n

    If the StorageStatus is enabled, the data will be stored in the \n StreamARN provided.

    \n
    • \n
\n \n

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.

\n ", "smithy.api#http": { "method": "POST", "uri": "/updateMediaStorageConfiguration", diff --git a/codegen/sdk/aws-models/lookoutequipment.json b/codegen/sdk/aws-models/lookoutequipment.json index e978ff35b057..54cccb29df87 100644 --- a/codegen/sdk/aws-models/lookoutequipment.json +++ b/codegen/sdk/aws-models/lookoutequipment.json @@ -63,6 +63,9 @@ { "target": "com.amazonaws.lookoutequipment#DeleteModel" }, + { + "target": "com.amazonaws.lookoutequipment#DeleteResourcePolicy" + }, { "target": "com.amazonaws.lookoutequipment#DescribeDataIngestionJob" }, @@ -81,6 +84,18 @@ { "target": "com.amazonaws.lookoutequipment#DescribeModel" }, + { + "target": "com.amazonaws.lookoutequipment#DescribeModelVersion" + }, + { + "target": "com.amazonaws.lookoutequipment#DescribeResourcePolicy" + }, + { + "target": "com.amazonaws.lookoutequipment#ImportDataset" + }, + { + "target": "com.amazonaws.lookoutequipment#ImportModelVersion" + }, { "target": "com.amazonaws.lookoutequipment#ListDataIngestionJobs" }, @@ -105,12 +120,18 @@ { "target": "com.amazonaws.lookoutequipment#ListModels" }, + { + "target": "com.amazonaws.lookoutequipment#ListModelVersions" + }, { "target": "com.amazonaws.lookoutequipment#ListSensorStatistics" }, { "target": "com.amazonaws.lookoutequipment#ListTagsForResource" }, + { + "target": "com.amazonaws.lookoutequipment#PutResourcePolicy" + }, { "target": "com.amazonaws.lookoutequipment#StartDataIngestionJob" }, @@ -126,6 +147,9 @@ { "target": "com.amazonaws.lookoutequipment#UntagResource" }, + { + "target": "com.amazonaws.lookoutequipment#UpdateActiveModelVersion" + }, { "target": "com.amazonaws.lookoutequipment#UpdateInferenceScheduler" }, @@ -207,52 +231,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", @@ -260,13 +288,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -276,224 +313,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://lookoutequipment-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://lookoutequipment-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://lookoutequipment-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://lookoutequipment-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://lookoutequipment.{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://lookoutequipment.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://lookoutequipment.{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://lookoutequipment.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -999,7 +987,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a container for a collection of data being ingested for analysis. The dataset\n contains the metadata describing where the data is and what the data actually looks like.\n In other words, it contains the location of the data source, the data schema, and other\n information. A dataset also contains any tags associated with the ingested data.

" + "smithy.api#documentation": "

Creates a container for a collection of data being ingested for analysis. The dataset\n contains the metadata describing where the data is and what the data actually looks like.\n For example, it contains the location of the data source, the data schema, and other\n information. A dataset also contains any tags associated with the ingested data.

" } }, "com.amazonaws.lookoutequipment#CreateDatasetRequest": { @@ -1038,6 +1026,9 @@ "smithy.api#documentation": "

Any tags associated with the ingested data described in the dataset.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#CreateDatasetResponse": { @@ -1061,6 +1052,9 @@ "smithy.api#documentation": "

Indicates the status of the CreateDataset operation.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#CreateInferenceScheduler": { @@ -1169,6 +1163,9 @@ "smithy.api#documentation": "

Any tags associated with the inference scheduler.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#CreateInferenceSchedulerResponse": { @@ -1192,6 +1189,9 @@ "smithy.api#documentation": "

Indicates the status of the CreateInferenceScheduler operation.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#CreateLabel": { @@ -1226,7 +1226,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nCreates a label for an event.\n

" + "smithy.api#documentation": "

\n Creates a label for an event.\n

" } }, "com.amazonaws.lookoutequipment#CreateLabelGroup": { @@ -1258,7 +1258,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nCreates a group of labels.\n

" + "smithy.api#documentation": "

\n Creates a group of labels.\n

" } }, "com.amazonaws.lookoutequipment#CreateLabelGroupRequest": { @@ -1267,20 +1267,20 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\nNames a group of labels.

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.\n

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

\n Names a group of labels.

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.\n

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

\nThe acceptable fault codes (indicating the type of anomaly associated with the label) that can be used with this label group.

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" + "smithy.api#documentation": "

\n The acceptable fault codes (indicating the type of anomaly associated with the label) that can be used with this label group.

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" } }, "ClientToken": { "target": "com.amazonaws.lookoutequipment#IdempotenceToken", "traits": { - "smithy.api#documentation": "

\nA unique identifier for the request to create a label group. If you do not set the client request token, Lookout for Equipment generates one.\n

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

\n A unique identifier for the request to create a label group. If you do not set the client request token, Lookout for Equipment generates one.\n

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -1288,9 +1288,12 @@ "Tags": { "target": "com.amazonaws.lookoutequipment#TagList", "traits": { - "smithy.api#documentation": "

\nTags that provide metadata about the label group you are creating.\n

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" + "smithy.api#documentation": "

\n Tags that provide metadata about the label group you are creating.\n

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#CreateLabelGroupResponse": { @@ -1299,15 +1302,18 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\nThe name of the label group that you have created. Data in this field will be retained for service usage. Follow best practices for the security of your data.\n

" + "smithy.api#documentation": "

\n The name of the label group that you have created. Data in this field will be retained for service usage. Follow best practices for the security of your data.\n

" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "

\nThe ARN of the label group that you have created.\n

" + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the label group that you have created.\n

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#CreateLabelRequest": { @@ -1316,57 +1322,60 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\nThe name of a group of labels.

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.\n

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

\n The name of a group of labels.

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.\n

", "smithy.api#required": {} } }, "StartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\nThe start time of the labeled event.\n

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

\n The start time of the labeled event.\n

", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\nThe end time of the labeled event.\n

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

\n The end time of the labeled event.\n

", "smithy.api#required": {} } }, "Rating": { "target": "com.amazonaws.lookoutequipment#LabelRating", "traits": { - "smithy.api#documentation": "

\nIndicates whether a labeled event represents an anomaly.\n

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

\n Indicates whether a labeled event represents an anomaly.\n

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

\nProvides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.\n

" + "smithy.api#documentation": "

\n Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.\n

" } }, "Notes": { "target": "com.amazonaws.lookoutequipment#Comments", "traits": { - "smithy.api#documentation": "

\nMetadata providing additional information about the label.\n

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" + "smithy.api#documentation": "

\n Metadata providing additional information about the label.\n

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" } }, "Equipment": { "target": "com.amazonaws.lookoutequipment#Equipment", "traits": { - "smithy.api#documentation": "

\nIndicates that a label pertains to a particular piece of equipment.\n

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" + "smithy.api#documentation": "

\n Indicates that a label pertains to a particular piece of equipment.\n

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" } }, "ClientToken": { "target": "com.amazonaws.lookoutequipment#IdempotenceToken", "traits": { - "smithy.api#documentation": "

\nA unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.\n

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

\n A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.\n

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#CreateLabelResponse": { @@ -1375,9 +1384,12 @@ "LabelId": { "target": "com.amazonaws.lookoutequipment#LabelId", "traits": { - "smithy.api#documentation": "

\nThe ID of the label that you have created.\n

" + "smithy.api#documentation": "

\n The ID of the label that you have created.\n

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#CreateModel": { @@ -1506,6 +1518,9 @@ "smithy.api#documentation": "

Indicates that the asset associated with this sensor has been shut off. As long as this\n condition is met, Lookout for Equipment will not use data from this asset for training,\n evaluation, or inference.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#CreateModelResponse": { @@ -1523,6 +1538,9 @@ "smithy.api#documentation": "

Indicates the status of the CreateModel operation.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#DataDelayOffsetInMinutes": { @@ -1742,6 +1760,12 @@ "traits": { "smithy.api#enumValue": "ACTIVE" } + }, + "IMPORT_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_IN_PROGRESS" + } } } }, @@ -1825,6 +1849,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#DeleteInferenceScheduler": { @@ -1869,6 +1896,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#DeleteLabel": { @@ -1900,7 +1930,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nDeletes a label.\n

" + "smithy.api#documentation": "

\n Deletes a label.\n

" } }, "com.amazonaws.lookoutequipment#DeleteLabelGroup": { @@ -1932,7 +1962,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nDeletes a group of labels.\n

" + "smithy.api#documentation": "

\n Deletes a group of labels.\n

" } }, "com.amazonaws.lookoutequipment#DeleteLabelGroupRequest": { @@ -1941,10 +1971,13 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\nThe name of the label group that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.\n

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

\n The name of the label group that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.\n

", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#DeleteLabelRequest": { @@ -1953,17 +1986,20 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\nThe name of the label group that contains the label that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.\n

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

\n The name of the label group that contains the label that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.\n

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

\nThe ID of the label that you want to delete.\n

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

\n The ID of the label that you want to delete.\n

", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#DeleteModel": { @@ -2008,20 +2044,26 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.lookoutequipment#DescribeDataIngestionJob": { + "com.amazonaws.lookoutequipment#DeleteResourcePolicy": { "type": "operation", "input": { - "target": "com.amazonaws.lookoutequipment#DescribeDataIngestionJobRequest" + "target": "com.amazonaws.lookoutequipment#DeleteResourcePolicyRequest" }, "output": { - "target": "com.amazonaws.lookoutequipment#DescribeDataIngestionJobResponse" + "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.lookoutequipment#AccessDeniedException" }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, { "target": "com.amazonaws.lookoutequipment#InternalServerException" }, @@ -2036,27 +2078,74 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information on a specific data ingestion job such as creation time, dataset\n ARN, and status.

" + "smithy.api#documentation": "

Deletes the resource policy attached to the resource.

" } }, - "com.amazonaws.lookoutequipment#DescribeDataIngestionJobRequest": { + "com.amazonaws.lookoutequipment#DeleteResourcePolicyRequest": { "type": "structure", "members": { - "JobId": { - "target": "com.amazonaws.lookoutequipment#IngestionJobId", + "ResourceArn": { + "target": "com.amazonaws.lookoutequipment#ResourceArn", "traits": { - "smithy.api#documentation": "

The job ID of the data ingestion job.

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

The Amazon Resource Name (ARN) of the resource for which the resource policy should be deleted.

", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.lookoutequipment#DescribeDataIngestionJobResponse": { - "type": "structure", - "members": { - "JobId": { - "target": "com.amazonaws.lookoutequipment#IngestionJobId", - "traits": { + "com.amazonaws.lookoutequipment#DescribeDataIngestionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DescribeDataIngestionJobRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#DescribeDataIngestionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides information on a specific data ingestion job such as creation time, dataset\n ARN, and status.

" + } + }, + "com.amazonaws.lookoutequipment#DescribeDataIngestionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.lookoutequipment#IngestionJobId", + "traits": { + "smithy.api#documentation": "

The job ID of the data ingestion job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeDataIngestionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.lookoutequipment#IngestionJobId", + "traits": { "smithy.api#documentation": "

Indicates the job ID of the data ingestion job.

" } }, @@ -2128,7 +2217,16 @@ "traits": { "smithy.api#documentation": "

Indicates the latest timestamp corresponding to data that was successfully ingested\n during this specific ingestion job.

" } + }, + "SourceDatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source dataset from which the data \n used for the data ingestion job was imported from.

" + } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#DescribeDataset": { @@ -2170,6 +2268,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#DescribeDatasetResponse": { @@ -2252,7 +2353,16 @@ "traits": { "smithy.api#documentation": "

Indicates the latest timestamp corresponding to data that was successfully ingested\n during the most recent ingestion of this particular dataset.

" } + }, + "SourceDatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source dataset from which the \n current data being described was imported from.

" + } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#DescribeInferenceScheduler": { @@ -2294,6 +2404,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#DescribeInferenceSchedulerResponse": { @@ -2383,6 +2496,9 @@ "smithy.api#documentation": "

Indicates whether the latest execution for the inference scheduler was Anomalous\n (anomalous events found) or Normal (no anomalous events found).

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#DescribeLabel": { @@ -2411,7 +2527,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nReturns the name of the label.\n

" + "smithy.api#documentation": "

\n Returns the name of the label.\n

" } }, "com.amazonaws.lookoutequipment#DescribeLabelGroup": { @@ -2440,7 +2556,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nReturns information about the label group.\n

" + "smithy.api#documentation": "

\n Returns information about the label group.\n

" } }, "com.amazonaws.lookoutequipment#DescribeLabelGroupRequest": { @@ -2449,10 +2565,13 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\nReturns the name of the label group.\n

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

\n Returns the name of the label group.\n

", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#DescribeLabelGroupResponse": { @@ -2461,33 +2580,36 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\nThe name of the label group.\n

" + "smithy.api#documentation": "

\n The name of the label group.\n

" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "

\nThe ARN of the label group.\n

" + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the label group.\n

" } }, "FaultCodes": { "target": "com.amazonaws.lookoutequipment#FaultCodes", "traits": { - "smithy.api#documentation": "

\nCodes indicating the type of anomaly associated with the labels in the lagbel group.\n

" + "smithy.api#documentation": "

\n Codes indicating the type of anomaly associated with the labels in the lagbel group.\n

" } }, "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\nThe time at which the label group was created.\n

" + "smithy.api#documentation": "

\n The time at which the label group was created.\n

" } }, "UpdatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\nThe time at which the label group was updated.\n

" + "smithy.api#documentation": "

\n The time at which the label group was updated.\n

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#DescribeLabelRequest": { @@ -2496,17 +2618,20 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\nReturns the name of the group containing the label.\n

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

\n Returns the name of the group containing the label.\n

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

\nReturns the ID of the label.\n

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

\n Returns the ID of the label.\n

", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#DescribeLabelResponse": { @@ -2515,43 +2640,43 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\nThe name of the requested label group.\n

" + "smithy.api#documentation": "

\n The name of the requested label group.\n

" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "

\nThe ARN of the requested label group.\n

" + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the requested label group.\n

" } }, "LabelId": { "target": "com.amazonaws.lookoutequipment#LabelId", "traits": { - "smithy.api#documentation": "

\nThe ID of the requested label.\n

" + "smithy.api#documentation": "

\n The ID of the requested label.\n

" } }, "StartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\nThe start time of the requested label.\n

" + "smithy.api#documentation": "

\n The start time of the requested label.\n

" } }, "EndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\nThe end time of the requested label.\n

" + "smithy.api#documentation": "

\n The end time of the requested label.\n

" } }, "Rating": { "target": "com.amazonaws.lookoutequipment#LabelRating", "traits": { - "smithy.api#documentation": "

\nIndicates whether a labeled event represents an anomaly.\n

" + "smithy.api#documentation": "

\n Indicates whether a labeled event represents an anomaly.\n

" } }, "FaultCode": { "target": "com.amazonaws.lookoutequipment#FaultCode", "traits": { - "smithy.api#documentation": "

\nIndicates the type of anomaly associated with the label.\n

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" + "smithy.api#documentation": "

\n Indicates the type of anomaly associated with the label.\n

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" } }, "Notes": { @@ -2563,15 +2688,18 @@ "Equipment": { "target": "com.amazonaws.lookoutequipment#Equipment", "traits": { - "smithy.api#documentation": "

\nIndicates that a label pertains to a particular piece of equipment.\n

" + "smithy.api#documentation": "

\n Indicates that a label pertains to a particular piece of equipment.\n

" } }, "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\nThe time at which the label was created.\n

" + "smithy.api#documentation": "

\n The time at which the label was created.\n

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#DescribeModel": { @@ -2613,6 +2741,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#DescribeModelResponse": { @@ -2743,94 +2874,686 @@ "traits": { "smithy.api#documentation": "

Indicates that the asset associated with this sensor has been shut off. As long as this\n condition is met, Lookout for Equipment will not use data from this asset for training,\n evaluation, or inference.

" } - } - } - }, - "com.amazonaws.lookoutequipment#DuplicateTimestamps": { - "type": "structure", - "members": { - "TotalNumberOfDuplicateTimestamps": { - "target": "com.amazonaws.lookoutequipment#Integer", + }, + "SourceModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", "traits": { - "smithy.api#documentation": "

Indicates the total number of duplicate timestamps.

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

The Amazon Resource Name (ARN) of the source model version. This field appears if the active model version \n was imported.

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

The date and time when the import job was started. \n This field appears if the active model version was imported.

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

The date and time when the import job was completed. \n This field appears if the active model version was imported.

" + } + }, + "ActiveModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "

The name of the model version used by the inference schedular when running a\n scheduled inference execution.

" + } + }, + "ActiveModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model version used by the\n inference scheduler when running a scheduled inference execution.

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

The date the active model version was activated.

" + } + }, + "PreviousActiveModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "

The model version that was set as the active model version prior to the \n current active model version.

" + } + }, + "PreviousActiveModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the model version that was set as the active model version prior to the \n current active model version.

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

The date and time when the previous active model version was activated.

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

Entity that comprises information abount duplicate timestamps in the dataset.

" + "smithy.api#output": {} } }, - "com.amazonaws.lookoutequipment#Equipment": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 + "com.amazonaws.lookoutequipment#DescribeModelVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DescribeModelVersionRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#DescribeModelVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" }, - "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,200}$" - } - }, - "com.amazonaws.lookoutequipment#EventDurationInSeconds": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.lookoutequipment#FaultCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" }, - "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,100}$" - } - }, - "com.amazonaws.lookoutequipment#FaultCodes": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutequipment#FaultCode" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" } - } - }, - "com.amazonaws.lookoutequipment#FileNameTimestampFormat": { - "type": "string", + ], "traits": { - "smithy.api#pattern": "^EPOCH|yyyy-MM-dd-HH-mm-ss|yyyyMMddHHmmss$" + "smithy.api#documentation": "

Retrieves information about a specific machine learning model version.

" } }, - "com.amazonaws.lookoutequipment#Float": { - "type": "float", + "com.amazonaws.lookoutequipment#DescribeModelVersionRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the machine learning model that this version belongs to.

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

The version of the machine learning model.

", + "smithy.api#required": {} + } + } + }, "traits": { - "smithy.api#default": 0 + "smithy.api#input": {} } }, - "com.amazonaws.lookoutequipment#IamRoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 + "com.amazonaws.lookoutequipment#DescribeModelVersionResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the machine learning model that this version belongs to.

" + } }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$" - } - }, - "com.amazonaws.lookoutequipment#IdempotenceToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the parent machine learning model that this version belong to.

" + } }, - "smithy.api#pattern": "^\\p{ASCII}{1,256}$" + "ModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "

The version of the machine learning model.

" + } + }, + "ModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model version.

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

The current status of the model version.

" + } + }, + "SourceType": { + "target": "com.amazonaws.lookoutequipment#ModelVersionSourceType", + "traits": { + "smithy.api#documentation": "

Indicates whether this model version was created by training or by importing.

" + } + }, + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "

The name of the dataset used to train the model version.

" + } + }, + "DatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset used to train the model version.

" + } + }, + "Schema": { + "target": "com.amazonaws.lookoutequipment#InlineDataSchema", + "traits": { + "smithy.api#documentation": "

The schema of the data used to train the model version.

" + } + }, + "LabelsInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#LabelsInputConfiguration" + }, + "TrainingDataStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "

The date on which the training data began being gathered. If you imported\n the version, this is the date that the training data in the source \n version began being gathered.

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

The date on which the training data finished being gathered. \n If you imported the version, this is the date that the training data in the\n source version finished being gathered.

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

The date on which the data in the evaluation set began being gathered. \n If you imported the version, this is the date that the evaluation set data in \n the source version began being gathered.

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

The date on which the data in the evaluation set began being gathered. \n If you imported the version, this is the date that the evaluation set data in the\n source version finished being gathered.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.lookoutequipment#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that was used to train the model version.

" + } + }, + "DataPreProcessingConfiguration": { + "target": "com.amazonaws.lookoutequipment#DataPreProcessingConfiguration" + }, + "TrainingExecutionStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the training of the version began.

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

The time when the training of the version completed.

" + } + }, + "FailedReason": { + "target": "com.amazonaws.lookoutequipment#BoundedLengthString", + "traits": { + "smithy.api#documentation": "

The failure message if the training of the model version failed.

" + } + }, + "ModelMetrics": { + "target": "com.amazonaws.lookoutequipment#ModelMetrics", + "traits": { + "smithy.api#documentation": "

Shows an aggregated summary, in JSON format, of the model's \n performance within the evaluation time range. These metrics \n are created when evaluating the model.

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

Indicates the last time the machine learning model version was updated.

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

Indicates the time and date at which the machine learning model version was created.

" + } + }, + "ServerSideKmsKeyId": { + "target": "com.amazonaws.lookoutequipment#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The identifier of the KMS key key used to encrypt model version data by \n Amazon Lookout for Equipment.

" + } + }, + "OffCondition": { + "target": "com.amazonaws.lookoutequipment#OffCondition", + "traits": { + "smithy.api#documentation": "

Indicates that the asset associated with this sensor has been \n shut off. As long as this condition is met, Lookout for Equipment \n will not use data from this asset for training, evaluation, or inference.

" + } + }, + "SourceModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "

If model version was imported, then this field is the arn\n of the source model version.

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

The date and time when the import job began. \n This field appears if the model version was imported.

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

The date and time when the import job completed. \n This field appears if the model version was imported.

" + } + }, + "ImportedDataSizeInBytes": { + "target": "com.amazonaws.lookoutequipment#DataSizeInBytes", + "traits": { + "smithy.api#documentation": "

The size in bytes of the imported data. \n This field appears if the model version was imported.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DescribeResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#DescribeResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides the details of a resource policy attached to a resource.

" + } + }, + "com.amazonaws.lookoutequipment#DescribeResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.lookoutequipment#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that is associated with the resource policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeResourcePolicyResponse": { + "type": "structure", + "members": { + "PolicyRevisionId": { + "target": "com.amazonaws.lookoutequipment#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

A unique identifier for a revision of the resource policy.

" + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.lookoutequipment#Policy", + "traits": { + "smithy.api#documentation": "

The resource policy in a JSON-formatted string.

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

The time when the resource policy was created.

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

The time when the resource policy was last modified.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#DuplicateTimestamps": { + "type": "structure", + "members": { + "TotalNumberOfDuplicateTimestamps": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "

Indicates the total number of duplicate timestamps.

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

Entity that comprises information abount duplicate timestamps in the dataset.

" + } + }, + "com.amazonaws.lookoutequipment#Equipment": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,200}$" + } + }, + "com.amazonaws.lookoutequipment#EventDurationInSeconds": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.lookoutequipment#FaultCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,100}$" + } + }, + "com.amazonaws.lookoutequipment#FaultCodes": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#FaultCode" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.lookoutequipment#FileNameTimestampFormat": { + "type": "string", + "traits": { + "smithy.api#pattern": "^EPOCH|yyyy-MM-dd-HH-mm-ss|yyyyMMddHHmmss$" + } + }, + "com.amazonaws.lookoutequipment#Float": { + "type": "float", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.lookoutequipment#IamRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$" + } + }, + "com.amazonaws.lookoutequipment#IdempotenceToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^\\p{ASCII}{1,256}$" + } + }, + "com.amazonaws.lookoutequipment#ImportDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ImportDatasetRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ImportDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Imports a dataset.

" + } + }, + "com.amazonaws.lookoutequipment#ImportDatasetRequest": { + "type": "structure", + "members": { + "SourceDatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset to import.

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

The name of the machine learning dataset to be created. If the dataset already exists, Amazon Lookout for Equipment overwrites the existing dataset. If you don't specify this field, it is filled with the name of the source dataset.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.lookoutequipment#IdempotenceToken", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. \n If you do not set the client request token, \n Amazon Lookout for Equipment generates one.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "ServerSideKmsKeyId": { + "target": "com.amazonaws.lookoutequipment#NameOrArn", + "traits": { + "smithy.api#documentation": "

Provides the identifier of the KMS key key used to \n encrypt model data by Amazon Lookout for Equipment.

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

Any tags associated with the dataset to be created.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ImportDatasetResponse": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "

The name of the created machine learning dataset.

" + } + }, + "DatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset that was imported.

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

The status of the ImportDataset operation.

" + } + }, + "JobId": { + "target": "com.amazonaws.lookoutequipment#IngestionJobId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the job of importing the dataset.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#ImportModelVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ImportModelVersionRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ImportModelVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Imports a model that has been trained successfully.

" + } + }, + "com.amazonaws.lookoutequipment#ImportModelVersionRequest": { + "type": "structure", + "members": { + "SourceModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model version to import.

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

The name for the machine learning model to be created.\n If the model already exists, Amazon Lookout for Equipment creates a new version. \n If you do not specify this field, it is filled with the name of the source model.

" + } + }, + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetIdentifier", + "traits": { + "smithy.api#documentation": "

The name of the dataset for the machine learning model being imported.

", + "smithy.api#required": {} + } + }, + "LabelsInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#LabelsInputConfiguration" + }, + "ClientToken": { + "target": "com.amazonaws.lookoutequipment#IdempotenceToken", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. If you do not set the client request\n token, Amazon Lookout for Equipment generates one.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.lookoutequipment#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role with permission to \n access the data source being used to create the machine learning model.

" + } + }, + "ServerSideKmsKeyId": { + "target": "com.amazonaws.lookoutequipment#NameOrArn", + "traits": { + "smithy.api#documentation": "

Provides the identifier of the KMS key key used to encrypt \n model data by Amazon Lookout for Equipment.

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

The tags associated with the machine learning model to be created.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ImportModelVersionResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

The name for the machine learning model.

" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model being created.

" + } + }, + "ModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model version being created.

" + } + }, + "ModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "

The version of the model being created.

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

The status of the ImportModelVersion operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#InferenceEventSummaries": { @@ -3051,7 +3774,7 @@ "KmsKeyId": { "target": "com.amazonaws.lookoutequipment#NameOrArn", "traits": { - "smithy.api#documentation": "

The ID number for the AWS KMS key used to encrypt the inference output.

" + "smithy.api#documentation": "

The ID number for the KMS key key used to encrypt the inference output.

" } } }, @@ -3295,6 +4018,12 @@ "traits": { "smithy.api#enumValue": "FAILED" } + }, + "IMPORT_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_IN_PROGRESS" + } } } }, @@ -3317,7 +4046,7 @@ "KeyPattern": { "target": "com.amazonaws.lookoutequipment#KeyPattern", "traits": { - "smithy.api#documentation": "

Pattern for matching the Amazon S3 files which will be used for ingestion. If\n no KeyPattern is provided, we will use the default hierarchy file structure, which is same\n as KeyPattern {prefix}/{component_name}/*

" + "smithy.api#documentation": "

\n\t\t\t The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/* is used to download files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first time.

\n

Valid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* | {prefix}/{component_name}[DELIMITER]* (Allowed delimiters : space, dot, underscore, hyphen)

" } } }, @@ -3325,6 +4054,15 @@ "smithy.api#documentation": "

Specifies S3 configuration information for the input data for the data ingestion job.\n

" } }, + "com.amazonaws.lookoutequipment#InlineDataSchema": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000000 + } + } + }, "com.amazonaws.lookoutequipment#InsufficientSensorData": { "type": "structure", "members": { @@ -3439,30 +4177,30 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\nThe name of the label group.\n

" + "smithy.api#documentation": "

\n The name of the label group.\n

" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "

\nThe ARN of the label group.\n

" + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the label group.\n

" } }, "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\nThe time at which the label group was created.\n

" + "smithy.api#documentation": "

\n The time at which the label group was created.\n

" } }, "UpdatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\nThe time at which the label group was updated.\n

" + "smithy.api#documentation": "

\n The time at which the label group was updated.\n

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

\nContains information about the label group.\n

" + "smithy.api#documentation": "

\n Contains information about the label group.\n

" } }, "com.amazonaws.lookoutequipment#LabelId": { @@ -3510,60 +4248,60 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\nThe name of the label group.\n

" + "smithy.api#documentation": "

\n The name of the label group.\n

" } }, "LabelId": { "target": "com.amazonaws.lookoutequipment#LabelId", "traits": { - "smithy.api#documentation": "

\nThe ID of the label.\n

" + "smithy.api#documentation": "

\n The ID of the label.\n

" } }, "LabelGroupArn": { "target": "com.amazonaws.lookoutequipment#LabelGroupArn", "traits": { - "smithy.api#documentation": "

\nThe ARN of the label group.\n

" + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the label group.\n

" } }, "StartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\nThe timestamp indicating the start of the label.\n

" + "smithy.api#documentation": "

\n The timestamp indicating the start of the label.\n

" } }, "EndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\nThe timestamp indicating the end of the label.\n

" + "smithy.api#documentation": "

\n The timestamp indicating the end of the label.\n

" } }, "Rating": { "target": "com.amazonaws.lookoutequipment#LabelRating", "traits": { - "smithy.api#documentation": "

\nIndicates whether a labeled event represents an anomaly.\n

" + "smithy.api#documentation": "

\n Indicates whether a labeled event represents an anomaly.\n

" } }, "FaultCode": { "target": "com.amazonaws.lookoutequipment#FaultCode", "traits": { - "smithy.api#documentation": "

\nIndicates the type of anomaly associated with the label.\n

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" + "smithy.api#documentation": "

\n Indicates the type of anomaly associated with the label.\n

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" } }, "Equipment": { "target": "com.amazonaws.lookoutequipment#Equipment", "traits": { - "smithy.api#documentation": "

\nIndicates that a label pertains to a particular piece of equipment.\n

" + "smithy.api#documentation": "

\n Indicates that a label pertains to a particular piece of equipment.\n

" } }, "CreatedAt": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\nThe time at which the label was created.\n

" + "smithy.api#documentation": "

\n The time at which the label was created.\n

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

\nInformation about the label.\n

" + "smithy.api#documentation": "

\n Information about the label.\n

" } }, "com.amazonaws.lookoutequipment#LabelsInputConfiguration": { @@ -3578,7 +4316,7 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\nThe name of the label group to be used for label data.\n

" + "smithy.api#documentation": "

\n The name of the label group to be used for label data.\n

" } } }, @@ -3709,6 +4447,9 @@ "smithy.api#documentation": "

Indicates the status of the data ingestion job.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListDataIngestionJobsResponse": { @@ -3726,6 +4467,9 @@ "smithy.api#documentation": "

Specifies information about the specific data ingestion job, including dataset name and\n status.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#ListDatasets": { @@ -3780,6 +4524,9 @@ "smithy.api#documentation": "

The beginning of the name of the datasets to be listed.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListDatasetsResponse": { @@ -3797,6 +4544,9 @@ "smithy.api#documentation": "

Provides information about the specified dataset, including creation time, dataset ARN,\n and status.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#ListInferenceEvents": { @@ -3865,10 +4615,13 @@ "IntervalEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

Returns all the inference events with an end start time equal to or greater than less than the end time given

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

Returns all the inference events with an end start time equal to or greater than less than the end time given.

", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListInferenceEventsResponse": { @@ -3886,6 +4639,9 @@ "smithy.api#documentation": "

Provides an array of information about the individual inference events returned from the\n ListInferenceEvents operation, including scheduler used, event start time,\n event end time, diagnostics, and so on.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#ListInferenceExecutions": { @@ -3962,6 +4718,9 @@ "smithy.api#documentation": "

The status of the inference execution.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListInferenceExecutionsResponse": { @@ -3979,6 +4738,9 @@ "smithy.api#documentation": "

Provides an array of information about the individual inference executions returned from\n the ListInferenceExecutions operation, including model used, inference\n scheduler, data configuration, and so on.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#ListInferenceSchedulers": { @@ -4042,9 +4804,12 @@ "Status": { "target": "com.amazonaws.lookoutequipment#InferenceSchedulerStatus", "traits": { - "smithy.api#documentation": "

Specifies the current status of the inference schedulers to list.

" + "smithy.api#documentation": "

Specifies the current status of the inference schedulers.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListInferenceSchedulersResponse": { @@ -4062,6 +4827,9 @@ "smithy.api#documentation": "

Provides information about the specified inference scheduler, including data upload\n frequency, model name and ARN, and status.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#ListLabelGroups": { @@ -4087,7 +4855,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nReturns a list of the label groups.\n

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

\n Returns a list of the label groups.\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4101,21 +4869,24 @@ "LabelGroupNameBeginsWith": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\nThe beginning of the name of the label groups to be listed.\n

" + "smithy.api#documentation": "

\n The beginning of the name of the label groups to be listed.\n

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

\nAn opaque pagination token indicating where to continue the listing of label groups.\n

" + "smithy.api#documentation": "

\n An opaque pagination token indicating where to continue the listing of label groups.\n

" } }, "MaxResults": { "target": "com.amazonaws.lookoutequipment#MaxResults", "traits": { - "smithy.api#documentation": "

\nSpecifies the maximum number of label groups to list.\n

" + "smithy.api#documentation": "

\n Specifies the maximum number of label groups to list.\n

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListLabelGroupsResponse": { @@ -4124,15 +4895,18 @@ "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "

\nAn opaque pagination token indicating where to continue the listing of label groups.\n

" + "smithy.api#documentation": "

\n An opaque pagination token indicating where to continue the listing of label groups.\n

" } }, "LabelGroupSummaries": { "target": "com.amazonaws.lookoutequipment#LabelGroupSummaries", "traits": { - "smithy.api#documentation": "

\nA summary of the label groups.\n

" + "smithy.api#documentation": "

\n A summary of the label groups.\n

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#ListLabels": { @@ -4158,7 +4932,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nProvides a list of labels.\n

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

\n Provides a list of labels.\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4172,46 +4946,49 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\nRetruns the name of the label group.\n

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

\n Retruns the name of the label group.\n

", "smithy.api#required": {} } }, "IntervalStartTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\nReturns all the labels with a end time equal to or later than the start time given.\n

" + "smithy.api#documentation": "

\n Returns all the labels with a end time equal to or later than the start time given.\n

" } }, "IntervalEndTime": { "target": "com.amazonaws.lookoutequipment#Timestamp", "traits": { - "smithy.api#documentation": "

\nReturns all labels with a start time earlier than the end time given.\n

" + "smithy.api#documentation": "

\n Returns all labels with a start time earlier than the end time given.\n

" } }, "FaultCode": { "target": "com.amazonaws.lookoutequipment#FaultCode", "traits": { - "smithy.api#documentation": "

\nReturns labels with a particular fault code.\n

" + "smithy.api#documentation": "

\n Returns labels with a particular fault code.\n

" } }, "Equipment": { "target": "com.amazonaws.lookoutequipment#Equipment", "traits": { - "smithy.api#documentation": "

\nLists the labels that pertain to a particular piece of equipment.\n

" + "smithy.api#documentation": "

\n Lists the labels that pertain to a particular piece of equipment.\n

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

\nAn opaque pagination token indicating where to continue the listing of label groups.\n

" + "smithy.api#documentation": "

\n An opaque pagination token indicating where to continue the listing of label groups.\n

" } }, "MaxResults": { "target": "com.amazonaws.lookoutequipment#MaxResults", "traits": { - "smithy.api#documentation": "

\nSpecifies the maximum number of labels to list.\n

" + "smithy.api#documentation": "

\n Specifies the maximum number of labels to list.\n

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListLabelsResponse": { @@ -4220,15 +4997,135 @@ "NextToken": { "target": "com.amazonaws.lookoutequipment#NextToken", "traits": { - "smithy.api#documentation": "

\nAn opaque pagination token indicating where to continue the listing of datasets.\n

" + "smithy.api#documentation": "

\n An opaque pagination token indicating where to continue the listing of datasets.\n

" } }, "LabelSummaries": { "target": "com.amazonaws.lookoutequipment#LabelSummaries", "traits": { - "smithy.api#documentation": "

\nA summary of the items in the label group.\n

" + "smithy.api#documentation": "

\n A summary of the items in the label group.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#ListModelVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ListModelVersionsRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ListModelVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates a list of all model versions for a given model, \n including the model version, model version ARN, and status. To list a \n subset of versions, use the MaxModelVersion and MinModelVersion fields.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lookoutequipment#ListModelVersionsRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

Then name of the machine learning model for which the \n model versions are to be listed.

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

If the total number of results exceeds the limit that the response can \n display, the response returns an opaque pagination token indicating where to \n continue the listing of machine learning model versions. Use this token in the NextToken \n field in the request to list the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.lookoutequipment#MaxResults", + "traits": { + "smithy.api#documentation": "

Specifies the maximum number of machine learning model versions to list.

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

Filter the results based on the current status of the model version.

" + } + }, + "SourceType": { + "target": "com.amazonaws.lookoutequipment#ModelVersionSourceType", + "traits": { + "smithy.api#documentation": "

Filter the results based on the way the model version was generated.

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

Filter results to return all the model versions created before this time.

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

Filter results to return all the model versions created after this time.

" + } + }, + "MaxModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "

Specifies the highest version of the model to return in the list.

" + } + }, + "MinModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "

Specifies the lowest version of the model to return in the list.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ListModelVersionsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results exceeds the limit that the response can \n display, the response returns an opaque pagination token indicating where to \n continue the listing of machine learning model versions. Use this token in the NextToken \n field in the request to list the next page of results.

" + } + }, + "ModelVersionSummaries": { + "target": "com.amazonaws.lookoutequipment#ModelVersionSummaries", + "traits": { + "smithy.api#documentation": "

Provides information on the specified model version, \n including the created time, model and dataset ARNs, and status.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#ListModels": { @@ -4295,6 +5192,9 @@ "smithy.api#documentation": "

The beginning of the name of the dataset of the ML models to be listed.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListModelsResponse": { @@ -4312,6 +5212,9 @@ "smithy.api#documentation": "

Provides information on the specified model, including created time, model and dataset\n ARNs, and status.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#ListOfDiscardedFiles": { @@ -4387,6 +5290,9 @@ "smithy.api#documentation": "

An opaque pagination token indicating where to continue the listing of sensor\n statistics.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListSensorStatisticsResponse": { @@ -4404,6 +5310,9 @@ "smithy.api#documentation": "

An opaque pagination token indicating where to continue the listing of sensor\n statistics.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#ListTagsForResource": { @@ -4445,6 +5354,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ListTagsForResourceResponse": { @@ -4456,6 +5368,9 @@ "smithy.api#documentation": "

Any tags associated with the resource.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#MaxResults": { @@ -4501,39 +5416,171 @@ } }, "traits": { - "smithy.api#documentation": "

Entity that comprises aggregated information on sensors having missing data.

" + "smithy.api#documentation": "

Entity that comprises aggregated information on sensors having missing data.

" + } + }, + "com.amazonaws.lookoutequipment#ModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:model\\/.+$" + } + }, + "com.amazonaws.lookoutequipment#ModelMetrics": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50000 + } + } + }, + "com.amazonaws.lookoutequipment#ModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,200}$" + } + }, + "com.amazonaws.lookoutequipment#ModelStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "IMPORT_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_IN_PROGRESS" + } + } + } + }, + "com.amazonaws.lookoutequipment#ModelSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#ModelSummary" + } + }, + "com.amazonaws.lookoutequipment#ModelSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the ML model.

" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ML model.

" + } + }, + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "

The name of the dataset being used for the ML model.

" + } + }, + "DatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset used to create the model.

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

Indicates the status of the ML model.

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

The time at which the specific model was created.

" + } + }, + "ActiveModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "

The model version that the inference scheduler uses to run an inference\n execution.

" + } + }, + "ActiveModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model version that is set as active. The active model version \n is the model version that the inference scheduler uses to run an inference\n execution.

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

Provides information about the specified ML model, including dataset and model names and\n ARNs, as well as status.

" + } + }, + "com.amazonaws.lookoutequipment#ModelVersion": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } } }, - "com.amazonaws.lookoutequipment#ModelArn": { + "com.amazonaws.lookoutequipment#ModelVersionArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:model\\/.+$" - } - }, - "com.amazonaws.lookoutequipment#ModelMetrics": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50000 - } + "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:model\\/.+\\/.+\\/model-version\\/[0-9]{1,}$" } }, - "com.amazonaws.lookoutequipment#ModelName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 + "com.amazonaws.lookoutequipment#ModelVersionSourceType": { + "type": "enum", + "members": { + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINING" + } }, - "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,200}$" + "RETRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRAINING" + } + }, + "IMPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT" + } + } } }, - "com.amazonaws.lookoutequipment#ModelStatus": { + "com.amazonaws.lookoutequipment#ModelVersionStatus": { "type": "enum", "members": { "IN_PROGRESS": { @@ -4553,57 +5600,75 @@ "traits": { "smithy.api#enumValue": "FAILED" } + }, + "IMPORT_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_IN_PROGRESS" + } + }, + "CANCELED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELED" + } } } }, - "com.amazonaws.lookoutequipment#ModelSummaries": { + "com.amazonaws.lookoutequipment#ModelVersionSummaries": { "type": "list", "member": { - "target": "com.amazonaws.lookoutequipment#ModelSummary" + "target": "com.amazonaws.lookoutequipment#ModelVersionSummary" } }, - "com.amazonaws.lookoutequipment#ModelSummary": { + "com.amazonaws.lookoutequipment#ModelVersionSummary": { "type": "structure", "members": { "ModelName": { "target": "com.amazonaws.lookoutequipment#ModelName", "traits": { - "smithy.api#documentation": "

The name of the ML model.

" + "smithy.api#documentation": "

The name of the model that this model version is a version of.

" } }, "ModelArn": { "target": "com.amazonaws.lookoutequipment#ModelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ML model.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model that this model version is a version of.

" } }, - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetName", + "ModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", "traits": { - "smithy.api#documentation": "

The name of the dataset being used for the ML model.

" + "smithy.api#documentation": "

The version of the model.

" } }, - "DatasetArn": { - "target": "com.amazonaws.lookoutequipment#DatasetArn", + "ModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset used to create the model.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model version.

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

The time when this model version was created.

" } }, "Status": { - "target": "com.amazonaws.lookoutequipment#ModelStatus", + "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", "traits": { - "smithy.api#documentation": "

Indicates the status of the ML model.

" + "smithy.api#documentation": "

The current status of the model version.

" } }, - "CreatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", + "SourceType": { + "target": "com.amazonaws.lookoutequipment#ModelVersionSourceType", "traits": { - "smithy.api#documentation": "

The time at which the specific model was created.

" + "smithy.api#documentation": "

Indicates how this model version was generated.

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

Provides information about the specified ML model, including dataset and model names and\n ARNs, as well as status.

" + "smithy.api#documentation": "

Contains information about the specific model version.

" } }, "com.amazonaws.lookoutequipment#MonotonicValues": { @@ -4694,6 +5759,127 @@ } } }, + "com.amazonaws.lookoutequipment#Policy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20000 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.lookoutequipment#PolicyRevisionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#pattern": "^[0-9A-Fa-f]+$" + } + }, + "com.amazonaws.lookoutequipment#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a resource control policy for a given resource.

" + } + }, + "com.amazonaws.lookoutequipment#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.lookoutequipment#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which the \n policy is being created.

", + "smithy.api#required": {} + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.lookoutequipment#Policy", + "traits": { + "smithy.api#documentation": "

The JSON-formatted resource policy to create.

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

A unique identifier for a revision of the resource policy.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.lookoutequipment#IdempotenceToken", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. \n If you do not set the client request token, Amazon Lookout for Equipment \n generates one.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#PutResourcePolicyResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.lookoutequipment#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which the \n policy was created.

" + } + }, + "PolicyRevisionId": { + "target": "com.amazonaws.lookoutequipment#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

A unique identifier for a revision of the resource policy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:.+$" + } + }, "com.amazonaws.lookoutequipment#ResourceNotFoundException": { "type": "structure", "members": { @@ -4743,7 +5929,7 @@ "Key": { "target": "com.amazonaws.lookoutequipment#S3Key", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key being used to encrypt the S3 object.\n Without this key, data in the bucket is not accessible.

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

The Amazon Web Services Key Management Service (KMS key) key being used to encrypt the S3 object.\n Without this key, data in the bucket is not accessible.

", "smithy.api#required": {} } } @@ -4963,6 +6149,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#StartDataIngestionJobResponse": { @@ -4980,6 +6169,9 @@ "smithy.api#documentation": "

Indicates the status of the StartDataIngestionJob operation.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#StartInferenceScheduler": { @@ -5024,6 +6216,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#StartInferenceSchedulerResponse": { @@ -5059,6 +6254,9 @@ "smithy.api#documentation": "

Indicates the status of the inference scheduler.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#StatisticalIssueStatus": { @@ -5120,6 +6318,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#StopInferenceSchedulerResponse": { @@ -5155,6 +6356,9 @@ "smithy.api#documentation": "

Indicates the status of the inference scheduler.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lookoutequipment#SynthesizedJsonInlineDataSchema": { @@ -5282,11 +6486,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#TagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.lookoutequipment#TagValue": { "type": "string", @@ -5455,11 +6665,115 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#UntagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#UpdateActiveModelVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#UpdateActiveModelVersionRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#UpdateActiveModelVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the active model version for a given machine learning model.

" + } + }, + "com.amazonaws.lookoutequipment#UpdateActiveModelVersionRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the machine learning model for which the active model version \n is being set.

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

The version of the machine learning model for which the active model version \n is being set.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#UpdateActiveModelVersionResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "

The name of the machine learning model for which the active model version was set.

" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the machine learning model for which \n the active model version was set.

" + } + }, + "CurrentActiveVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "

The version that is currently active of the machine learning model \n for which the active model version was set.

" + } + }, + "PreviousActiveVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "

The previous version that was active of the machine learning model \n for which the active model version was set.

" + } + }, + "CurrentActiveVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the machine learning model version that is the\n current active model version.

" + } + }, + "PreviousActiveVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the machine learning model version that was the\n previous active model version.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.lookoutequipment#UpdateInferenceScheduler": { "type": "operation", @@ -5533,6 +6847,9 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role with permission to access the data source for\n the inference scheduler.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#UpdateLabelGroup": { @@ -5564,7 +6881,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nUpdates the label group.\n

" + "smithy.api#documentation": "

\n Updates the label group.\n

" } }, "com.amazonaws.lookoutequipment#UpdateLabelGroupRequest": { @@ -5573,16 +6890,19 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

\nThe name of the label group to be updated.\n

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

\n The name of the label group to be updated.\n

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

\nUpdates the code indicating the type of anomaly associated with the label.\n

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" + "smithy.api#documentation": "

\n Updates the code indicating the type of anomaly associated with the label.\n

\n

Data in this field will be retained for service usage. Follow best practices for the security of your data.

" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lookoutequipment#ValidationException": { @@ -5596,7 +6916,7 @@ } }, "traits": { - "smithy.api#documentation": "

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a\n related AWS service that's being utilized.

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

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a\n related Amazon Web Services service that's being utilized.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } diff --git a/codegen/sdk/aws-models/medialive.json b/codegen/sdk/aws-models/medialive.json index 0b0872f6aa11..7c94a0c3cc02 100644 --- a/codegen/sdk/aws-models/medialive.json +++ b/codegen/sdk/aws-models/medialive.json @@ -5637,6 +5637,13 @@ "smithy.api#documentation": "A collection of key-value pairs.", "smithy.api#jsonName": "tags" } + }, + "AvailabilityZone": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The Availability Zone associated with this input device.", + "smithy.api#jsonName": "availabilityZone" + } } }, "traits": { @@ -12788,6 +12795,13 @@ "smithy.api#documentation": "A collection of key-value pairs.", "smithy.api#jsonName": "tags" } + }, + "AvailabilityZone": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The Availability Zone associated with this input device.", + "smithy.api#jsonName": "availabilityZone" + } } }, "traits": { @@ -23289,6 +23303,13 @@ "smithy.api#documentation": "The settings that you want to apply to the UHD input device.", "smithy.api#jsonName": "uhdDeviceSettings" } + }, + "AvailabilityZone": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The Availability Zone you want associated with this input device.", + "smithy.api#jsonName": "availabilityZone" + } } }, "traits": { @@ -23389,6 +23410,13 @@ "smithy.api#documentation": "A collection of key-value pairs.", "smithy.api#jsonName": "tags" } + }, + "AvailabilityZone": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "The Availability Zone associated with this input device.", + "smithy.api#jsonName": "availabilityZone" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/omics.json b/codegen/sdk/aws-models/omics.json index 63cf9bdbd792..2c366933ddde 100644 --- a/codegen/sdk/aws-models/omics.json +++ b/codegen/sdk/aws-models/omics.json @@ -2064,6 +2064,21 @@ "smithy.api#timestampFormat": "date-time" } }, + "com.amazonaws.omics#CreationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IMPORT", + "name": "IMPORT" + }, + { + "value": "UPLOAD", + "name": "UPLOAD" + } + ] + } + }, "com.amazonaws.omics#DeleteAnnotationStore": { "type": "operation", "input": { @@ -4201,6 +4216,12 @@ "traits": { "smithy.api#documentation": "

\n The status message for a read set. It provides more detail as to why the read set has a status. \n

" } + }, + "creationType": { + "target": "com.amazonaws.omics#CreationType", + "traits": { + "smithy.api#documentation": "

\n The creation type of the read set.\n

" + } } }, "traits": { @@ -5601,6 +5622,12 @@ "min": 0 } } + }, + "instanceType": { + "target": "com.amazonaws.omics#TaskInstanceType", + "traits": { + "smithy.api#documentation": "

\n The instance type for a task. \n

" + } } }, "traits": { @@ -6881,7 +6908,7 @@ "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": "

Specifies the pagination token from a previous request to retrieve the next page of results.

", "smithy.api#httpQuery": "nextToken", "smithy.api#length": { "min": 1, @@ -6912,7 +6939,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A pagination token that's included if more results are available.

" + "smithy.api#documentation": "

Specifies the pagination token from a previous request to retrieve the next page of results.

" } } }, @@ -9440,55 +9467,55 @@ "smithy.rules#endpointTests": { "testCases": [ { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://omics-fips.us-gov-east-1.api.aws" + "url": "https://omics-fips.us-east-1.api.aws" } }, "params": { - "UseDualStack": true, - "Region": "us-gov-east-1", - "UseFIPS": true + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://omics-fips.us-gov-east-1.amazonaws.com" + "url": "https://omics-fips.us-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "Region": "us-gov-east-1", - "UseFIPS": true + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://omics.us-gov-east-1.api.aws" + "url": "https://omics.us-east-1.api.aws" } }, "params": { - "UseDualStack": true, - "Region": "us-gov-east-1", - "UseFIPS": false + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://omics.us-gov-east-1.amazonaws.com" + "url": "https://omics.us-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "Region": "us-gov-east-1", - "UseFIPS": false + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { @@ -9499,9 +9526,9 @@ } }, "params": { - "UseDualStack": true, "Region": "cn-north-1", - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -9512,9 +9539,9 @@ } }, "params": { - "UseDualStack": false, "Region": "cn-north-1", - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -9525,9 +9552,9 @@ } }, "params": { - "UseDualStack": true, "Region": "cn-north-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -9538,109 +9565,109 @@ } }, "params": { - "UseDualStack": false, "Region": "cn-north-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "url": "https://omics-fips.us-gov-east-1.api.aws" + } }, "params": { - "UseDualStack": true, - "Region": "us-iso-east-1", - "UseFIPS": true + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://omics-fips.us-iso-east-1.c2s.ic.gov" + "url": "https://omics-fips.us-gov-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "Region": "us-iso-east-1", - "UseFIPS": true + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://omics.us-gov-east-1.api.aws" + } }, "params": { - "UseDualStack": true, - "Region": "us-iso-east-1", - "UseFIPS": false + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://omics.us-iso-east-1.c2s.ic.gov" + "url": "https://omics.us-gov-east-1.amazonaws.com" } }, "params": { - "UseDualStack": false, - "Region": "us-iso-east-1", - "UseFIPS": false + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://omics-fips.us-east-1.api.aws" - } + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, - "Region": "us-east-1", - "UseFIPS": true + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://omics-fips.us-east-1.amazonaws.com" + "url": "https://omics-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": true + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://omics.us-east-1.api.aws" - } + "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, - "Region": "us-east-1", - "UseFIPS": false + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://omics.us-east-1.amazonaws.com" + "url": "https://omics.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": false + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { @@ -9649,9 +9676,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "Region": "us-isob-east-1", - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -9662,9 +9689,9 @@ } }, "params": { - "UseDualStack": false, "Region": "us-isob-east-1", - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -9673,9 +9700,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "Region": "us-isob-east-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -9686,22 +9713,35 @@ } }, "params": { - "UseDualStack": false, "Region": "us-isob-east-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { - "UseDualStack": false, "Region": "us-east-1", "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -9711,9 +9751,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "Region": "us-east-1", "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -9723,11 +9763,17 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "Region": "us-east-1", "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" @@ -10109,6 +10155,12 @@ "traits": { "smithy.api#documentation": "

\n Where the source originated.\n

" } + }, + "creationType": { + "target": "com.amazonaws.omics#CreationType", + "traits": { + "smithy.api#documentation": "

\n The creation type of the read set.\n

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

\n The status for a read set. It provides more detail as to why the read set has a status. \n

" } + }, + "creationType": { + "target": "com.amazonaws.omics#CreationType", + "traits": { + "smithy.api#documentation": "

\n The creation type of the read set.\n

" + } } }, "traits": { @@ -13254,6 +13312,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": { @@ -13325,6 +13389,12 @@ "min": 0 } } + }, + "instanceType": { + "target": "com.amazonaws.omics#TaskInstanceType", + "traits": { + "smithy.api#documentation": "

\n The instance type for a task. \n

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/pinpoint.json b/codegen/sdk/aws-models/pinpoint.json index 38a72a2a7385..1138cdceddfc 100644 --- a/codegen/sdk/aws-models/pinpoint.json +++ b/codegen/sdk/aws-models/pinpoint.json @@ -1377,6 +1377,32 @@ "smithy.api#documentation": "

Provides information about an application.

" } }, + "com.amazonaws.pinpoint#ApplicationSettingsJourneyLimits": { + "type": "structure", + "members": { + "DailyCap": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "

The daily number of messages that an endpoint can receive from all journeys. The maximum value is 100. If set to 0, this limit will not apply.

" + } + }, + "TimeframeCap": { + "target": "com.amazonaws.pinpoint#JourneyTimeframeCap", + "traits": { + "smithy.api#documentation": "

The default maximum number of messages that can be sent to an endpoint during the specified timeframe for all journeys.

" + } + }, + "TotalCap": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "

The default maximum number of messages that a single journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.

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

The default sending limits for journeys in the application. To override these limits and define custom limits for a specific journey, use the Journey resource.

" + } + }, "com.amazonaws.pinpoint#ApplicationSettingsResource": { "type": "structure", "members": { @@ -1410,6 +1436,12 @@ "traits": { "smithy.api#documentation": "

The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

  • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

  • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).

  • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

" } + }, + "JourneyLimits": { + "target": "com.amazonaws.pinpoint#ApplicationSettingsJourneyLimits", + "traits": { + "smithy.api#documentation": "

The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.

" + } } }, "traits": { @@ -7169,8 +7201,13 @@ "ApiKey": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

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

The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

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

The default authentication method used for GCM. Values are either \"TOKEN\" or \"KEY\". Defaults to \"KEY\".

" } }, "Enabled": { @@ -7178,6 +7215,12 @@ "traits": { "smithy.api#documentation": "

Specifies whether to enable the GCM channel for the application.

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

The contents of the JSON file provided by Google during registration in order to generate an access token for authentication. For more information see Migrate from legacy FCM APIs to HTTP v1.

" + } } }, "traits": { @@ -7202,8 +7245,13 @@ "Credential": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

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

The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

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

The default authentication method used for GCM. Values are either \"TOKEN\" or \"KEY\". Defaults to \"KEY\".

" } }, "Enabled": { @@ -7218,6 +7266,12 @@ "smithy.api#documentation": "

(Not used) This property is retained only for backward compatibility.

" } }, + "HasFcmServiceCredentials": { + "target": "com.amazonaws.pinpoint#__boolean", + "traits": { + "smithy.api#documentation": "

Returns true if the JSON file provided by Google during registration process was used in the ServiceJson field of the request.

" + } + }, "Id": { "target": "com.amazonaws.pinpoint#__string", "traits": { @@ -7305,10 +7359,16 @@ "smithy.api#documentation": "

The URL of an image to display in the push notification.

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

The preferred authentication method, with valid values \"KEY\" or \"TOKEN\". If a value isn't provided then the DefaultAuthenticationMethod is used.

" + } + }, "Priority": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.

/listitem>

  • high - The notification is sent immediately and might wake a sleeping device.

    • /para>

    Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.

    The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.

    " + "smithy.api#documentation": "

    para>normal – The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.

    /listitem>

  • high – The notification is sent immediately and might wake a sleeping device.

    • /para>

    Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.

    The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.

    " } }, "RawContent": { @@ -12510,6 +12570,18 @@ "traits": { "smithy.api#documentation": "

    Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.

    " } + }, + "TimeframeCap": { + "target": "com.amazonaws.pinpoint#JourneyTimeframeCap", + "traits": { + "smithy.api#documentation": "

    The number of messages that an endpoint can receive during the specified timeframe.

    " + } + }, + "TotalCap": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "

    The maximum number of messages a journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.

    " + } } }, "traits": { @@ -12938,6 +13010,26 @@ "smithy.api#documentation": "

    Changes the status of a journey.

    " } }, + "com.amazonaws.pinpoint#JourneyTimeframeCap": { + "type": "structure", + "members": { + "Cap": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "

    The maximum number of messages that all journeys can send to an endpoint during the specified timeframe. The maximum value is 100. If set to 0, this limit will not apply.

    " + } + }, + "Days": { + "target": "com.amazonaws.pinpoint#__integer", + "traits": { + "smithy.api#documentation": "

    The length of the timeframe in days. The maximum value is 30. If set to 0, this limit will not apply.

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

    The number of messages that can be sent to an endpoint during the specified timeframe for all journeys.

    " + } + }, "com.amazonaws.pinpoint#JourneysResponse": { "type": "structure", "members": { @@ -17973,6 +18065,12 @@ "traits": { "smithy.api#documentation": "

    The voice template to use for the message. This object isn't supported for campaigns.

    " } + }, + "InAppTemplate": { + "target": "com.amazonaws.pinpoint#Template", + "traits": { + "smithy.api#documentation": "

    The InApp template to use for the message. The InApp template object is not supported for SendMessages.

    " + } } }, "traits": { @@ -18057,7 +18155,7 @@ "TemplateType": { "target": "com.amazonaws.pinpoint#TemplateType", "traits": { - "smithy.api#documentation": "

    The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.

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

    The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.

    ", "smithy.api#required": {} } }, @@ -18146,7 +18244,7 @@ "TemplateType": { "target": "com.amazonaws.pinpoint#__string", "traits": { - "smithy.api#documentation": "

    The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.

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

    The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.

    ", "smithy.api#required": {} } }, @@ -20878,6 +20976,12 @@ "traits": { "smithy.api#documentation": "

    The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

    • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

    • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).

    • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

    To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.

    " } + }, + "JourneyLimits": { + "target": "com.amazonaws.pinpoint#ApplicationSettingsJourneyLimits", + "traits": { + "smithy.api#documentation": "

    The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.

    " + } } }, "traits": { diff --git a/codegen/sdk/aws-models/polly.json b/codegen/sdk/aws-models/polly.json index 895b4dc7c2e1..ebc45a63dbd9 100644 --- a/codegen/sdk/aws-models/polly.json +++ b/codegen/sdk/aws-models/polly.json @@ -689,6 +689,12 @@ "traits": { "smithy.api#enumValue": "nl-BE" } + }, + "fr_BE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr-BE" + } } } }, @@ -3401,6 +3407,12 @@ "traits": { "smithy.api#enumValue": "Lisa" } + }, + "Isabelle": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Isabelle" + } } } }, diff --git a/codegen/sdk/aws-models/rds.json b/codegen/sdk/aws-models/rds.json index 5aa63f6cbf22..075663b36b76 100644 --- a/codegen/sdk/aws-models/rds.json +++ b/codegen/sdk/aws-models/rds.json @@ -40,7 +40,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Data returned by the DescribeAccountAttributes action.

    " + "smithy.api#documentation": "

    Data returned by the DescribeAccountAttributes action.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#AccountQuota": { @@ -184,7 +185,17 @@ } ], "traits": { - "smithy.api#documentation": "

    Associates an Identity and Access Management (IAM) role with a DB cluster.

    " + "smithy.api#documentation": "

    Associates an Identity and Access Management (IAM) role with a DB cluster.

    ", + "smithy.api#examples": [ + { + "title": "To associate an AWS Identity and Access Management (IAM) role with a DB cluster", + "documentation": "The following example associates a role with a DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster", + "RoleArn": "arn:aws:iam::123456789012:role/RDSLoadFromS3" + } + } + ] } }, "com.amazonaws.rds#AddRoleToDBClusterMessage": { @@ -210,6 +221,9 @@ "smithy.api#documentation": "

    The name of the feature for the DB cluster that the IAM role is to be associated with. \n For information about supported feature names, see DBEngineVersion.

    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#AddRoleToDBInstance": { @@ -235,7 +249,18 @@ } ], "traits": { - "smithy.api#documentation": "

    Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

    \n \n

    To add a role to a DB instance, the status of the DB instance must be available.

    \n     \n

    This command doesn't apply to RDS Custom.

    " + "smithy.api#documentation": "

    Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

    \n \n

    To add a role to a DB instance, the status of the DB instance must be available.

    \n     \n

    This command doesn't apply to RDS Custom.

    ", + "smithy.api#examples": [ + { + "title": "To associate an AWS Identity and Access Management (IAM) role with a DB instance", + "documentation": "The following example adds the role to a DB instance named test-instance.", + "input": { + "DBInstanceIdentifier": "test-instance", + "RoleArn": "arn:aws:iam::111122223333:role/rds-s3-integration-role", + "FeatureName": "S3_INTEGRATION" + } + } + ] } }, "com.amazonaws.rds#AddRoleToDBInstanceMessage": { @@ -262,6 +287,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#AddSourceIdentifierToSubscription": { @@ -281,7 +309,37 @@ } ], "traits": { - "smithy.api#documentation": "

    Adds a source identifier to an existing RDS event notification subscription.

    " + "smithy.api#documentation": "

    Adds a source identifier to an existing RDS event notification subscription.

    ", + "smithy.api#examples": [ + { + "title": "To add a source identifier to a subscription", + "documentation": "The following example adds another source identifier to an existing subscription.", + "input": { + "SubscriptionName": "my-instance-events", + "SourceIdentifier": "test-instance-repl" + }, + "output": { + "EventSubscription": { + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "CustSubscriptionId": "my-instance-events", + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "Enabled": false, + "Status": "modifying", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "CustomerAwsId": "123456789012", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "SourceType": "db-instance", + "SourceIdsList": [ + "test-instance", + "test-instance-repl" + ] + } + } + } + ] } }, "com.amazonaws.rds#AddSourceIdentifierToSubscriptionMessage": { @@ -303,7 +361,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#AddSourceIdentifierToSubscriptionResult": { @@ -346,7 +405,22 @@ } ], "traits": { - "smithy.api#documentation": "

    Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

    \n

    For an overview on tagging Amazon RDS resources, \n see Tagging Amazon RDS Resources.

    " + "smithy.api#documentation": "

    Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

    \n

    For an overview on tagging Amazon RDS resources, \n see Tagging Amazon RDS Resources.

    ", + "smithy.api#examples": [ + { + "title": "To add tags to a resource", + "documentation": "This example adds a tag to an option group.", + "input": { + "ResourceName": "arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup", + "Tags": [ + { + "Key": "Staging", + "Value": "LocationDB" + } + ] + } + } + ] } }, "com.amazonaws.rds#AddTagsToResourceMessage": { @@ -368,7 +442,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#AmazonRDSv19": { @@ -474,6 +549,9 @@ { "target": "com.amazonaws.rds#DeleteDBCluster" }, + { + "target": "com.amazonaws.rds#DeleteDBClusterAutomatedBackup" + }, { "target": "com.amazonaws.rds#DeleteDBClusterEndpoint" }, @@ -528,6 +606,9 @@ { "target": "com.amazonaws.rds#DescribeCertificates" }, + { + "target": "com.amazonaws.rds#DescribeDBClusterAutomatedBackups" + }, { "target": "com.amazonaws.rds#DescribeDBClusterBacktracks" }, @@ -876,52 +957,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", @@ -929,13 +1014,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -945,92 +1039,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://rds-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://rds-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" + ] + } ] } ], @@ -1039,155 +1124,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://rds.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://rds-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] + "endpoint": { + "url": "https://rds.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://rds-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://rds.{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://rds.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://rds.{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://rds.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -1921,7 +1966,31 @@ } ], "traits": { - "smithy.api#documentation": "

    Applies a pending maintenance action to a resource (for example, to a DB instance).

    " + "smithy.api#documentation": "

    Applies a pending maintenance action to a resource (for example, to a DB instance).

    ", + "smithy.api#examples": [ + { + "title": "To apply pending maintenance actions", + "documentation": "The following example applies the pending maintenance actions for a DB cluster.", + "input": { + "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster", + "ApplyAction": "system-update", + "OptInType": "immediate" + }, + "output": { + "ResourcePendingMaintenanceActions": { + "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster", + "PendingMaintenanceActionDetails": [ + { + "Action": "system-update", + "OptInStatus": "immediate", + "CurrentApplyDate": "2021-01-23T01:07:36.100Z", + "Description": "Upgrade to Aurora PostgreSQL 3.3.2" + } + ] + } + } + } + ] } }, "com.amazonaws.rds#ApplyPendingMaintenanceActionMessage": { @@ -1950,7 +2019,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#ApplyPendingMaintenanceActionResult": { @@ -2075,7 +2145,20 @@ } ], "traits": { - "smithy.api#documentation": "

    Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security \n groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC \n instances. Second, IP ranges are available if the application accessing your database is running on the internet. \n Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId \n and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

    \n

    You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in \n another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

    \n

    For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

    \n \n

    EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

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

    Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security \n groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC \n instances. Second, IP ranges are available if the application accessing your database is running on the internet. \n Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId \n and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

    \n

    You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in \n another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

    \n

    For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

    \n \n

    EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

    \n     ", + "smithy.api#examples": [ + { + "title": "To authorize DB security group integress", + "documentation": "This example authorizes access to the specified security group by the specified CIDR block.", + "input": { + "DBSecurityGroupName": "mydbsecuritygroup", + "CIDRIP": "203.0.113.5/32" + }, + "output": { + "DBSecurityGroup": {} + } + } + ] } }, "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage": { @@ -2114,7 +2197,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressResult": { @@ -2273,7 +2357,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#BackupPolicyNotFoundFault": { @@ -2506,7 +2591,28 @@ } ], "traits": { - "smithy.api#documentation": "

    Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. \n Any data that has already been written to the S3 bucket isn't removed.

    " + "smithy.api#documentation": "

    Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. \n Any data that has already been written to the S3 bucket isn't removed.

    ", + "smithy.api#examples": [ + { + "title": "To cancel a snapshot export to Amazon S3", + "documentation": "The following example cancels an export task in progress that is exporting a snapshot to Amazon S3.", + "input": { + "ExportTaskIdentifier": "my-s3-export-1" + }, + "output": { + "ExportTaskIdentifier": "my-s3-export-1", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:snapshot:publisher-final-snapshot", + "SnapshotTime": "2019-03-24T20:01:09.815Z", + "S3Bucket": "mybucket", + "S3Prefix": "", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/export-snap-S3-role", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/abcd0000-7bfd-4594-af38-aabbccddeeff", + "Status": "CANCELING", + "PercentProgress": 0, + "TotalExtractedDataInGB": 0 + } + } + ] } }, "com.amazonaws.rds#CancelExportTaskMessage": { @@ -2519,6 +2625,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#Certificate": { @@ -2623,7 +2732,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Data returned by the DescribeCertificates action.

    " + "smithy.api#documentation": "

    Data returned by the DescribeCertificates action.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#CertificateNotFoundFault": { @@ -2870,7 +2980,26 @@ } ], "traits": { - "smithy.api#documentation": "

    Copies the specified DB cluster parameter group.

    " + "smithy.api#documentation": "

    Copies the specified DB cluster parameter group.

    ", + "smithy.api#examples": [ + { + "title": "To copy a DB cluster parameter group", + "documentation": "This example copies a DB cluster parameter group.", + "input": { + "SourceDBClusterParameterGroupIdentifier": "mydbclusterparametergroup", + "TargetDBClusterParameterGroupIdentifier": "mydbclusterparametergroup-copy", + "TargetDBClusterParameterGroupDescription": "My DB cluster parameter group copy" + }, + "output": { + "DBClusterParameterGroup": { + "DBClusterParameterGroupName": "mydbclusterparametergroup-copy", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup-copy", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "My DB cluster parameter group copy" + } + } + } + ] } }, "com.amazonaws.rds#CopyDBClusterParameterGroupMessage": { @@ -2900,6 +3029,9 @@ "Tags": { "target": "com.amazonaws.rds#TagList" } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#CopyDBClusterParameterGroupResult": { @@ -2942,7 +3074,45 @@ } ], "traits": { - "smithy.api#documentation": "

    Copies a snapshot of a DB cluster.

    \n

    To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

    \n

    You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case,\n the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the\n destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy\n an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the\n following values:

    \n
      \n
    • \n

      \n KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to \n encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.

      \n
      • \n
    • \n

      \n TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.

      \n
      • \n
    • \n

      \n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot\n identifier for the encrypted DB cluster snapshot to be copied. This identifier\n must be in the ARN format for the source Amazon Web Services Region and is the same value as\n the SourceDBClusterSnapshotIdentifier in the presigned URL.

      \n
      • \n
    \n

    To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.

    \n

    For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.

    \n

    For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    " + "smithy.api#documentation": "

    Copies a snapshot of a DB cluster.

    \n

    To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

    \n

    You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case,\n the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the\n destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy\n an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the\n following values:

    \n
      \n
    • \n

      \n KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to \n encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.

      \n
      • \n
    • \n

      \n TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.

      \n
      • \n
    • \n

      \n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot\n identifier for the encrypted DB cluster snapshot to be copied. This identifier\n must be in the ARN format for the source Amazon Web Services Region and is the same value as\n the SourceDBClusterSnapshotIdentifier in the presigned URL.

      \n
      • \n
    \n

    To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.

    \n

    For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.

    \n

    For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    ", + "smithy.api#examples": [ + { + "title": "To copy a DB cluster snapshot", + "documentation": "The following example creates a copy of a DB cluster snapshot, including its tags.", + "input": { + "SourceDBClusterSnapshotIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:myaurora-2019-06-04-09-16", + "TargetDBClusterSnapshotIdentifier": "myclustersnapshotcopy", + "CopyTags": true + }, + "output": { + "DBClusterSnapshot": { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "myclustersnapshotcopy", + "DBClusterIdentifier": "myaurora", + "SnapshotCreateTime": "2019-06-04T09:16:42.649Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-123example", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:myclustersnapshotcopy", + "IAMDatabaseAuthenticationEnabled": false + } + } + } + ] } }, "com.amazonaws.rds#CopyDBClusterSnapshotMessage": { @@ -2985,7 +3155,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#CopyDBClusterSnapshotResult": { @@ -3019,7 +3190,26 @@ } ], "traits": { - "smithy.api#documentation": "

    Copies the specified DB parameter group.

    " + "smithy.api#documentation": "

    Copies the specified DB parameter group.

    ", + "smithy.api#examples": [ + { + "title": "To copy a DB parameter group", + "documentation": "The following example makes a copy of a DB parameter group.", + "input": { + "SourceDBParameterGroupIdentifier": "mydbpg", + "TargetDBParameterGroupIdentifier": "mydbpgcopy", + "TargetDBParameterGroupDescription": "Copy of mydbpg parameter group" + }, + "output": { + "DBParameterGroup": { + "DBParameterGroupName": "mydbpgcopy", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:814387698303:pg:mydbpgcopy", + "DBParameterGroupFamily": "mysql5.7", + "Description": "Copy of mydbpg parameter group" + } + } + } + ] } }, "com.amazonaws.rds#CopyDBParameterGroupMessage": { @@ -3051,7 +3241,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#CopyDBParameterGroupResult": { @@ -3094,7 +3285,46 @@ } ], "traits": { - "smithy.api#documentation": "

    Copies the specified DB snapshot. The source DB snapshot must be in the available state.

    \n

    You can copy a snapshot from one Amazon Web Services Region to another. In that case, the\n Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination\n Amazon Web Services Region for the DB snapshot copy.

    \n

    This command doesn't apply to RDS Custom.

    \n

    For more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.

    " + "smithy.api#documentation": "

    Copies the specified DB snapshot. The source DB snapshot must be in the available state.

    \n

    You can copy a snapshot from one Amazon Web Services Region to another. In that case, the\n Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination\n Amazon Web Services Region for the DB snapshot copy.

    \n

    This command doesn't apply to RDS Custom.

    \n

    For more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.

    ", + "smithy.api#examples": [ + { + "title": "To copy a DB snapshot", + "documentation": "The following example creates a copy of a DB snapshot.", + "input": { + "SourceDBSnapshotIdentifier": "rds:database-mysql-2019-06-06-08-38", + "TargetDBSnapshotIdentifier": "mydbsnapshotcopy" + }, + "output": { + "DBSnapshot": { + "VpcId": "vpc-6594f31c", + "Status": "creating", + "Encrypted": true, + "SourceDBSnapshotIdentifier": "arn:aws:rds:us-east-1:123456789012:snapshot:rds:database-mysql-2019-06-06-08-38", + "MasterUsername": "admin", + "Iops": 1000, + "Port": 3306, + "LicenseModel": "general-public-license", + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshotcopy", + "EngineVersion": "5.6.40", + "OptionGroupName": "default:mysql-5-6", + "ProcessorFeatures": [], + "Engine": "mysql", + "StorageType": "io1", + "DbiResourceId": "db-ZI7UJ5BLKMBYFGX7FDENCKADC4", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "SnapshotType": "manual", + "IAMDatabaseAuthenticationEnabled": false, + "SourceRegion": "us-east-1", + "DBInstanceIdentifier": "database-mysql", + "InstanceCreateTime": "2019-04-30T15:45:53.663Z", + "AvailabilityZone": "us-east-1f", + "PercentProgress": 0, + "AllocatedStorage": 100, + "DBSnapshotIdentifier": "mydbsnapshotcopy" + } + } + } + ] } }, "com.amazonaws.rds#CopyDBSnapshotMessage": { @@ -3155,7 +3385,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#CopyDBSnapshotResult": { @@ -3189,7 +3420,29 @@ } ], "traits": { - "smithy.api#documentation": "

    Copies the specified option group.

    " + "smithy.api#documentation": "

    Copies the specified option group.

    ", + "smithy.api#examples": [ + { + "title": "To copy an option group", + "documentation": "The following example makes a copy of an option group.", + "input": { + "SourceOptionGroupIdentifier": "myoptiongroup", + "TargetOptionGroupIdentifier": "new-option-group", + "TargetOptionGroupDescription": "My option group copy" + }, + "output": { + "OptionGroup": { + "Options": [], + "OptionGroupName": "new-option-group", + "MajorEngineVersion": "11.2", + "OptionGroupDescription": "My option group copy", + "AllowsVpcAndNonVpcInstanceMemberships": true, + "EngineName": "oracle-ee", + "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:new-option-group" + } + } + } + ] } }, "com.amazonaws.rds#CopyOptionGroupMessage": { @@ -3221,7 +3474,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#CopyOptionGroupResult": { @@ -3441,6 +3695,9 @@ "Tags": { "target": "com.amazonaws.rds#TagList" } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBCluster": { @@ -3508,7 +3765,67 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

    \n

    If you create an Aurora DB cluster, the request creates an empty cluster. You must\n explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the\n request creates a writer and two reader DB instances for you, each in a different\n Availability Zone.

    \n

    You can use the ReplicationSourceIdentifier parameter to create an Amazon\n Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or\n PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User\n Guide.

    \n

    You can also use the ReplicationSourceIdentifier parameter to create a\n Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the\n source. For more information about Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    " + "smithy.api#documentation": "

    Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

    \n

    If you create an Aurora DB cluster, the request creates an empty cluster. You must\n explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the\n request creates a writer and two reader DB instances for you, each in a different\n Availability Zone.

    \n

    You can use the ReplicationSourceIdentifier parameter to create an Amazon\n Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or\n PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User\n Guide.

    \n

    You can also use the ReplicationSourceIdentifier parameter to create a\n Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the\n source. For more information about Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    ", + "smithy.api#examples": [ + { + "title": "To create a MySQL 5.7-compatible DB cluster", + "documentation": "The following example creates a MySQL 5.7-compatible Aurora DB cluster.", + "input": { + "DBClusterIdentifier": "sample-cluster", + "Engine": "aurora-mysql", + "EngineVersion": "5.7.12", + "MasterUsername": "admin", + "MasterUserPassword": "mypassword", + "DBSubnetGroupName": "default", + "VpcSecurityGroupIds": [ + "sg-0b91305example" + ] + }, + "output": { + "DBCluster": { + "DBSubnetGroup": "default", + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-0b91305example", + "Status": "active" + } + ], + "AllocatedStorage": 1, + "AssociatedRoles": [], + "PreferredBackupWindow": "09:12-09:42", + "ClusterCreateTime": "2019-06-07T23:21:33.048Z", + "DeletionProtection": false, + "IAMDatabaseAuthenticationEnabled": false, + "ReadReplicaIdentifiers": [], + "EngineMode": "provisioned", + "Engine": "aurora-mysql", + "StorageEncrypted": false, + "MultiAZ": false, + "PreferredMaintenanceWindow": "mon:04:31-mon:05:01", + "HttpEndpointEnabled": false, + "BackupRetentionPeriod": 1, + "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE", + "DBClusterIdentifier": "sample-cluster", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "MasterUsername": "master", + "EngineVersion": "5.7.12", + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster", + "DBClusterMembers": [], + "Port": 3306, + "Status": "creating", + "Endpoint": "sample-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "DBClusterParameterGroup": "default.aurora-mysql5.7", + "HostedZoneId": "Z2R2ITUGPM61AM", + "ReaderEndpoint": "sample-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "CopyTagsToSnapshot": false + } + } + } + ] } }, "com.amazonaws.rds#CreateDBClusterEndpoint": { @@ -3540,7 +3857,37 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

    \n \n

    This action applies only to Aurora DB clusters.

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

    Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

    \n \n

    This action applies only to Aurora DB clusters.

    \n     ", + "smithy.api#examples": [ + { + "title": "To create a custom DB cluster endpoint", + "documentation": "The following example creates a custom DB cluster endpoint and associate it with the specified Aurora DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointIdentifier": "mycustomendpoint", + "EndpointType": "reader", + "StaticMembers": [ + "dbinstance1", + "dbinstance2" + ] + }, + "output": { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", + "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "creating", + "EndpointType": "CUSTOM", + "CustomEndpointType": "READER", + "StaticMembers": [ + "dbinstance1", + "dbinstance2" + ], + "ExcludedMembers": [], + "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" + } + } + ] } }, "com.amazonaws.rds#CreateDBClusterEndpointMessage": { @@ -3585,6 +3932,9 @@ "smithy.api#documentation": "

    The tags to be assigned to the Amazon RDS resource.

    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBClusterMessage": { @@ -3882,10 +4232,17 @@ "traits": { "smithy.api#documentation": "

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

    \n

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

    \n

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

    \n

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

    \n

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

    \n

    Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

    Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By\n default, write operations aren't allowed on reader DB instances.

    \n

    Valid for: Aurora DB clusters only

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

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBClusterParameterGroup": { @@ -3905,7 +4262,26 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a new DB cluster parameter group.

    \n

    Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

    \n

    A DB cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the DB cluster. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to\n associate it with your DB cluster using ModifyDBCluster.

    \n

    When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB\n instances in the DB cluster without failover for the new DB cluster parameter group and \n associated settings to take effect.

    \n

    When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB\n cluster without failover for the new DB cluster parameter group and associated settings to take effect.

    \n \n

    After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as\n the default parameter group. This allows Amazon RDS to fully complete the create\n action before the DB cluster parameter group is used as the default for a new DB\n cluster. This is especially important for parameters that are critical when creating\n the default database for a DB cluster, such as the character set for the default\n database defined by the character_set_database parameter. You can use\n the Parameter Groups option of the Amazon RDS console or the\n DescribeDBClusterParameters operation to verify that your DB\n cluster parameter group has been created or modified.

    \n     \n

    For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    " + "smithy.api#documentation": "

    Creates a new DB cluster parameter group.

    \n

    Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

    \n

    A DB cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the DB cluster. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to\n associate it with your DB cluster using ModifyDBCluster.

    \n

    When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB\n instances in the DB cluster without failover for the new DB cluster parameter group and \n associated settings to take effect.

    \n

    When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB\n cluster without failover for the new DB cluster parameter group and associated settings to take effect.

    \n \n

    After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as\n the default parameter group. This allows Amazon RDS to fully complete the create\n action before the DB cluster parameter group is used as the default for a new DB\n cluster. This is especially important for parameters that are critical when creating\n the default database for a DB cluster, such as the character set for the default\n database defined by the character_set_database parameter. You can use\n the Parameter Groups option of the Amazon RDS console or the\n DescribeDBClusterParameters operation to verify that your DB\n cluster parameter group has been created or modified.

    \n     \n

    For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    ", + "smithy.api#examples": [ + { + "title": "To create a DB cluster parameter group", + "documentation": "The following example creates a DB cluster parameter group.", + "input": { + "DBClusterParameterGroupName": "mydbclusterparametergroup", + "DBParameterGroupFamily": "aurora5.6", + "Description": "My new cluster parameter group" + }, + "output": { + "DBClusterParameterGroup": { + "DBClusterParameterGroupName": "mydbclusterparametergroup", + "DBParameterGroupFamily": "aurora5.6", + "Description": "My new cluster parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup" + } + } + } + ] } }, "com.amazonaws.rds#CreateDBClusterParameterGroupMessage": { @@ -3940,7 +4316,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBClusterParameterGroupResult": { @@ -3991,7 +4368,44 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a snapshot of a DB cluster.

    \n

    For more information on Amazon Aurora, see What is Amazon\n Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    " + "smithy.api#documentation": "

    Creates a snapshot of a DB cluster.

    \n

    For more information on Amazon Aurora, see What is Amazon\n Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    ", + "smithy.api#examples": [ + { + "title": "To create a DB cluster snapshot", + "documentation": "The following example creates a DB cluster snapshot.", + "input": { + "DBClusterSnapshotIdentifier": "mydbcluster", + "DBClusterIdentifier": "mydbclustersnapshot" + }, + "output": { + "DBClusterSnapshot": { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "mydbclustersnapshot", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-18T21:21:00.469Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 1, + "Status": "creating", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 0, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot", + "IAMDatabaseAuthenticationEnabled": false + } + } + } + ] } }, "com.amazonaws.rds#CreateDBClusterSnapshotMessage": { @@ -4019,7 +4433,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBClusterSnapshotResult": { @@ -4107,7 +4522,111 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a new DB instance.

    \n

    The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. \n For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance \n to the cluster.

    \n

    For more information about creating an RDS DB instance, see \n Creating an Amazon RDS DB instance in the Amazon RDS User Guide.

    \n

    For more information about creating a DB instance in an Aurora DB cluster, see \n \n Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.

    " + "smithy.api#documentation": "

    Creates a new DB instance.

    \n

    The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. \n For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance \n to the cluster.

    \n

    For more information about creating an RDS DB instance, see \n Creating an Amazon RDS DB instance in the Amazon RDS User Guide.

    \n

    For more information about creating a DB instance in an Aurora DB cluster, see \n \n Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.

    ", + "smithy.api#examples": [ + { + "title": "To create a DB instance", + "documentation": "The following example uses the required options to launch a new DB instance.", + "input": { + "DBInstanceIdentifier": "test-mysql-instance", + "AllocatedStorage": 20, + "DBInstanceClass": "db.t3.micro", + "Engine": "mysql", + "MasterUsername": "admin", + "MasterUserPassword": "secret99" + }, + "output": { + "DBInstance": { + "DBInstanceIdentifier": "test-mysql-instance", + "DBInstanceClass": "db.t3.micro", + "Engine": "mysql", + "DBInstanceStatus": "creating", + "MasterUsername": "admin", + "AllocatedStorage": 20, + "PreferredBackupWindow": "12:55-13:25", + "BackupRetentionPeriod": 1, + "DBSecurityGroups": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-12345abc", + "Status": "active" + } + ], + "DBParameterGroups": [ + { + "DBParameterGroupName": "default.mysql5.7", + "ParameterApplyStatus": "in-sync" + } + ], + "DBSubnetGroup": { + "DBSubnetGroupName": "default", + "DBSubnetGroupDescription": "default", + "VpcId": "vpc-2ff2ff2f", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + } + ] + }, + "PreferredMaintenanceWindow": "sun:08:07-sun:08:37", + "PendingModifiedValues": { + "MasterUserPassword": "****" + }, + "MultiAZ": false, + "EngineVersion": "5.7.22", + "AutoMinorVersionUpgrade": true, + "ReadReplicaDBInstanceIdentifiers": [], + "LicenseModel": "general-public-license", + "OptionGroupMemberships": [ + { + "OptionGroupName": "default:mysql-5-7", + "Status": "in-sync" + } + ], + "PubliclyAccessible": true, + "StorageType": "gp2", + "DbInstancePort": 0, + "StorageEncrypted": false, + "DbiResourceId": "db-5555EXAMPLE44444444EXAMPLE", + "CACertificateIdentifier": "rds-ca-2019", + "DomainMemberships": [], + "CopyTagsToSnapshot": false, + "MonitoringInterval": 0, + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:test-mysql-instance", + "IAMDatabaseAuthenticationEnabled": false, + "PerformanceInsightsEnabled": false, + "DeletionProtection": false, + "AssociatedRoles": [] + } + } + } + ] } }, "com.amazonaws.rds#CreateDBInstanceMessage": { @@ -4478,7 +4997,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBInstanceReadReplica": { @@ -4558,7 +5078,26 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a new DB instance that acts as a read replica for an existing source DB\n instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running\n MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a\n Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working\n with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.

    \n

    Amazon Aurora doesn't support this operation. Call the CreateDBInstance\n operation to create a DB instance for an Aurora DB cluster.

    \n

    All read replica DB instances are created with backups disabled. All other attributes\n (including DB security groups and DB parameter groups) are inherited from the source DB\n instance or cluster, except as specified.

    \n \n

    Your source DB instance or cluster must have backup retention enabled.

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

    Creates a new DB instance that acts as a read replica for an existing source DB\n instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running\n MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a\n Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working\n with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.

    \n

    Amazon Aurora doesn't support this operation. Call the CreateDBInstance\n operation to create a DB instance for an Aurora DB cluster.

    \n

    All read replica DB instances are created with backups disabled. All other attributes\n (including DB security groups and DB parameter groups) are inherited from the source DB\n instance or cluster, except as specified.

    \n \n

    Your source DB instance or cluster must have backup retention enabled.

    \n     ", + "smithy.api#examples": [ + { + "title": "To create a DB instance read replica", + "documentation": "This example creates a read replica of an existing DB instance named test-instance. The read replica is named test-instance-repl.", + "input": { + "DBInstanceIdentifier": "test-instance-repl", + "SourceDBInstanceIdentifier": "test-instance" + }, + "output": { + "DBInstance": { + "IAMDatabaseAuthenticationEnabled": false, + "MonitoringInterval": 0, + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl", + "ReadReplicaSourceDBInstanceIdentifier": "test-instance", + "DBInstanceIdentifier": "test-instance-repl" + } + } + } + ] } }, "com.amazonaws.rds#CreateDBInstanceReadReplicaMessage": { @@ -4814,6 +5353,9 @@ "smithy.api#documentation": "

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

    \n

    Constraints:

    \n
      \n
    • \n

      Must be the identifier of an existing Multi-AZ DB cluster.

      \n
      • \n
    • \n

      Can't be specified if the SourceDBInstanceIdentifier parameter is\n also specified.

      \n
      • \n
    • \n

      The specified DB cluster must have automatic backups enabled, that is, its\n backup retention period must be greater than 0.

      \n
      • \n
    • \n

      The source DB cluster must be in the same Amazon Web Services Region as the read replica.\n Cross-Region replication isn't supported.

      \n
      • \n
    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBInstanceReadReplicaResult": { @@ -4855,7 +5397,26 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a new DB parameter group.

    \n

    A DB parameter group is initially created with the default parameters for the\n database engine used by the DB instance. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBParameterGroup. Once you've created a DB parameter group, you need to\n associate it with your DB instance using ModifyDBInstance. When you associate\n a new DB parameter group with a running DB instance, you need to reboot the DB\n instance without failover for the new DB parameter group and associated settings to take effect.

    \n

    This command doesn't apply to RDS Custom.

    \n \n

    After you create a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

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

    Creates a new DB parameter group.

    \n

    A DB parameter group is initially created with the default parameters for the\n database engine used by the DB instance. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBParameterGroup. Once you've created a DB parameter group, you need to\n associate it with your DB instance using ModifyDBInstance. When you associate\n a new DB parameter group with a running DB instance, you need to reboot the DB\n instance without failover for the new DB parameter group and associated settings to take effect.

    \n

    This command doesn't apply to RDS Custom.

    \n \n

    After you create a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

    \n     ", + "smithy.api#examples": [ + { + "title": "To create a DB parameter group", + "documentation": "The following example creates a DB parameter group.", + "input": { + "DBParameterGroupName": "mydbparametergroup", + "DBParameterGroupFamily": "MySQL8.0", + "Description": "My new parameter group" + }, + "output": { + "DBParameterGroup": { + "DBParameterGroupName": "mydbparametergroup", + "DBParameterGroupFamily": "mysql8.0", + "Description": "My new parameter group", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:mydbparametergroup" + } + } + } + ] } }, "com.amazonaws.rds#CreateDBParameterGroupMessage": { @@ -4890,7 +5451,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBParameterGroupResult": { @@ -5123,7 +5685,20 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a new DB security group. DB security groups control access to a DB instance.

    \n

    A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

    \n \n

    EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

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

    Creates a new DB security group. DB security groups control access to a DB instance.

    \n

    A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

    \n \n

    EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

    \n     ", + "smithy.api#examples": [ + { + "title": "To create a DB security group.", + "documentation": "This example creates a DB security group.", + "input": { + "DBSecurityGroupName": "mydbsecuritygroup", + "DBSecurityGroupDescription": "My DB security group" + }, + "output": { + "DBSecurityGroup": {} + } + } + ] } }, "com.amazonaws.rds#CreateDBSecurityGroupMessage": { @@ -5151,7 +5726,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBSecurityGroupResult": { @@ -5188,7 +5764,44 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a snapshot of a DB instance. The source DB instance must be in the available or\n storage-optimization state.

    " + "smithy.api#documentation": "

    Creates a snapshot of a DB instance. The source DB instance must be in the available or\n storage-optimization state.

    ", + "smithy.api#examples": [ + { + "title": "To create a DB snapshot", + "documentation": "The following example creates a DB snapshot.", + "input": { + "DBSnapshotIdentifier": "database-mysql", + "DBInstanceIdentifier": "mydbsnapshot" + }, + "output": { + "DBSnapshot": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBInstanceIdentifier": "database-mysql", + "Engine": "mysql", + "AllocatedStorage": 100, + "Status": "creating", + "Port": 3306, + "AvailabilityZone": "us-east-1b", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2019-04-30T15:45:53.663Z", + "MasterUsername": "admin", + "EngineVersion": "8.0.32", + "LicenseModel": "general-public-license", + "SnapshotType": "manual", + "Iops": 1000, + "OptionGroupName": "default:mysql-8-0", + "PercentProgress": 0, + "StorageType": "io1", + "Encrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" + } + } + } + ] } }, "com.amazonaws.rds#CreateDBSnapshotMessage": { @@ -5213,7 +5826,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBSnapshotResult": { @@ -5253,7 +5867,54 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

    " + "smithy.api#documentation": "

    Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

    ", + "smithy.api#examples": [ + { + "title": "To create a DB subnet group", + "documentation": "The following example creates a DB subnet group called mysubnetgroup using existing subnets.", + "input": { + "DBSubnetGroupName": "mysubnetgroup", + "DBSubnetGroupDescription": "test DB subnet group", + "SubnetIds": [ + "subnet-0a1dc4e1a6f123456", + "subnet-070dd7ecb3aaaaaaa", + "subnet-00f5b198bc0abcdef" + ] + }, + "output": { + "DBSubnetGroup": { + "DBSubnetGroupName": "mysubnetgroup", + "DBSubnetGroupDescription": "test DB subnet group", + "VpcId": "vpc-0f08e7610a1b2c3d4", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-070dd7ecb3aaaaaaa", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-00f5b198bc0abcdef", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-0a1dc4e1a6f123456", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + } + ], + "DBSubnetGroupArn": "arn:aws:rds:us-west-2:0123456789012:subgrp:mysubnetgroup" + } + } + } + ] } }, "com.amazonaws.rds#CreateDBSubnetGroupMessage": { @@ -5288,7 +5949,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateDBSubnetGroupResult": { @@ -5334,7 +5996,38 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates an RDS event notification subscription. This operation requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.

    \n

    You can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.

    \n

    If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIds = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify SourceIds,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIds, you are notified of events\n generated from all RDS sources belonging to your customer account.

    \n

    For more information about subscribing to an event for RDS DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.

    \n

    For more information about subscribing to an event for Aurora DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.

    " + "smithy.api#documentation": "

    Creates an RDS event notification subscription. This operation requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.

    \n

    You can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.

    \n

    If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIds = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify SourceIds,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIds, you are notified of events\n generated from all RDS sources belonging to your customer account.

    \n

    For more information about subscribing to an event for RDS DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.

    \n

    For more information about subscribing to an event for Aurora DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.

    ", + "smithy.api#examples": [ + { + "title": "To create an event subscription", + "documentation": "The following example creates a subscription for backup and recovery events for DB instances in the current AWS account. Notifications are sent to an Amazon Simple Notification Service topic.", + "input": { + "SubscriptionName": "my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "SourceType": "db-instance", + "EventCategories": [ + "backup", + "recovery" + ] + }, + "output": { + "EventSubscription": { + "Status": "creating", + "CustSubscriptionId": "my-instance-events", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "CustomerAwsId": "123456789012", + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SourceType": "db-instance", + "Enabled": true + } + } + } + ] } }, "com.amazonaws.rds#CreateEventSubscriptionMessage": { @@ -5383,7 +6076,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateEventSubscriptionResult": { @@ -5420,7 +6114,30 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates an Aurora global database\n spread across multiple Amazon Web Services Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.

    \n

    You can create a global database that is initially empty, and then \n create the primary and secondary DB clusters in the global database.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.

    \n \n

    This operation applies only to Aurora DB clusters.

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

    Creates an Aurora global database\n spread across multiple Amazon Web Services Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.

    \n

    You can create a global database that is initially empty, and then \n create the primary and secondary DB clusters in the global database.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.

    \n \n

    This operation applies only to Aurora DB clusters.

    \n     ", + "smithy.api#examples": [ + { + "title": "To create a global DB cluster", + "documentation": "The following example creates a new Aurora MySQL-compatible global DB cluster.", + "input": { + "GlobalClusterIdentifier": "myglobalcluster", + "Engine": "aurora-mysql" + }, + "output": { + "GlobalCluster": { + "GlobalClusterIdentifier": "myglobalcluster", + "GlobalClusterResourceId": "cluster-f0e523bfe07aabb", + "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", + "Status": "available", + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.07.2", + "StorageEncrypted": false, + "DeletionProtection": false, + "GlobalClusterMembers": [] + } + } + } + ] } }, "com.amazonaws.rds#CreateGlobalClusterMessage": { @@ -5468,6 +6185,9 @@ "smithy.api#documentation": "

    Specifies whether to enable storage encryption for the new global database cluster.

    \n

    Constraints:

    \n
      \n
    • \n

      Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.

      \n
      • \n
    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateGlobalClusterResult": { @@ -5498,7 +6218,30 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a new option group. You can create up to 20 option groups.

    \n

    This command doesn't apply to RDS Custom.

    " + "smithy.api#documentation": "

    Creates a new option group. You can create up to 20 option groups.

    \n

    This command doesn't apply to RDS Custom.

    ", + "smithy.api#examples": [ + { + "title": "To Create an Amazon RDS option group", + "documentation": "The following example creates a new Amazon RDS option group for Oracle MySQL version 8,0 named MyOptionGroup.", + "input": { + "OptionGroupName": "MyOptionGroup", + "EngineName": "mysql", + "MajorEngineVersion": "8.0", + "OptionGroupDescription": "MySQL 8.0 option group" + }, + "output": { + "OptionGroup": { + "OptionGroupName": "myoptiongroup", + "OptionGroupDescription": "MySQL 8.0 option group", + "EngineName": "mysql", + "MajorEngineVersion": "8.0", + "Options": [], + "AllowsVpcAndNonVpcInstanceMemberships": true, + "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:myoptiongroup" + } + } + } + ] } }, "com.amazonaws.rds#CreateOptionGroupMessage": { @@ -5540,7 +6283,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#CreateOptionGroupResult": { @@ -6122,6 +6866,12 @@ "traits": { "smithy.api#documentation": "

    The next time you can modify the DB cluster to use the aurora-iopt1 storage type.

    \n

    This setting is only for Aurora DB clusters.

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

    Specifies whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process \n of enabling it.

    " + } } }, "traits": { @@ -6145,119 +6895,330 @@ "smithy.api#httpError": 400 } }, - "com.amazonaws.rds#DBClusterBacktrack": { + "com.amazonaws.rds#DBClusterAutomatedBackup": { "type": "structure", "members": { - "DBClusterIdentifier": { + "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

    " + "smithy.api#documentation": "

    The name of the database engine for this automated backup.

    " } }, - "BacktrackIdentifier": { + "VpcId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Contains the backtrack identifier.

    " + "smithy.api#documentation": "

    The VPC ID associated with the DB cluster.

    " } }, - "BacktrackTo": { - "target": "com.amazonaws.rds#TStamp", + "DBClusterAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The timestamp of the time to which the DB cluster was backtracked.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the automated backups.

    " } }, - "BacktrackedFrom": { - "target": "com.amazonaws.rds#TStamp", + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The timestamp of the time from which the DB cluster was backtracked.

    " + "smithy.api#documentation": "

    The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

    " } }, - "BacktrackRequestCreationTime": { - "target": "com.amazonaws.rds#TStamp", + "RestoreWindow": { + "target": "com.amazonaws.rds#RestoreWindow" + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The timestamp of the time at which the backtrack was requested.

    " + "smithy.api#documentation": "

    The master user name of the automated backup.

    " } }, - "Status": { + "DbClusterResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The status of the backtrack. This property returns one of the following\n values:

    \n
      \n
    • \n

      \n applying - The backtrack is currently being applied to or rolled back from the DB cluster.

      \n
      • \n
    • \n

      \n completed - The backtrack has successfully been applied to or rolled back from the DB cluster.

      \n
      • \n
    • \n

      \n failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.

      \n
      • \n
    • \n

      \n pending - The backtrack is currently pending application to or rollback from the DB cluster.

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

    The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

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

    This data type is used as a response element in the DescribeDBClusterBacktracks action.

    " - } - }, - "com.amazonaws.rds#DBClusterBacktrackList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBClusterBacktrack", - "traits": { - "smithy.api#xmlName": "DBClusterBacktrack" - } - } - }, - "com.amazonaws.rds#DBClusterBacktrackMessage": { - "type": "structure", - "members": { - "Marker": { + }, + "Region": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A pagination token that can be used in a later DescribeDBClusterBacktracks request.

    " + "smithy.api#documentation": "

    The Amazon Web Services Region associated with the automated backup.

    " } }, - "DBClusterBacktracks": { - "target": "com.amazonaws.rds#DBClusterBacktrackList", + "LicenseModel": { + "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Contains a list of backtracks for the user.

    " + "smithy.api#documentation": "

    The license model information for this DB cluster automated backup.

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

    Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.

    " - } - }, - "com.amazonaws.rds#DBClusterBacktrackNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterBacktrackNotFoundFault", - "httpResponseCode": 404 }, - "smithy.api#documentation": "

    \n BacktrackIdentifier doesn't refer to an existing backtrack.

    ", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBClusterCapacityInfo": { - "type": "structure", - "members": { - "DBClusterIdentifier": { + "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A user-supplied DB cluster identifier. This identifier is the unique key that\n identifies a DB cluster.

    " + "smithy.api#documentation": "

    A list of status information for an automated backup:

    \n
      \n
    • \n

      \n retained - Automated backups for deleted clusters.

      \n
      • \n
    " } }, - "PendingCapacity": { - "target": "com.amazonaws.rds#IntegerOptional", + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "

    A value that specifies the capacity that the DB cluster scales to next.

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

    True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and \n otherwise false.

    " } }, - "CurrentCapacity": { - "target": "com.amazonaws.rds#IntegerOptional", + "ClusterCreateTime": { + "target": "com.amazonaws.rds#TStamp", "traits": { - "smithy.api#documentation": "

    The current capacity of the DB cluster.

    " + "smithy.api#documentation": "

    The time when the DB cluster was created, in Universal Coordinated Time (UTC).

    " } }, - "SecondsBeforeTimeout": { - "target": "com.amazonaws.rds#IntegerOptional", + "StorageEncrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

    Specifies whether the source DB cluster is encrypted.

    " + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). \n For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically\n adjusts as needed.

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

    The version of the database engine for the automated backup.

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

    The Amazon Resource Name (ARN) for the source DB cluster.

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

    The retention period for the automated backups.

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

    The engine mode of the database engine for the automated backup.

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

    The Availability Zones where instances in the DB cluster can be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

    " + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

    The port number that the automated backup used for connections.

    \n

    Default: Inherits from the source DB cluster

    \n

    Valid Values: 1150-65535\n

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

    The Amazon Web Services KMS key ID for an automated backup.

    \n

    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

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

    The storage type associated with the DB cluster.

    \n

    This setting is only for non-Aurora Multi-AZ DB clusters.

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

    The IOPS (I/O operations per second) value for the automated backup.

    \n

    This setting is only for non-Aurora Multi-AZ DB clusters.

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

    An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster \n properties that existed at the time you deleted the source cluster.

    " + } + }, + "com.amazonaws.rds#DBClusterAutomatedBackupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterAutomatedBackup", + "traits": { + "smithy.api#xmlName": "DBClusterAutomatedBackup" + } + } + }, + "com.amazonaws.rds#DBClusterAutomatedBackupMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The pagination token provided in the previous request. If this parameter is specified the response includes only \n records beyond the marker, up to MaxRecords.

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

    A list of DBClusterAutomatedBackup backups.

    " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterAutomatedBackupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

    No automated backup for this DB cluster was found.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBClusterAutomatedBackupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterAutomatedBackupQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

    The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated \n backups. The retained automated backups quota is the same as your DB cluster quota.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterBacktrack": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

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

    Contains the backtrack identifier.

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

    The timestamp of the time to which the DB cluster was backtracked.

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

    The timestamp of the time from which the DB cluster was backtracked.

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

    The timestamp of the time at which the backtrack was requested.

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

    The status of the backtrack. This property returns one of the following\n values:

    \n
      \n
    • \n

      \n applying - The backtrack is currently being applied to or rolled back from the DB cluster.

      \n
      • \n
    • \n

      \n completed - The backtrack has successfully been applied to or rolled back from the DB cluster.

      \n
      • \n
    • \n

      \n failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.

      \n
      • \n
    • \n

      \n pending - The backtrack is currently pending application to or rollback from the DB cluster.

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

    This data type is used as a response element in the DescribeDBClusterBacktracks action.

    " + } + }, + "com.amazonaws.rds#DBClusterBacktrackList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterBacktrack", + "traits": { + "smithy.api#xmlName": "DBClusterBacktrack" + } + } + }, + "com.amazonaws.rds#DBClusterBacktrackMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    A pagination token that can be used in a later DescribeDBClusterBacktracks request.

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

    Contains a list of backtracks for the user.

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

    Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.

    ", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBClusterBacktrackNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterBacktrackNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

    \n BacktrackIdentifier doesn't refer to an existing backtrack.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBClusterCapacityInfo": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    A user-supplied DB cluster identifier. This identifier is the unique key that\n identifies a DB cluster.

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

    A value that specifies the capacity that the DB cluster scales to next.

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

    The current capacity of the DB cluster.

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

    The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

    " } @@ -6379,6 +7340,9 @@ "smithy.api#documentation": "

    Contains the details of the endpoints associated with the cluster\n and matching any filter conditions.

    " } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rds#DBClusterEndpointNotFoundFault": { @@ -6493,7 +7457,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeDBClusters action.

    " + "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeDBClusters action.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#DBClusterNotFoundFault": { @@ -6651,7 +7616,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#DBClusterQuotaExceededFault": { @@ -6875,7 +7841,7 @@ "DBClusterSnapshotArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the DB cluster snapshot.

    " + "smithy.api#documentation": "

    Specifies the Amazon Resource Name (ARN) for the DB cluster snapshot.

    " } }, "SourceDBClusterSnapshotArn": { @@ -6905,6 +7871,12 @@ "traits": { "smithy.api#documentation": "

    The storage type associated with the DB cluster snapshot.

    \n

    This setting is only for Aurora DB clusters.

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

    Specifies the resource ID of the DB cluster that this DB cluster snapshot was created from.

    " + } } }, "traits": { @@ -7003,7 +7975,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

    " + "smithy.api#documentation": "

    Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#DBClusterSnapshotNotFoundFault": { @@ -7213,6 +8186,12 @@ "traits": { "smithy.api#documentation": "

    A list of the supported CA certificate identifiers.

    \n

    For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

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

    A value that indicates whether the DB engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

    \n

    Valid for: Aurora DB clusters only

    " + } } }, "traits": { @@ -7245,7 +8224,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeDBEngineVersions action.

    " + "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeDBEngineVersions action.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#DBInstance": { @@ -7784,7 +8764,7 @@ "DbiResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

    " + "smithy.api#documentation": "

    The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

    " } }, "Region": { @@ -7796,7 +8776,7 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The customer id of the instance that is/was associated with the automated backup.

    " + "smithy.api#documentation": "

    The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

    " } }, "RestoreWindow": { @@ -7815,7 +8795,7 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Provides a list of status information for an automated backup:

    \n
      \n
    • \n

      \n active - automated backups for current instances

      \n
      • \n
    • \n

      \n retained - automated backups for deleted instances

      \n
      • \n
    • \n

      \n creating - automated backups that are waiting\n for the first automated snapshot to be available.

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

    Provides a list of status information for an automated backup:

    \n
      \n
    • \n

      \n active - Automated backups for current instances.

      \n
      • \n
    • \n

      \n retained - Automated backups for deleted instances.

      \n
      • \n
    • \n

      \n creating - Automated backups that are waiting for the first automated snapshot to be available.

      \n
      • \n
    " } }, "Port": { @@ -7846,7 +8826,7 @@ "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The license model of an automated backup.

    " + "smithy.api#documentation": "

    The master user name of an automated backup.

    " } }, "Engine": { @@ -7978,7 +8958,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.

    " + "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault": { @@ -8010,7 +8991,7 @@ "code": "DBInstanceAutomatedBackupQuotaExceeded", "httpResponseCode": 400 }, - "smithy.api#documentation": "

    The quota for retained automated backups was exceeded. This prevents you\n from retaining any additional automated backups. The retained automated backups \n quota is the same as your DB Instance quota.

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

    The quota for retained automated backups was exceeded. This prevents you\n from retaining any additional automated backups. The retained automated backups \n quota is the same as your DB instance quota.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -8064,7 +9045,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeDBInstances action.

    " + "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeDBInstances action.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#DBInstanceNotFoundFault": { @@ -8401,7 +9383,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeDBParameterGroups action.

    " + "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeDBParameterGroups action.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#DBProxy": { @@ -9109,7 +10092,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

    " + "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#DBSecurityGroupNameList": { @@ -9487,7 +10471,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeDBSnapshots action.

    " + "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeDBSnapshots action.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#DBSnapshotNotFoundFault": { @@ -9608,7 +10593,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

    " + "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#DBSubnetGroupNotAllowedFault": { @@ -9804,6 +10790,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteDBCluster": { @@ -9816,7 +10805,10 @@ }, "errors": [ { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" + "target": "com.amazonaws.rds#DBClusterAutomatedBackupQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, { "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" @@ -9832,7 +10824,79 @@ } ], "traits": { - "smithy.api#documentation": "

    The DeleteDBCluster action deletes a previously provisioned DB cluster. \n When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. \n Manual DB cluster snapshots of the specified DB cluster are not deleted.

    \n

    If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are\n terminated and read replicas are promoted to standalone instances.

    \n

    For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    " + "smithy.api#documentation": "

    The DeleteDBCluster action deletes a previously provisioned DB cluster. \n When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. \n Manual DB cluster snapshots of the specified DB cluster are not deleted.

    \n

    If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are\n terminated and read replicas are promoted to standalone instances.

    \n

    For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    ", + "smithy.api#examples": [ + { + "title": "To delete a DB cluster", + "documentation": "The following example deletes the DB cluster named mycluster and takes a final snapshot named mycluster-final-snapshot. The status of the DB cluster is available while the snapshot is being taken. ", + "input": { + "DBClusterIdentifier": "mycluster", + "SkipFinalSnapshot": false, + "FinalDBSnapshotIdentifier": "mycluster-final-snapshot" + }, + "output": { + "DBCluster": { + "AllocatedStorage": 20, + "AvailabilityZones": [ + "eu-central-1b", + "eu-central-1c", + "eu-central-1a" + ], + "BackupRetentionPeriod": 7, + "DBClusterIdentifier": "mycluster", + "DBClusterParameterGroup": "default.aurora-postgresql10", + "DBSubnetGroup": "default-vpc-aa11bb22", + "Status": "available" + } + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBClusterAutomatedBackup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBClusterAutomatedBackupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBClusterAutomatedBackupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterAutomatedBackupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes automated backups using the DbClusterResourceId value of the source DB cluster or the Amazon \n Resource Name (ARN) of the automated backups.

    " + } + }, + "com.amazonaws.rds#DeleteDBClusterAutomatedBackupMessage": { + "type": "structure", + "members": { + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBClusterAutomatedBackupResult": { + "type": "structure", + "members": { + "DBClusterAutomatedBackup": { + "target": "com.amazonaws.rds#DBClusterAutomatedBackup" + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rds#DeleteDBClusterEndpoint": { @@ -9855,7 +10919,32 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

    \n \n

    This action only applies to Aurora DB clusters.

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

    Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

    \n \n

    This action only applies to Aurora DB clusters.

    \n     ", + "smithy.api#examples": [ + { + "title": "To delete a custom DB cluster endpoint", + "documentation": "The following example deletes the specified custom DB cluster endpoint.", + "input": { + "DBClusterEndpointIdentifier": "mycustomendpoint" + }, + "output": { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", + "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "deleting", + "EndpointType": "CUSTOM", + "CustomEndpointType": "READER", + "StaticMembers": [ + "dbinstance1", + "dbinstance2", + "dbinstance3" + ], + "ExcludedMembers": [], + "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" + } + } + ] } }, "com.amazonaws.rds#DeleteDBClusterEndpointMessage": { @@ -9868,6 +10957,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteDBClusterMessage": { @@ -9892,10 +10984,17 @@ "traits": { "smithy.api#documentation": "

    The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot\n is disabled.

    \n \n

    Specifying this parameter and also skipping the creation of a final DB cluster snapshot \n with the SkipFinalShapshot parameter results in an error.

    \n     \n

    Constraints:

    \n
      \n
    • \n

      Must be 1 to 255 letters, numbers, or hyphens.

      \n
      • \n
    • \n

      First character must be a letter

      \n
      • \n
    • \n

      Can't end with a hyphen or contain two consecutive hyphens

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

    A value that indicates whether to remove automated backups immediately after the DB\n cluster is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB cluster is deleted.

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

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteDBClusterParameterGroup": { @@ -9915,7 +11014,16 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

    \n

    For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    " + "smithy.api#documentation": "

    Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

    \n

    For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    ", + "smithy.api#examples": [ + { + "title": "To delete a DB cluster parameter group", + "documentation": "The following example deletes the specified DB cluster parameter group.", + "input": { + "DBClusterParameterGroupName": "mydbclusterparametergroup" + } + } + ] } }, "com.amazonaws.rds#DeleteDBClusterParameterGroupMessage": { @@ -9930,7 +11038,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteDBClusterResult": { @@ -9961,7 +11070,43 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

    \n \n

    The DB cluster snapshot must be in the available state to be\n deleted.

    \n     \n

    For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    " + "smithy.api#documentation": "

    Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

    \n \n

    The DB cluster snapshot must be in the available state to be\n deleted.

    \n     \n

    For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    ", + "smithy.api#examples": [ + { + "title": "To delete a DB cluster snapshot", + "documentation": "", + "input": { + "DBClusterSnapshotIdentifier": "mydbclustersnapshot" + }, + "output": { + "DBClusterSnapshot": { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "mydbclustersnapshot", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-18T21:21:00.469Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot", + "IAMDatabaseAuthenticationEnabled": false + } + } + } + ] } }, "com.amazonaws.rds#DeleteDBClusterSnapshotMessage": { @@ -9976,7 +11121,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteDBClusterSnapshotResult": { @@ -10019,7 +11165,24 @@ } ], "traits": { - "smithy.api#documentation": "

    The DeleteDBInstance action deletes a previously provisioned DB instance. \n When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. \n Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

    \n

    If you request a final DB snapshot \n the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance\n is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

    \n

    When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

    \n

    If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following\n conditions are true:

    \n
      \n
    • \n

      The DB cluster is a read replica of another Amazon Aurora DB cluster.

      \n
      • \n
    • \n

      The DB instance is the only instance in the DB cluster.

      \n
      • \n
    \n

    To delete a DB instance in this case, first call the\n PromoteReadReplicaDBCluster API action to promote the DB cluster so\n it's no longer a read replica. After the promotion completes, then call the\n DeleteDBInstance API action to delete the final instance in the DB\n cluster.

    " + "smithy.api#documentation": "

    The DeleteDBInstance action deletes a previously provisioned DB instance. \n When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. \n Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

    \n

    If you request a final DB snapshot \n the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance\n is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

    \n

    When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

    \n

    If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following\n conditions are true:

    \n
      \n
    • \n

      The DB cluster is a read replica of another Amazon Aurora DB cluster.

      \n
      • \n
    • \n

      The DB instance is the only instance in the DB cluster.

      \n
      • \n
    \n

    To delete a DB instance in this case, first call the\n PromoteReadReplicaDBCluster API action to promote the DB cluster so\n it's no longer a read replica. After the promotion completes, then call the\n DeleteDBInstance API action to delete the final instance in the DB\n cluster.

    ", + "smithy.api#examples": [ + { + "title": "To delete a DB instance", + "documentation": "The following example deletes the specified DB instance after creating a final DB snapshot named test-instance-final-snap.", + "input": { + "DBInstanceIdentifier": "test-instance", + "SkipFinalSnapshot": false, + "FinalDBSnapshotIdentifier": "test-instance-final-snap" + }, + "output": { + "DBInstance": { + "DBInstanceIdentifier": "test-instance", + "DBInstanceStatus": "deleting" + } + } + } + ] } }, "com.amazonaws.rds#DeleteDBInstanceAutomatedBackup": { @@ -10039,7 +11202,41 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

    " + "smithy.api#documentation": "

    Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

    ", + "smithy.api#examples": [ + { + "title": "To delete a replicated automated backup from a Region", + "documentation": "The following example deletes the automated backup with the specified Amazon Resource Name (ARN).", + "input": { + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + }, + "output": { + "DBInstanceAutomatedBackup": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", + "Region": "us-east-1", + "DBInstanceIdentifier": "new-orcl-db", + "RestoreWindow": {}, + "AllocatedStorage": 20, + "Status": "deleting", + "Port": 1521, + "AvailabilityZone": "us-east-1b", + "VpcId": "vpc-########", + "InstanceCreateTime": "2020-12-04T15:28:31Z", + "MasterUsername": "admin", + "Engine": "oracle-se2", + "EngineVersion": "12.1.0.2.v21", + "LicenseModel": "bring-your-own-license", + "OptionGroupName": "default:oracle-se2-12-1", + "Encrypted": false, + "StorageType": "gp2", + "IAMDatabaseAuthenticationEnabled": false, + "BackupRetentionPeriod": 7, + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + } + } + } + ] } }, "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupMessage": { @@ -10059,7 +11256,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Parameter input for the DeleteDBInstanceAutomatedBackup operation.

    " + "smithy.api#documentation": "

    Parameter input for the DeleteDBInstanceAutomatedBackup operation.

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupResult": { @@ -10104,7 +11302,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteDBInstanceResult": { @@ -10135,7 +11334,16 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

    " + "smithy.api#documentation": "

    Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

    ", + "smithy.api#examples": [ + { + "title": "To delete a DB parameter group", + "documentation": "The following example deletes a DB parameter group.", + "input": { + "DBParameterGroupName": "mydbparametergroup" + } + } + ] } }, "com.amazonaws.rds#DeleteDBParameterGroupMessage": { @@ -10150,7 +11358,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteDBProxy": { @@ -10268,7 +11477,16 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes a DB security group.

    \n

    The specified DB security group must not be associated with any DB instances.

    \n \n

    EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

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

    Deletes a DB security group.

    \n

    The specified DB security group must not be associated with any DB instances.

    \n \n

    EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

    \n     ", + "smithy.api#examples": [ + { + "title": "To delete a DB security group", + "documentation": "The following example deletes a DB security group.", + "input": { + "DBSecurityGroupName": "mysecgroup" + } + } + ] } }, "com.amazonaws.rds#DeleteDBSecurityGroupMessage": { @@ -10283,7 +11501,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteDBSnapshot": { @@ -10303,7 +11522,44 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes a DB snapshot. If the snapshot is being copied, the copy operation is\n terminated.

    \n \n

    The DB snapshot must be in the available state to be deleted.

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

    Deletes a DB snapshot. If the snapshot is being copied, the copy operation is\n terminated.

    \n \n

    The DB snapshot must be in the available state to be deleted.

    \n     ", + "smithy.api#examples": [ + { + "title": "To delete a DB snapshot", + "documentation": "The following example deletes the specified DB snapshot.", + "input": { + "DBSnapshotIdentifier": "mydbsnapshot" + }, + "output": { + "DBSnapshot": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBInstanceIdentifier": "database-mysql", + "SnapshotCreateTime": "2019-06-18T22:08:40.702Z", + "Engine": "mysql", + "AllocatedStorage": 100, + "Status": "deleted", + "Port": 3306, + "AvailabilityZone": "us-east-1b", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2019-04-30T15:45:53.663Z", + "MasterUsername": "admin", + "EngineVersion": "5.6.40", + "LicenseModel": "general-public-license", + "SnapshotType": "manual", + "Iops": 1000, + "OptionGroupName": "default:mysql-5-6", + "PercentProgress": 100, + "StorageType": "io1", + "Encrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" + } + } + } + ] } }, "com.amazonaws.rds#DeleteDBSnapshotMessage": { @@ -10318,7 +11574,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteDBSnapshotResult": { @@ -10352,7 +11609,16 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes a DB subnet group.

    \n \n

    The specified database subnet group must not be associated with any DB instances.

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

    Deletes a DB subnet group.

    \n \n

    The specified database subnet group must not be associated with any DB instances.

    \n     ", + "smithy.api#examples": [ + { + "title": "To delete a DB subnet group", + "documentation": "The following example deletes the DB subnet group called mysubnetgroup.", + "input": { + "DBSubnetGroupName": "mysubnetgroup" + } + } + ] } }, "com.amazonaws.rds#DeleteDBSubnetGroupMessage": { @@ -10367,7 +11633,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteEventSubscription": { @@ -10387,7 +11654,35 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes an RDS event notification subscription.

    " + "smithy.api#documentation": "

    Deletes an RDS event notification subscription.

    ", + "smithy.api#examples": [ + { + "title": "To delete an event subscription", + "documentation": "The following example deletes the specified event subscription.", + "input": { + "SubscriptionName": "my-instance-events" + }, + "output": { + "EventSubscription": { + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "CustomerAwsId": "123456789012", + "Enabled": false, + "SourceIdsList": [ + "test-instance" + ], + "SourceType": "db-instance", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "SubscriptionCreationTime": "2018-07-31 23:22:01.893", + "CustSubscriptionId": "my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "Status": "deleting" + } + } + } + ] } }, "com.amazonaws.rds#DeleteEventSubscriptionMessage": { @@ -10402,7 +11697,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteEventSubscriptionResult": { @@ -10433,7 +11729,29 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes a global database cluster. The primary and secondary clusters must already be detached or\n destroyed first.

    \n \n

    This action only applies to Aurora DB clusters.

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

    Deletes a global database cluster. The primary and secondary clusters must already be detached or\n destroyed first.

    \n \n

    This action only applies to Aurora DB clusters.

    \n     ", + "smithy.api#examples": [ + { + "title": "To delete a global DB cluster", + "documentation": "The following example deletes an Aurora MySQL-compatible global DB cluster.", + "input": { + "GlobalClusterIdentifier": "myglobalcluster" + }, + "output": { + "GlobalCluster": { + "GlobalClusterIdentifier": "myglobalcluster", + "GlobalClusterResourceId": "cluster-f0e523bfe07aabb", + "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", + "Status": "available", + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.07.2", + "StorageEncrypted": false, + "DeletionProtection": false, + "GlobalClusterMembers": [] + } + } + } + ] } }, "com.amazonaws.rds#DeleteGlobalClusterMessage": { @@ -10446,6 +11764,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DeleteGlobalClusterResult": { @@ -10476,7 +11797,16 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes an existing option group.

    " + "smithy.api#documentation": "

    Deletes an existing option group.

    ", + "smithy.api#examples": [ + { + "title": "To delete an option group", + "documentation": "The following example deletes the specified option group.", + "input": { + "OptionGroupName": "myoptiongroup" + } + } + ] } }, "com.amazonaws.rds#DeleteOptionGroupMessage": { @@ -10491,7 +11821,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DeregisterDBProxyTargets": { @@ -10569,14 +11900,100 @@ "target": "com.amazonaws.rds#AccountAttributesMessage" }, "traits": { - "smithy.api#documentation": "

    Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

    \n

    This command doesn't take any parameters.

    " + "smithy.api#documentation": "

    Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

    \n

    This command doesn't take any parameters.

    ", + "smithy.api#examples": [ + { + "title": "To describe account attributes", + "documentation": "The following example retrieves the attributes for the current AWS account.", + "output": { + "AccountQuotas": [ + { + "Max": 40, + "Used": 4, + "AccountQuotaName": "DBInstances" + }, + { + "Max": 40, + "Used": 0, + "AccountQuotaName": "ReservedDBInstances" + }, + { + "Max": 100000, + "Used": 40, + "AccountQuotaName": "AllocatedStorage" + }, + { + "Max": 25, + "Used": 0, + "AccountQuotaName": "DBSecurityGroups" + }, + { + "Max": 20, + "Used": 0, + "AccountQuotaName": "AuthorizationsPerDBSecurityGroup" + }, + { + "Max": 50, + "Used": 1, + "AccountQuotaName": "DBParameterGroups" + }, + { + "Max": 100, + "Used": 3, + "AccountQuotaName": "ManualSnapshots" + }, + { + "Max": 20, + "Used": 0, + "AccountQuotaName": "EventSubscriptions" + }, + { + "Max": 50, + "Used": 1, + "AccountQuotaName": "DBSubnetGroups" + }, + { + "Max": 20, + "Used": 1, + "AccountQuotaName": "OptionGroups" + }, + { + "Max": 20, + "Used": 6, + "AccountQuotaName": "SubnetsPerDBSubnetGroup" + }, + { + "Max": 5, + "Used": 0, + "AccountQuotaName": "ReadReplicasPerMaster" + }, + { + "Max": 40, + "Used": 1, + "AccountQuotaName": "DBClusters" + }, + { + "Max": 50, + "Used": 0, + "AccountQuotaName": "DBClusterParameterGroups" + }, + { + "Max": 5, + "Used": 0, + "AccountQuotaName": "DBClusterRoles" + } + ] + } + } + ] } }, "com.amazonaws.rds#DescribeAccountAttributesMessage": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeBlueGreenDeployments": { @@ -10706,7 +12123,63 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBClusterAutomatedBackups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterAutomatedBackupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

    Displays backups for both current and deleted DB clusters. For example, use this operation to find details \n about automated backups for previously deleted clusters. Current clusters are returned for both the \n DescribeDBClusterAutomatedBackups and DescribeDBClusters operations.

    \n

    All parameters are optional.

    " + } + }, + "com.amazonaws.rds#DescribeDBClusterAutomatedBackupsMessage": { + "type": "structure", + "members": { + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

    The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.

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

    (Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must\n match the identifier of an existing DB cluster. It returns information from the\n specific DB cluster's automated backup. This parameter isn't case-sensitive.

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

    A filter that specifies which resources to return based on status.

    \n

    Supported filters are the following:

    \n
      \n
    • \n

      \n status\n

      \n
        \n
      • \n

        \n retained - Automated backups for deleted clusters and after backup replication is stopped.

        \n
        • \n
      \n
      • \n
    • \n

      \n db-cluster-id - Accepts DB cluster identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB cluster automated backups identified by these ARNs.

      \n
      • \n
    • \n

      \n db-cluster-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB cluster resources identified by these ARNs.

      \n
      • \n
    \n

    Returns all resources by default. The status for each resource is specified in the response.

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

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords \n value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

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

    The pagination token provided in the previous request. If this parameter is specified the response includes only \n records beyond the marker, up to MaxRecords.

    " + } + } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBClusterBacktracks": { @@ -10727,6 +12200,35 @@ ], "traits": { "smithy.api#documentation": "

    Returns information about backtracks for a DB cluster.

    \n

    For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n \n

    This action only applies to Aurora MySQL DB clusters.

    \n     ", + "smithy.api#examples": [ + { + "title": "To describe backtracks for a DB cluster", + "documentation": "The following example retrieves details about the specified DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster" + }, + "output": { + "DBClusterBacktracks": [ + { + "DBClusterIdentifier": "mydbcluster", + "BacktrackIdentifier": "2f5f5294-0dd2-44c9-9f50-EXAMPLE", + "BacktrackTo": "2021-02-12T04:59:22Z", + "BacktrackedFrom": "2021-02-12T14:37:31.640Z", + "BacktrackRequestCreationTime": "2021-02-12T14:36:18.819Z", + "Status": "COMPLETED" + }, + { + "DBClusterIdentifier": "mydbcluster", + "BacktrackIdentifier": "3c7a6421-af2a-4ea3-ae95-EXAMPLE", + "BacktrackTo": "2021-02-11T22:53:46Z", + "BacktrackedFrom": "2021-02-12T00:09:27.006Z", + "BacktrackRequestCreationTime": "2021-02-12T00:07:53.487Z", + "Status": "COMPLETED" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -10771,7 +12273,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBClusterEndpoints": { @@ -10789,6 +12292,40 @@ ], "traits": { "smithy.api#documentation": "

    Returns information about endpoints for an Amazon Aurora DB cluster.

    \n \n

    This action only applies to Aurora DB clusters.

    \n     ", + "smithy.api#examples": [ + { + "title": "To describe DB cluster endpoints", + "documentation": "The following example retrieves details for your DB cluster endpoints. The most common kinds of Aurora clusters have two endpoints. One endpoint has type WRITER. You can use this endpoint for all SQL statements. The other endpoint has type READER. You can use this endpoint only for SELECT and other read-only SQL statements.", + "output": { + "DBClusterEndpoints": [ + { + "DBClusterIdentifier": "my-database-1", + "Endpoint": "my-database-1.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "creating", + "EndpointType": "WRITER" + }, + { + "DBClusterIdentifier": "my-database-1", + "Endpoint": "my-database-1.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "creating", + "EndpointType": "READER" + }, + { + "DBClusterIdentifier": "mydbcluster", + "Endpoint": "mydbcluster.cluster-cnpexamle.us-east-1.rds.amazonaws.com", + "Status": "available", + "EndpointType": "WRITER" + }, + { + "DBClusterIdentifier": "mydbcluster", + "Endpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "available", + "EndpointType": "READER" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -10830,6 +12367,9 @@ "smithy.api#documentation": "

    An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBClusterParameterGroups": { @@ -10847,6 +12387,46 @@ ], "traits": { "smithy.api#documentation": "

    Returns a list of DBClusterParameterGroup descriptions. If a \n DBClusterParameterGroupName parameter is specified,\n the list will contain only the description of the specified DB cluster parameter group.

    \n

    For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    ", + "smithy.api#examples": [ + { + "title": "To describe DB cluster parameter groups", + "documentation": "The following example retrieves details for your DB cluster parameter groups.", + "output": { + "DBClusterParameterGroups": [ + { + "DBClusterParameterGroupName": "default.aurora-mysql5.7", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Default cluster parameter group for aurora-mysql5.7", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-mysql5.7" + }, + { + "DBClusterParameterGroupName": "default.aurora-postgresql9.6", + "DBParameterGroupFamily": "aurora-postgresql9.6", + "Description": "Default cluster parameter group for aurora-postgresql9.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-postgresql9.6" + }, + { + "DBClusterParameterGroupName": "default.aurora5.6", + "DBParameterGroupFamily": "aurora5.6", + "Description": "Default cluster parameter group for aurora5.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora5.6" + }, + { + "DBClusterParameterGroupName": "mydbclusterpg", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "My DB cluster parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpg" + }, + { + "DBClusterParameterGroupName": "mydbclusterpgcopy", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Copy of mydbclusterpg parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -10884,7 +12464,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBClusterParameters": { @@ -10902,6 +12483,46 @@ ], "traits": { "smithy.api#documentation": "

    Returns the detailed parameter list for a particular DB cluster parameter group.

    \n

    For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    ", + "smithy.api#examples": [ + { + "title": "To describe the parameters in a DB cluster parameter group", + "documentation": "The following example retrieves details about the parameters in a DB cluster parameter group.", + "input": { + "DBClusterParameterGroupName": "mydbclusterpg" + }, + "output": { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot", + "SupportedEngineModes": [ + "provisioned" + ] + }, + { + "ParameterName": "aurora_lab_mode", + "ParameterValue": "0", + "Description": "Enables new features in the Aurora engine.", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": true, + "ApplyMethod": "pending-reboot", + "SupportedEngineModes": [ + "provisioned" + ] + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -10946,7 +12567,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBClusterSnapshotAttributes": { @@ -10963,7 +12585,29 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

    \n

    When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB cluster snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.

    \n

    To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the\n manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

    " + "smithy.api#documentation": "

    Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

    \n

    When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB cluster snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.

    \n

    To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the\n manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

    ", + "smithy.api#examples": [ + { + "title": "To describe the attribute names and values for a DB cluster snapshot", + "documentation": "The following example retrieves details of the attribute names and values for the specified DB cluster snapshot.", + "input": { + "DBClusterSnapshotIdentifier": "myclustersnapshot" + }, + "output": { + "DBClusterSnapshotAttributesResult": { + "DBClusterSnapshotIdentifier": "myclustersnapshot", + "DBClusterSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "123456789012" + ] + } + ] + } + } + } + ] } }, "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesMessage": { @@ -10978,7 +12622,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesResult": { @@ -11007,6 +12652,69 @@ ], "traits": { "smithy.api#documentation": "

    Returns information about DB cluster snapshots. This API action supports pagination.

    \n

    For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    ", + "smithy.api#examples": [ + { + "title": "To describe a DB cluster snapshot for a DB cluster", + "documentation": "The following example retrieves the details for the DB cluster snapshots for the specified DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster" + }, + "output": { + "DBClusterSnapshots": [ + { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "myclustersnapshotcopy", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-04T09:16:42.649Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:814387698303:cluster-snapshot:myclustersnapshotcopy", + "IAMDatabaseAuthenticationEnabled": false + }, + { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "rds:mydbcluster-2019-06-20-09-16", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-20T09:16:26.569Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "automated", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:mydbcluster-2019-06-20-09-16", + "IAMDatabaseAuthenticationEnabled": false + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11195,10 +12903,17 @@ "smithy.api#default": false, "smithy.api#documentation": "

    A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

    \n

    You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

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

    A specific DB cluster resource ID to describe.

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

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBClusters": { @@ -11216,6 +12931,100 @@ ], "traits": { "smithy.api#documentation": "

    Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

    \n

    For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    \n

    This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

    ", + "smithy.api#examples": [ + { + "title": "To describe a DB cluster", + "documentation": "The following example retrieves the details of the specified DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster" + }, + "output": { + "DBClusters": [ + { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "BackupRetentionPeriod": 1, + "DatabaseName": "mydbcluster", + "DBClusterIdentifier": "mydbcluster", + "DBClusterParameterGroup": "default.aurora-mysql5.7", + "DBSubnetGroup": "default", + "Status": "available", + "EarliestRestorableTime": "2019-06-19T09:16:28.210Z", + "Endpoint": "mydbcluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "ReaderEndpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "MultiAZ": true, + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LatestRestorableTime": "2019-06-20T22:38:14.908Z", + "Port": 3306, + "MasterUsername": "myadmin", + "PreferredBackupWindow": "09:09-09:39", + "PreferredMaintenanceWindow": "sat:04:09-sat:04:39", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [ + { + "DBInstanceIdentifier": "dbinstance3", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "dbinstance1", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "dbinstance2", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster-us-east-1b", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster", + "IsClusterWriter": true, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + } + ], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-0b9130572daf3dc16", + "Status": "active" + } + ], + "HostedZoneId": "Z2R2ITUGPM61AM", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", + "DbClusterResourceId": "cluster-AKIAIOSFODNN7EXAMPLE", + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:mydbcluster", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11388,7 +13197,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBEngineVersions": { @@ -11401,6 +13211,42 @@ }, "traits": { "smithy.api#documentation": "

    Returns a list of the available DB engines.

    ", + "smithy.api#examples": [ + { + "title": "To describe the DB engine versions for the MySQL DB engine", + "documentation": "The following example displays details about each of the DB engine versions for the specified DB engine.", + "input": { + "Engine": "mysql" + }, + "output": { + "DBEngineVersions": [ + { + "Engine": "mysql", + "EngineVersion": "5.7.33", + "DBParameterGroupFamily": "mysql5.7", + "DBEngineDescription": "MySQL Community Edition", + "DBEngineVersionDescription": "MySQL 5.7.33", + "ValidUpgradeTarget": [ + { + "Engine": "mysql", + "EngineVersion": "5.7.34", + "Description": "MySQL 5.7.34", + "AutoUpgrade": false, + "IsMajorVersionUpgrade": false + }, + { + "Engine": "mysql", + "EngineVersion": "5.7.36", + "Description": "MySQL 5.7.36", + "AutoUpgrade": false, + "IsMajorVersionUpgrade": false + } + ] + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11473,6 +13319,9 @@ "smithy.api#documentation": "

    A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBInstanceAutomatedBackups": { @@ -11490,6 +13339,43 @@ ], "traits": { "smithy.api#documentation": "

    Displays backups for both current and deleted\n instances. For example, use this operation to\n find details about automated backups for previously deleted instances. Current instances\n with retention periods greater than zero (0) are returned for both the \n DescribeDBInstanceAutomatedBackups and\n DescribeDBInstances operations.

    \n

    All parameters are optional.

    ", + "smithy.api#examples": [ + { + "title": "To describe the automated backups for a DB instance", + "documentation": "The following example displays details about the automated backups for the specified DB instance. The details include replicated automated backups in other AWS Regions.", + "input": { + "DBInstanceIdentifier": "new-orcl-db" + }, + "output": { + "DBInstanceAutomatedBackups": [ + { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", + "Region": "us-east-1", + "DBInstanceIdentifier": "new-orcl-db", + "RestoreWindow": { + "EarliestTime": "2020-12-07T21:05:20.939Z", + "LatestTime": "2020-12-07T21:05:20.939Z" + }, + "AllocatedStorage": 20, + "Status": "replicating", + "Port": 1521, + "InstanceCreateTime": "2020-12-04T15:28:31Z", + "MasterUsername": "admin", + "Engine": "oracle-se2", + "EngineVersion": "12.1.0.2.v21", + "LicenseModel": "bring-your-own-license", + "OptionGroupName": "default:oracle-se2-12-1", + "Encrypted": false, + "StorageType": "gp2", + "IAMDatabaseAuthenticationEnabled": false, + "BackupRetentionPeriod": 14, + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11510,13 +13396,13 @@ "DBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    (Optional) The user-supplied instance identifier. If this parameter is specified, it must\n match the identifier of an existing DB instance. It returns information from the\n specific DB instance' automated backup. This parameter isn't case-sensitive.

    " + "smithy.api#documentation": "

    (Optional) The user-supplied instance identifier. If this parameter is specified, it must\n match the identifier of an existing DB instance. It returns information from the\n specific DB instance's automated backup. This parameter isn't case-sensitive.

    " } }, "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "

    A filter that specifies which resources to return based on status.

    \n

    Supported filters are the following:

    \n
      \n
    • \n

      \n status\n

      \n
        \n
      • \n

        \n active - automated backups for current instances

        \n
        • \n
      • \n

        \n retained - automated backups for deleted instances and after backup replication is stopped

        \n
        • \n
      • \n

        \n creating - automated backups that are waiting for the first automated snapshot to be available

        \n
        • \n
      \n
      • \n
    • \n

      \n db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB instance automated backups identified by these ARNs.

      \n
      • \n
    • \n

      \n dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB instance resources identified by these ARNs.

      \n
      • \n
    \n

    Returns all resources by default. The status for each resource is specified in the response.

    " + "smithy.api#documentation": "

    A filter that specifies which resources to return based on status.

    \n

    Supported filters are the following:

    \n
      \n
    • \n

      \n status\n

      \n
        \n
      • \n

        \n active - Automated backups for current instances.

        \n
        • \n
      • \n

        \n creating - Automated backups that are waiting for the first automated snapshot to be available.

        \n
        • \n
      • \n

        \n retained - Automated backups for deleted instances and after backup replication is stopped.

        \n
        • \n
      \n
      • \n
    • \n

      \n db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB instance automated backups identified by these ARNs.

      \n
      • \n
    • \n

      \n dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB instance resources identified by these ARNs.

      \n
      • \n
    \n

    Returns all resources by default. The status for each resource is specified in the response.

    " } }, "MaxRecords": { @@ -11539,7 +13425,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Parameter input for DescribeDBInstanceAutomatedBackups.

    " + "smithy.api#documentation": "

    Parameter input for DescribeDBInstanceAutomatedBackups.

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBInstances": { @@ -11557,6 +13444,31 @@ ], "traits": { "smithy.api#documentation": "

    Describes provisioned RDS instances. This API supports pagination.

    \n \n

    This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

    \n     ", + "smithy.api#examples": [ + { + "title": "To describe a DB instance", + "documentation": "The following example retrieves details about the specified DB instance.", + "input": { + "DBInstanceIdentifier": "mydbinstancecf" + }, + "output": { + "DBInstances": [ + { + "DBInstanceIdentifier": "mydbinstancecf", + "DBInstanceClass": "db.t3.small", + "Engine": "mysql", + "DBInstanceStatus": "available", + "MasterUsername": "admin", + "Endpoint": { + "Address": "mydbinstancecf.abcexample.us-east-1.rds.amazonaws.com", + "Port": 3306, + "HostedZoneId": "Z2R2ITUGPM61AM" + } + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11725,7 +13637,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBLogFiles": { @@ -11743,6 +13656,49 @@ ], "traits": { "smithy.api#documentation": "

    Returns a list of DB log files for the DB instance.

    \n

    This command doesn't apply to RDS Custom.

    ", + "smithy.api#examples": [ + { + "title": "To describe the log files for a DB instance", + "documentation": "The following example retrieves details about the log files for the specified DB instance.", + "input": { + "DBInstanceIdentifier": "test-instance" + }, + "output": { + "DescribeDBLogFiles": [ + { + "Size": 0, + "LastWritten": 1533060000000, + "LogFileName": "error/mysql-error-running.log" + }, + { + "Size": 2683, + "LastWritten": 1532994300000, + "LogFileName": "error/mysql-error-running.log.0" + }, + { + "Size": 107, + "LastWritten": 1533057300000, + "LogFileName": "error/mysql-error-running.log.18" + }, + { + "Size": 13105, + "LastWritten": 1532991000000, + "LogFileName": "error/mysql-error-running.log.23" + }, + { + "Size": 0, + "LastWritten": 1533061200000, + "LogFileName": "error/mysql-error.log" + }, + { + "Size": 3519, + "LastWritten": 1532989252000, + "LogFileName": "mysqlUpgrade" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11838,7 +13794,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBLogFilesResponse": { @@ -11877,6 +13834,40 @@ ], "traits": { "smithy.api#documentation": "

    Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified,\n the list will contain only the description of the specified DB parameter group.

    ", + "smithy.api#examples": [ + { + "title": "To describe your DB parameter groups", + "documentation": "The following example retrieves details about your DB parameter groups.", + "output": { + "DBParameterGroups": [ + { + "DBParameterGroupName": "default.aurora-mysql5.7", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Default parameter group for aurora-mysql5.7", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora-mysql5.7" + }, + { + "DBParameterGroupName": "default.aurora-postgresql9.6", + "DBParameterGroupFamily": "aurora-postgresql9.6", + "Description": "Default parameter group for aurora-postgresql9.6", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora-postgresql9.6" + }, + { + "DBParameterGroupName": "default.aurora5.6", + "DBParameterGroupFamily": "aurora5.6", + "Description": "Default parameter group for aurora5.6", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora5.6" + }, + { + "DBParameterGroupName": "default.mariadb10.1", + "DBParameterGroupFamily": "mariadb10.1", + "Description": "Default parameter group for mariadb10.1", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.mariadb10.1" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11914,7 +13905,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBParameters": { @@ -11932,6 +13924,39 @@ ], "traits": { "smithy.api#documentation": "

    Returns the detailed parameter list for a particular DB parameter group.

    ", + "smithy.api#examples": [ + { + "title": "To describe the parameters in a DB parameter group", + "documentation": "The following example retrieves the details of the specified DB parameter group.", + "input": { + "DBParameterGroupName": "mydbpg" + }, + "output": { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot" + }, + { + "ParameterName": "auto_generate_certs", + "Description": "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11974,6 +13999,9 @@ "smithy.api#documentation": "

    An optional pagination token provided by a previous\n DescribeDBParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBProxies": { @@ -12329,6 +14357,16 @@ ], "traits": { "smithy.api#documentation": "

    Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified,\n the list will contain only the descriptions of the specified DB security group.

    \n \n

    EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

    \n     ", + "smithy.api#examples": [ + { + "title": "To list DB security group settings", + "documentation": "This example lists settings for the specified security group.", + "input": { + "DBSecurityGroupName": "mydbsecuritygroup" + }, + "output": {} + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -12366,7 +14404,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBSnapshotAttributes": { @@ -12383,7 +14422,30 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

    \n

    When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.

    \n

    To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the\n manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

    " + "smithy.api#documentation": "

    Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

    \n

    When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.

    \n

    To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the\n manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

    ", + "smithy.api#examples": [ + { + "title": "To describe the attribute names and values for a DB snapshot", + "documentation": "The following example describes the attribute names and values for a DB snapshot.", + "input": { + "DBSnapshotIdentifier": "mydbsnapshot" + }, + "output": { + "DBSnapshotAttributesResult": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "123456789012", + "210987654321" + ] + } + ] + } + } + } + ] } }, "com.amazonaws.rds#DescribeDBSnapshotAttributesMessage": { @@ -12398,7 +14460,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBSnapshotAttributesResult": { @@ -12427,6 +14490,43 @@ ], "traits": { "smithy.api#documentation": "

    Returns information about DB snapshots. This API action supports pagination.

    ", + "smithy.api#examples": [ + { + "title": "To describe a DB snapshot for a DB instance", + "documentation": "The following example retrieves the details of a DB snapshot for a DB instance.", + "input": { + "DBSnapshotIdentifier": "mydbsnapshot" + }, + "output": { + "DBSnapshots": [ + { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBInstanceIdentifier": "mysqldb", + "SnapshotCreateTime": "2018-02-08T22:28:08.598Z", + "Engine": "mysql", + "AllocatedStorage": 20, + "Status": "available", + "Port": 3306, + "AvailabilityZone": "us-east-1f", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2018-02-08T22:24:55.973Z", + "MasterUsername": "mysqladmin", + "EngineVersion": "5.6.37", + "LicenseModel": "general-public-license", + "SnapshotType": "manual", + "OptionGroupName": "default:mysql-5-6", + "PercentProgress": 100, + "StorageType": "gp2", + "Encrypted": false, + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -12627,7 +14727,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeDBSubnetGroups": { @@ -12645,6 +14746,53 @@ ], "traits": { "smithy.api#documentation": "

    Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

    \n

    For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

    ", + "smithy.api#examples": [ + { + "title": "To describe a DB subnet group", + "documentation": "The following example retrieves the details of the specified DB subnet group.", + "output": { + "DBSubnetGroups": [ + { + "DBSubnetGroupName": "mydbsubnetgroup", + "DBSubnetGroupDescription": "My DB Subnet Group", + "VpcId": "vpc-971c12ee", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-d8c8e7f4", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-718fdc7d", + "SubnetAvailabilityZone": { + "Name": "us-east-1f" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-cbc8e7e7", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-0ccde220", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + } + ], + "DBSubnetGroupArn": "arn:aws:rds:us-east-1:123456789012:subgrp:mydbsubnetgroup" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -12682,7 +14830,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeEngineDefaultClusterParameters": { @@ -12694,7 +14843,33 @@ "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParametersResult" }, "traits": { - "smithy.api#documentation": "

    Returns the default engine and system parameter information for the cluster database engine.

    \n

    For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    " + "smithy.api#documentation": "

    Returns the default engine and system parameter information for the cluster database engine.

    \n

    For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    ", + "smithy.api#examples": [ + { + "title": "To describe the default engine and system parameter information for the Aurora database engine", + "documentation": "The following example retrieves the details of the default engine and system parameter information for Aurora DB clusters with MySQL 5.7 compatibility.", + "input": { + "DBParameterGroupFamily": "aurora-mysql5.7" + }, + "output": { + "EngineDefaults": { + "Parameters": [ + { + "ParameterName": "aurora_load_from_s3_role", + "Description": "IAM role ARN used to load data from AWS S3", + "Source": "engine-default", + "ApplyType": "dynamic", + "DataType": "string", + "IsModifiable": true, + "SupportedEngineModes": [ + "provisioned" + ] + } + ] + } + } + } + ] } }, "com.amazonaws.rds#DescribeEngineDefaultClusterParametersMessage": { @@ -12727,7 +14902,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeEngineDefaultClusterParametersResult": { @@ -12751,6 +14927,30 @@ }, "traits": { "smithy.api#documentation": "

    Returns the default engine and system parameter information for the specified database engine.

    ", + "smithy.api#examples": [ + { + "title": "To describe the default engine and system parameter information for the database engine", + "documentation": "The following example retrieves details for the default engine and system parameter information for MySQL 5.7 DB instances.", + "input": { + "DBParameterGroupFamily": "mysql5.7" + }, + "output": { + "EngineDefaults": { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false + } + ] + } + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "EngineDefaults.Marker", @@ -12789,7 +14989,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeEngineDefaultParametersResult": { @@ -12812,7 +15013,76 @@ "target": "com.amazonaws.rds#EventCategoriesMessage" }, "traits": { - "smithy.api#documentation": "

    Displays a list of categories for all event source types, or, if specified, for a specified source type.\n You can also see this list in the \"Amazon RDS event categories and event messages\" section of the \n Amazon RDS User Guide\n or the\n \n Amazon Aurora User Guide\n .

    " + "smithy.api#documentation": "

    Displays a list of categories for all event source types, or, if specified, for a specified source type.\n You can also see this list in the \"Amazon RDS event categories and event messages\" section of the \n Amazon RDS User Guide\n or the\n \n Amazon Aurora User Guide\n .

    ", + "smithy.api#examples": [ + { + "title": "To describe event categories", + "documentation": "The following example retrieves details about the event categories for all available event sources.", + "input": { + "SourceType": "", + "Filters": [] + }, + "output": { + "EventCategoriesMapList": [ + { + "SourceType": "db-instance", + "EventCategories": [ + "deletion", + "read replica", + "failover", + "restoration", + "maintenance", + "low storage", + "configuration change", + "backup", + "creation", + "availability", + "recovery", + "failure", + "backtrack", + "notification" + ] + }, + { + "SourceType": "db-security-group", + "EventCategories": [ + "configuration change", + "failure" + ] + }, + { + "SourceType": "db-parameter-group", + "EventCategories": [ + "configuration change" + ] + }, + { + "SourceType": "db-snapshot", + "EventCategories": [ + "deletion", + "creation", + "restoration", + "notification" + ] + }, + { + "SourceType": "db-cluster", + "EventCategories": [ + "failover", + "failure", + "notification" + ] + }, + { + "SourceType": "db-cluster-snapshot", + "EventCategories": [ + "backup" + ] + } + ] + } + } + ] } }, "com.amazonaws.rds#DescribeEventCategoriesMessage": { @@ -12832,7 +15102,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeEventSubscriptions": { @@ -12850,6 +15121,30 @@ ], "traits": { "smithy.api#documentation": "

    Lists all the subscription descriptions for a customer account. The description for a subscription includes \n SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

    \n

    If you specify a SubscriptionName, lists the description for that subscription.

    ", + "smithy.api#examples": [ + { + "title": "To describe event subscriptions", + "documentation": "This example describes all of the Amazon RDS event subscriptions for the current AWS account.", + "output": { + "EventSubscriptionsList": [ + { + "EventCategoriesList": [ + "backup", + "recovery" + ], + "Enabled": true, + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "Status": "creating", + "SourceType": "db-instance", + "CustomerAwsId": "123456789012", + "SubscriptionCreationTime": "2018-07-31 23:22:01.893", + "CustSubscriptionId": "my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -12887,7 +15182,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeEvents": { @@ -12900,6 +15196,40 @@ }, "traits": { "smithy.api#documentation": "

    Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. \n Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be \n obtained by providing the name as a parameter.

    \n

    For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora\n events in the Amazon Aurora User Guide.

    \n \n

    By default, RDS returns events that were generated in the past hour.

    \n     ", + "smithy.api#examples": [ + { + "title": "To describe events", + "documentation": "The following retrieves details for the events that have occurred for the specified DB instance.", + "input": { + "SourceIdentifier": "test-instance", + "SourceType": "db-instance" + }, + "output": { + "Events": [ + { + "SourceType": "db-instance", + "SourceIdentifier": "test-instance", + "EventCategories": [ + "backup" + ], + "Message": "Backing up DB instance", + "Date": "2018-07-31T23:09:23.983Z", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance" + }, + { + "SourceType": "db-instance", + "SourceIdentifier": "test-instance", + "EventCategories": [ + "backup" + ], + "Message": "Finished DB Instance backup", + "Date": "2018-07-31T23:15:13.049Z", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -12967,7 +15297,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeExportTasks": { @@ -12985,6 +15316,42 @@ ], "traits": { "smithy.api#documentation": "

    Returns information about a snapshot or cluster export to Amazon S3. This API operation supports\n pagination.

    ", + "smithy.api#examples": [ + { + "title": "To describe snapshot export tasks", + "documentation": "The following example returns information about snapshot exports to Amazon S3.", + "output": { + "ExportTasks": [ + { + "ExportTaskIdentifier": "test-snapshot-export", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:test-snapshot", + "SnapshotTime": "2020-03-02T18:26:28.163Z", + "TaskStartTime": "2020-03-02T18:57:56.896Z", + "TaskEndTime": "2020-03-02T19:10:31.985Z", + "S3Bucket": "mybucket", + "S3Prefix": "", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", + "Status": "COMPLETE", + "PercentProgress": 100, + "TotalExtractedDataInGB": 0 + }, + { + "ExportTaskIdentifier": "my-s3-export", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test", + "SnapshotTime": "2020-03-27T20:48:42.023Z", + "S3Bucket": "mybucket", + "S3Prefix": "", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", + "Status": "STARTING", + "PercentProgress": 0, + "TotalExtractedDataInGB": 0 + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13032,6 +15399,9 @@ "smithy.api#documentation": "

    The type of source for the export.

    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeGlobalClusters": { @@ -13049,6 +15419,27 @@ ], "traits": { "smithy.api#documentation": "

    Returns information about Aurora global database clusters. This API supports pagination.

    \n

    For more information on Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.

    \n \n

    This action only applies to Aurora DB clusters.

    \n     ", + "smithy.api#examples": [ + { + "title": "To describe global DB clusters", + "documentation": "The following example lists Aurora global DB clusters in the current AWS Region.", + "output": { + "GlobalClusters": [ + { + "GlobalClusterIdentifier": "myglobalcluster", + "GlobalClusterResourceId": "cluster-f5982077e3b5aabb", + "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", + "Status": "available", + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.07.2", + "StorageEncrypted": false, + "DeletionProtection": false, + "GlobalClusterMembers": [] + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13084,6 +15475,9 @@ "smithy.api#documentation": "

    An optional pagination token provided by a previous DescribeGlobalClusters request. If\n this parameter is specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords.

    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeOptionGroupOptions": { @@ -13096,6 +15490,52 @@ }, "traits": { "smithy.api#documentation": "

    Describes all available options.

    ", + "smithy.api#examples": [ + { + "title": "To describe all available options", + "documentation": "The following example lists the options for an RDS for MySQL version 8.0 DB instance.", + "input": { + "EngineName": "mysql", + "MajorEngineVersion": "8.0" + }, + "output": { + "OptionGroupOptions": [ + { + "Name": "MARIADB_AUDIT_PLUGIN", + "Description": "MariaDB Audit Plugin", + "EngineName": "mysql", + "MajorEngineVersion": "8.0", + "MinimumRequiredMinorEngineVersion": "25", + "PortRequired": false, + "OptionsDependedOn": [], + "OptionsConflictsWith": [], + "Persistent": false, + "Permanent": false, + "RequiresAutoMinorEngineVersionUpgrade": false, + "VpcOnly": false, + "OptionGroupOptionSettings": [ + { + "SettingName": "SERVER_AUDIT_INCL_USERS", + "SettingDescription": "Include specified users", + "ApplyType": "DYNAMIC", + "IsModifiable": true, + "IsRequired": false, + "MinimumEngineVersionPerAllowedValue": [] + }, + { + "SettingName": "SERVER_AUDIT_EXCL_USERS", + "SettingDescription": "Exclude specified users", + "ApplyType": "DYNAMIC", + "IsModifiable": true, + "IsRequired": false, + "MinimumEngineVersionPerAllowedValue": [] + } + ] + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13140,7 +15580,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeOptionGroups": { @@ -13158,6 +15599,29 @@ ], "traits": { "smithy.api#documentation": "

    Describes the available option groups.

    ", + "smithy.api#examples": [ + { + "title": "To describe the available option groups", + "documentation": "The following example lists the options groups for an Oracle Database 19c instance.", + "input": { + "EngineName": "oracle-ee", + "MajorEngineVersion": "19" + }, + "output": { + "OptionGroupsList": [ + { + "OptionGroupName": "default:oracle-ee-19", + "OptionGroupDescription": "Default option group for oracle-ee 19", + "EngineName": "oracle-ee", + "MajorEngineVersion": "19", + "Options": [], + "AllowsVpcAndNonVpcInstanceMemberships": true, + "OptionGroupArn": "arn:aws:rds:us-west-1:111122223333:og:default:oracle-ee-19" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13207,7 +15671,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeOrderableDBInstanceOptions": { @@ -13220,6 +15685,50 @@ }, "traits": { "smithy.api#documentation": "

    Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.

    ", + "smithy.api#examples": [ + { + "title": "To describe orderable DB instance options", + "documentation": "The following example retrieves details about the orderable options for a DB instances running the MySQL DB engine.", + "input": { + "Engine": "mysql" + }, + "output": { + "OrderableDBInstanceOptions": [ + { + "Engine": "mysql", + "EngineVersion": "5.7.33", + "DBInstanceClass": "db.m4.10xlarge", + "LicenseModel": "general-public-license", + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + }, + { + "Name": "us-east-1e" + }, + { + "Name": "us-east-1f" + } + ], + "MultiAZCapable": true, + "ReadReplicaCapable": true, + "Vpc": true, + "SupportsStorageEncryption": true, + "StorageType": "gp2" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13288,7 +15797,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribePendingMaintenanceActions": { @@ -13306,6 +15816,25 @@ ], "traits": { "smithy.api#documentation": "

    Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

    ", + "smithy.api#examples": [ + { + "title": "To list resources with at least one pending maintenance action", + "documentation": "The following example lists the pending maintenace action for a DB instance.", + "output": { + "PendingMaintenanceActions": [ + { + "ResourceIdentifier": "arn:aws:rds:us-west-2:123456789012:cluster:global-db1-cl1", + "PendingMaintenanceActionDetails": [ + { + "Action": "system-update", + "Description": "Upgrade to Aurora PostgreSQL 2.4.2" + } + ] + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13343,7 +15872,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeReservedDBInstances": { @@ -13361,6 +15891,39 @@ ], "traits": { "smithy.api#documentation": "

    Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

    ", + "smithy.api#examples": [ + { + "title": "To describe reserved DB instances", + "documentation": "The following example retrieves details about any reserved DB instances in the current AWS account.", + "output": { + "ReservedDBInstances": [ + { + "ReservedDBInstanceId": "myreservedinstance", + "ReservedDBInstancesOfferingId": "12ab34cd-59af-4b2c-a660-1abcdef23456", + "DBInstanceClass": "db.t3.micro", + "StartTime": "2020-06-01T13:44:21.436Z", + "Duration": 31536000, + "FixedPrice": 0, + "UsagePrice": 0, + "CurrencyCode": "USD", + "DBInstanceCount": 1, + "ProductDescription": "sqlserver-ex(li)", + "OfferingType": "No Upfront", + "MultiAZ": false, + "State": "payment-pending", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.014, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedDBInstanceArn": "arn:aws:rds:us-west-2:123456789012:ri:myreservedinstance", + "LeaseId": "a1b2c3d4-6b69-4a59-be89-5e11aa446666" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13440,7 +16003,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeReservedDBInstancesOfferings": { @@ -13458,6 +16022,36 @@ ], "traits": { "smithy.api#documentation": "

    Lists available reserved DB instance offerings.

    ", + "smithy.api#examples": [ + { + "title": "To describe reserved DB instance offerings", + "documentation": "The following example retrieves details about reserved DB instance options for RDS for Oracle.", + "input": { + "ProductDescription": "oracle" + }, + "output": { + "ReservedDBInstancesOfferings": [ + { + "CurrencyCode": "USD", + "UsagePrice": 0, + "ProductDescription": "oracle-se2(li)", + "ReservedDBInstancesOfferingId": "005bdee3-9ef4-4182-aa0c-58ef7cb6c2f8", + "MultiAZ": true, + "DBInstanceClass": "db.m4.xlarge", + "OfferingType": "Partial Upfront", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.594, + "RecurringChargeFrequency": "Hourly" + } + ], + "FixedPrice": 4089, + "Duration": 31536000 + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13525,7 +16119,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeSourceRegions": { @@ -13538,6 +16133,145 @@ }, "traits": { "smithy.api#documentation": "

    Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, \n copy a DB snapshot from, or replicate automated backups from.

    \n

    Use this operation to determine whether cross-Region features are supported between other Regions \n and your current Region. This operation supports pagination.

    \n

    To return information about the Regions that are enabled for your account, or all Regions, \n use the EC2 operation DescribeRegions. For more information, see \n \n DescribeRegions in the Amazon EC2 API Reference.

    ", + "smithy.api#examples": [ + { + "title": "To describe source Regions", + "documentation": "The following example retrieves details about all source AWS Regions where the current AWS Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. It also shows that automated backups can be replicated only from US West (Oregon) to the destination AWS Region, US East (N. Virginia).", + "input": { + "RegionName": "us-east-1" + }, + "output": { + "SourceRegions": [ + { + "RegionName": "af-south-1", + "Endpoint": "https://rds.af-south-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "ap-east-1", + "Endpoint": "https://rds.ap-east-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "ap-northeast-1", + "Endpoint": "https://rds.ap-northeast-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "ap-northeast-2", + "Endpoint": "https://rds.ap-northeast-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "ap-northeast-3", + "Endpoint": "https://rds.ap-northeast-3.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "ap-south-1", + "Endpoint": "https://rds.ap-south-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "ap-southeast-1", + "Endpoint": "https://rds.ap-southeast-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "ap-southeast-2", + "Endpoint": "https://rds.ap-southeast-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "ap-southeast-3", + "Endpoint": "https://rds.ap-southeast-3.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "ca-central-1", + "Endpoint": "https://rds.ca-central-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "eu-north-1", + "Endpoint": "https://rds.eu-north-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "eu-south-1", + "Endpoint": "https://rds.eu-south-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "eu-west-1", + "Endpoint": "https://rds.eu-west-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "eu-west-2", + "Endpoint": "https://rds.eu-west-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "eu-west-3", + "Endpoint": "https://rds.eu-west-3.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "me-central-1", + "Endpoint": "https://rds.me-central-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "me-south-1", + "Endpoint": "https://rds.me-south-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "sa-east-1", + "Endpoint": "https://rds.sa-east-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "us-east-2", + "Endpoint": "https://rds.us-east-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "us-west-1", + "Endpoint": "https://rds.us-west-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "us-west-2", + "Endpoint": "https://rds.us-west-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13575,7 +16309,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeValidDBInstanceModifications": { @@ -13595,7 +16330,37 @@ } ], "traits": { - "smithy.api#documentation": "

    You can call DescribeValidDBInstanceModifications to learn what modifications you can make to \n your DB instance. You can use this information when you call ModifyDBInstance.

    \n

    This command doesn't apply to RDS Custom.

    " + "smithy.api#documentation": "

    You can call DescribeValidDBInstanceModifications to learn what modifications you can make to \n your DB instance. You can use this information when you call ModifyDBInstance.

    \n

    This command doesn't apply to RDS Custom.

    ", + "smithy.api#examples": [ + { + "title": "To describe valid modifications for a DB instance", + "documentation": "The following example retrieves details about the valid modifications for the specified DB instance.", + "input": { + "DBInstanceIdentifier": "database-test1" + }, + "output": { + "ValidDBInstanceModificationsMessage": { + "Storage": [ + { + "StorageType": "gp2", + "StorageSize": [ + { + "From": 20, + "To": 20, + "Step": 1 + }, + { + "From": 22, + "To": 6144, + "Step": 1 + } + ] + } + ] + } + } + } + ] } }, "com.amazonaws.rds#DescribeValidDBInstanceModificationsMessage": { @@ -13610,7 +16375,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#DescribeValidDBInstanceModificationsResult": { @@ -13768,6 +16534,17 @@ ], "traits": { "smithy.api#documentation": "

    Downloads all or a portion of the specified log file, up to 1 MB in size.

    \n

    This command doesn't apply to RDS Custom.

    ", + "smithy.api#examples": [ + { + "title": "To download a DB log file", + "documentation": "The following example downloads only the latest part of your log file.", + "input": { + "DBInstanceIdentifier": "test-instance", + "LogFileName": "log.txt" + }, + "output": {} + } + ], "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -13834,7 +16611,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#EC2SecurityGroup": { @@ -14070,7 +16848,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Data returned from the DescribeEventCategories operation.

    " + "smithy.api#documentation": "

    Data returned from the DescribeEventCategories operation.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#EventList": { @@ -14194,7 +16973,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Data returned by the DescribeEventSubscriptions action.

    " + "smithy.api#documentation": "

    Data returned by the DescribeEventSubscriptions action.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#EventsMessage": { @@ -14214,7 +16994,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeEvents action.

    " + "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeEvents action.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#ExceptionMessage": { @@ -14401,6 +17182,9 @@ "smithy.api#documentation": "

    Information about an export of a snapshot or cluster to Amazon S3.

    " } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rds#FailoverDBCluster": { @@ -14423,7 +17207,20 @@ } ], "traits": { - "smithy.api#documentation": "

    Forces a failover for a DB cluster.

    \n

    For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).

    \n

    For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).

    \n

    An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,\n when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby \n DB instance when the primary DB instance fails.

    \n

    To simulate a failure of a primary instance for testing, you can force a failover. \n Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing \n connections that use those endpoint addresses when the failover is complete.

    \n

    For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    " + "smithy.api#documentation": "

    Forces a failover for a DB cluster.

    \n

    For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).

    \n

    For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).

    \n

    An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,\n when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby \n DB instance when the primary DB instance fails.

    \n

    To simulate a failure of a primary instance for testing, you can force a failover. \n Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing \n connections that use those endpoint addresses when the failover is complete.

    \n

    For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    ", + "smithy.api#examples": [ + { + "title": "To perform a failover for a DB cluster", + "documentation": "This example performs a failover for the specified DB cluster to the specified DB instance.", + "input": { + "DBClusterIdentifier": "myaurorainstance-cluster", + "TargetDBInstanceIdentifier": "myaurorareplica" + }, + "output": { + "DBCluster": {} + } + } + ] } }, "com.amazonaws.rds#FailoverDBClusterMessage": { @@ -14444,7 +17241,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#FailoverDBClusterResult": { @@ -14501,6 +17299,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#FailoverGlobalClusterResult": { @@ -14810,6 +17611,9 @@ "smithy.api#documentation": "

    The list of global clusters returned by this request.

    " } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.rds#IAMAuthMode": { @@ -15026,6 +17830,23 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.rds#InvalidDBClusterAutomatedBackupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterAutomatedBackupStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

    The automated backup is in an invalid state. \n For example, this automated backup is associated with an active cluster.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.rds#InvalidDBClusterCapacityFault": { "type": "structure", "members": { @@ -15496,7 +18317,28 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists all tags on an Amazon RDS resource.

    \n

    For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.

    " + "smithy.api#documentation": "

    Lists all tags on an Amazon RDS resource.

    \n

    For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.

    ", + "smithy.api#examples": [ + { + "title": "To list tags on an Amazon RDS resource", + "documentation": "The following example lists all tags on a DB instance.", + "input": { + "ResourceName": "arn:aws:rds:us-east-1:123456789012:db:orcl1" + }, + "output": { + "TagList": [ + { + "Key": "Environment", + "Value": "test" + }, + { + "Key": "Name", + "Value": "MyDatabase" + } + ] + } + } + ] } }, "com.amazonaws.rds#ListTagsForResourceMessage": { @@ -15517,7 +18359,43 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#LocalWriteForwardingStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "requested" + } + } } }, "com.amazonaws.rds#LogTypeList": { @@ -15700,7 +18578,28 @@ } ], "traits": { - "smithy.api#documentation": "

    Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)\n certificate for Amazon RDS for new DB instances, or remove the override.

    \n

    By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB\n instances that is different from the default certificate provided by RDS. You can also\n use this operation to remove the override, so that new DB instances use the default\n certificate provided by RDS.

    \n

    You might need to override the default certificate in the following situations:

    \n
      \n
    • \n

      You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet \n the RDS default CA certificate for the specified Amazon Web Services Region.

      \n
      • \n
    • \n

      RDS has already moved to a new default CA certificate for the specified Amazon Web Services\n Region, but you are still in the process of supporting the new CA certificate.\n In this case, you temporarily need additional time to finish your application\n changes.

      \n
      • \n
    \n

    For more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

    \n

    For more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

    " + "smithy.api#documentation": "

    Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)\n certificate for Amazon RDS for new DB instances, or remove the override.

    \n

    By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB\n instances that is different from the default certificate provided by RDS. You can also\n use this operation to remove the override, so that new DB instances use the default\n certificate provided by RDS.

    \n

    You might need to override the default certificate in the following situations:

    \n
      \n
    • \n

      You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet \n the RDS default CA certificate for the specified Amazon Web Services Region.

      \n
      • \n
    • \n

      RDS has already moved to a new default CA certificate for the specified Amazon Web Services\n Region, but you are still in the process of supporting the new CA certificate.\n In this case, you temporarily need additional time to finish your application\n changes.

      \n
      • \n
    \n

    For more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

    \n

    For more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

    ", + "smithy.api#examples": [ + { + "title": "To temporarily override the system-default SSL/TLS certificate for new DB instances", + "documentation": "The following example temporarily overrides the system-default SSL/TLS certificate for new DB instances.", + "input": { + "CertificateIdentifier": "rds-ca-2019" + }, + "output": { + "Certificate": { + "CertificateIdentifier": "rds-ca-2019", + "CertificateType": "CA", + "Thumbprint": "EXAMPLE123456789012", + "ValidFrom": "2019-09-19T18:16:53Z", + "ValidTill": "2024-08-22T17:08:50Z", + "CertificateArn": "arn:aws:rds:us-east-1::cert:rds-ca-2019", + "CustomerOverride": true, + "CustomerOverrideValidTill": "2024-08-22T17:08:50Z" + } + } + } + ] } }, "com.amazonaws.rds#ModifyCertificatesMessage": { @@ -15718,6 +18617,9 @@ "smithy.api#documentation": "

    A value that indicates whether to remove the override for the default certificate. \n If the override is removed, the default certificate is the system\n default.

    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyCertificatesResult": { @@ -15751,7 +18653,24 @@ } ], "traits": { - "smithy.api#documentation": "

    Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.

    \n

    Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale \n fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity \n to set the capacity explicitly.

    \n

    After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale\n the DB cluster based on the cooldown period for scaling up and the cooldown period\n for scaling down.

    \n

    For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

    \n \n

    If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that \n prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, \n see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

    \n     \n \n

    This action only applies to Aurora Serverless v1 DB clusters.

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

    Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.

    \n

    Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale \n fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity \n to set the capacity explicitly.

    \n

    After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale\n the DB cluster based on the cooldown period for scaling up and the cooldown period\n for scaling down.

    \n

    For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

    \n \n

    If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that \n prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, \n see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

    \n     \n \n

    This action only applies to Aurora Serverless v1 DB clusters.

    \n     ", + "smithy.api#examples": [ + { + "title": "To scale the capacity of an Aurora Serverless DB cluster", + "documentation": "The following example scales the capacity of an Aurora Serverless DB cluster to 8.", + "input": { + "DBClusterIdentifier": "mydbcluster", + "Capacity": 8 + }, + "output": { + "DBClusterIdentifier": "mydbcluster", + "PendingCapacity": 8, + "CurrentCapacity": 1, + "SecondsBeforeTimeout": 300, + "TimeoutAction": "ForceApplyCapacityChange" + } + } + ] } }, "com.amazonaws.rds#ModifyCurrentDBClusterCapacityMessage": { @@ -15782,6 +18701,9 @@ "smithy.api#documentation": "

    The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

    \n

    \n ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

    \n

    \n RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyCustomDBEngineVersion": { @@ -15833,6 +18755,9 @@ "smithy.api#documentation": "

    The availability status to be assigned to the CEV. Valid values are as follows:

    \n
    \n
    available
    \n
    \n

    You can use this CEV to create a new RDS Custom DB instance.

    \n
    \n
    inactive
    \n
    \n

    You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. \n You can't patch or create new instances with this CEV.

    \n
    \n
    \n

    You can change any status to any status. A typical reason to change status is to prevent the accidental \n use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status \n of your CEV from available to inactive, and from inactive back to \n available. To change the availability status of the CEV, it must not currently be in use by an \n RDS Custom instance, snapshot, or automated backup.

    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyDBCluster": { @@ -15888,7 +18813,75 @@ } ], "traits": { - "smithy.api#documentation": "

    Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. \n You can change one or more settings by specifying these parameters and the new values in the\n request.

    \n

    For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    " + "smithy.api#documentation": "

    Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. \n You can change one or more settings by specifying these parameters and the new values in the\n request.

    \n

    For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

    ", + "smithy.api#examples": [ + { + "title": "To modify a DB cluster", + "documentation": "The following example changes the master user password for the DB cluster named cluster-2 and sets the backup retention period to 14 days. The ApplyImmediately parameter causes the changes to be made immediately, instead of waiting until the next maintenance window.", + "input": { + "DBClusterIdentifier": "cluster-2", + "ApplyImmediately": true, + "BackupRetentionPeriod": 14, + "MasterUserPassword": "newpassword99" + }, + "output": { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "eu-central-1b", + "eu-central-1c", + "eu-central-1a" + ], + "BackupRetentionPeriod": 14, + "DatabaseName": "", + "DBClusterIdentifier": "cluster-2", + "DBClusterParameterGroup": "default.aurora5.6", + "DBSubnetGroup": "default-vpc-2305ca49", + "Status": "available", + "EarliestRestorableTime": "2020-06-03T02:07:29.637Z", + "Endpoint": "cluster-2.cluster-############.eu-central-1.rds.amazonaws.com", + "ReaderEndpoint": "cluster-2.cluster-ro-############.eu-central-1.rds.amazonaws.com", + "MultiAZ": false, + "Engine": "aurora", + "EngineVersion": "5.6.10a", + "LatestRestorableTime": "2020-06-04T15:11:25.748Z", + "Port": 3306, + "MasterUsername": "admin", + "PreferredBackupWindow": "01:55-02:25", + "PreferredMaintenanceWindow": "thu:21:14-thu:21:44", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [ + { + "DBInstanceIdentifier": "cluster-2-instance-1", + "IsClusterWriter": true, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + } + ], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-20a5c047", + "Status": "active" + } + ], + "HostedZoneId": "Z1RLNU0EXAMPLE", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:eu-central-1:123456789012:key/d1bd7c8f-5cdb-49ca-8a62-a1b2c3d4e5f6", + "DbClusterResourceId": "cluster-AGJ7XI77XVIS6FUXHU1EXAMPLE", + "DBClusterArn": "arn:aws:rds:eu-central-1:123456789012:cluster:cluster-2", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2020-04-03T14:44:02.764Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false, + "CopyTagsToSnapshot": true, + "CrossAccountClone": false, + "DomainMemberships": [] + } + } + } + ] } }, "com.amazonaws.rds#ModifyDBClusterEndpoint": { @@ -15917,7 +18910,37 @@ } ], "traits": { - "smithy.api#documentation": "

    Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

    \n \n

    This action only applies to Aurora DB clusters.

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

    Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

    \n \n

    This action only applies to Aurora DB clusters.

    \n     ", + "smithy.api#examples": [ + { + "title": "To modify a custom DB cluster endpoint", + "documentation": "The following example modifies the specified custom DB cluster endpoint.", + "input": { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "StaticMembers": [ + "dbinstance1", + "dbinstance2", + "dbinstance3" + ] + }, + "output": { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", + "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "modifying", + "EndpointType": "CUSTOM", + "CustomEndpointType": "READER", + "StaticMembers": [ + "dbinstance1", + "dbinstance2", + "dbinstance3" + ], + "ExcludedMembers": [], + "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" + } + } + ] } }, "com.amazonaws.rds#ModifyDBClusterEndpointMessage": { @@ -15948,6 +18971,9 @@ "smithy.api#documentation": "

    List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.

    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyDBClusterMessage": { @@ -16199,10 +19225,17 @@ "smithy.api#default": false, "smithy.api#documentation": "

    Specifies whether engine mode changes from serverless to provisioned \n are allowed.

    \n

    Valid for Cluster Type: Aurora Serverless v1 DB clusters only

    \n

    Constraints:

    \n
      \n
    • \n

      You must allow engine mode changes when specifying a different value for the EngineMode parameter\n from the DB cluster's current engine mode.

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

    Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By\n default, write operations aren't allowed on reader DB instances.

    \n

    Valid for: Aurora DB clusters only

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

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyDBClusterParameterGroup": { @@ -16222,7 +19255,31 @@ } ], "traits": { - "smithy.api#documentation": "

    Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.

    \n \n

    After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters operation to verify \n that your DB cluster parameter group has been created or modified.

    \n

    If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.

    \n     \n

    For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

    " + "smithy.api#documentation": "

    Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.

    \n \n

    After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters operation to verify \n that your DB cluster parameter group has been created or modified.

    \n

    If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.

    \n     \n

    For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

    ", + "smithy.api#examples": [ + { + "title": "To modify parameters in a DB cluster parameter group", + "documentation": "The following example modifies the values of parameters in a DB cluster parameter group.", + "input": { + "DBClusterParameterGroupName": "mydbclusterpg", + "Parameters": [ + { + "ParameterName": "server_audit_logging", + "ParameterValue": "1", + "ApplyMethod": "immediate" + }, + { + "ParameterName": "server_audit_logs_upload", + "ParameterValue": "1", + "ApplyMethod": "immediate" + } + ] + }, + "output": { + "DBClusterParameterGroupName": "mydbclusterpg" + } + } + ] } }, "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage": { @@ -16244,7 +19301,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyDBClusterResult": { @@ -16278,7 +19336,33 @@ } ], "traits": { - "smithy.api#documentation": "

    Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

    \n

    To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all Amazon Web Services accounts.

    \n \n

    Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all Amazon Web Services\n accounts.

    \n     \n

    If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.

    \n

    To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are\n returned as values for the restore attribute.

    " + "smithy.api#documentation": "

    Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

    \n

    To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all Amazon Web Services accounts.

    \n \n

    Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all Amazon Web Services\n accounts.

    \n     \n

    If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.

    \n

    To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are\n returned as values for the restore attribute.

    ", + "smithy.api#examples": [ + { + "title": "To modify a DB cluster snapshot attribute", + "documentation": "The following example makes changes to the specified DB cluster snapshot attribute.", + "input": { + "DBClusterSnapshotIdentifier": "myclustersnapshot", + "AttributeName": "restore", + "ValuesToAdd": [ + "123456789012" + ] + }, + "output": { + "DBClusterSnapshotAttributesResult": { + "DBClusterSnapshotIdentifier": "myclustersnapshot", + "DBClusterSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "123456789012" + ] + } + ] + } + } + } + ] } }, "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeMessage": { @@ -16312,7 +19396,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeResult": { @@ -16397,7 +19482,52 @@ } ], "traits": { - "smithy.api#documentation": "

    Modifies settings for a DB instance. \n You can change one or more database configuration parameters by specifying these parameters and the new values in the request.\n To learn what modifications you can make to your DB instance,\n call DescribeValidDBInstanceModifications\n before you call ModifyDBInstance.

    " + "smithy.api#documentation": "

    Modifies settings for a DB instance. \n You can change one or more database configuration parameters by specifying these parameters and the new values in the request.\n To learn what modifications you can make to your DB instance,\n call DescribeValidDBInstanceModifications\n before you call ModifyDBInstance.

    ", + "smithy.api#examples": [ + { + "title": "To modify a DB instance", + "documentation": "The following example associates an option group and a parameter group with a compatible Microsoft SQL Server DB instance. The ApplyImmediately parameter causes the option and parameter groups to be associated immediately, instead of waiting until the next maintenance window.", + "input": { + "DBInstanceIdentifier": "database-2", + "ApplyImmediately": true, + "DBParameterGroupName": "test-sqlserver-se-2017", + "OptionGroupName": "test-se-2017" + }, + "output": { + "DBInstance": { + "DBInstanceIdentifier": "database-2", + "DBInstanceClass": "db.r4.large", + "Engine": "sqlserver-se", + "DBInstanceStatus": "available", + "DBParameterGroups": [ + { + "DBParameterGroupName": "test-sqlserver-se-2017", + "ParameterApplyStatus": "applying" + } + ], + "AvailabilityZone": "us-west-2d", + "MultiAZ": true, + "EngineVersion": "14.00.3281.6.v1", + "AutoMinorVersionUpgrade": false, + "ReadReplicaDBInstanceIdentifiers": [], + "LicenseModel": "license-included", + "OptionGroupMemberships": [ + { + "OptionGroupName": "test-se-2017", + "Status": "pending-apply" + } + ], + "CharacterSetName": "SQL_Latin1_General_CP1_CI_AS", + "SecondaryAvailabilityZone": "us-west-2c", + "PubliclyAccessible": true, + "StorageType": "gp2", + "DeletionProtection": false, + "AssociatedRoles": [], + "MaxAllocatedStorage": 1000 + } + } + } + ] } }, "com.amazonaws.rds#ModifyDBInstanceMessage": { @@ -16756,7 +19886,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyDBInstanceResult": { @@ -16787,7 +19918,26 @@ } ], "traits": { - "smithy.api#documentation": "

    Modifies the parameters of a DB parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, and \n ApplyMethod. A maximum of 20 parameters can be modified in a single request.

    \n \n

    After you modify a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the modify action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

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

    Modifies the parameters of a DB parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, and \n ApplyMethod. A maximum of 20 parameters can be modified in a single request.

    \n \n

    After you modify a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the modify action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

    \n     ", + "smithy.api#examples": [ + { + "title": "To modify a DB parameter group", + "documentation": "The following example changes the value of the clr enabled parameter in a DB parameter group. The value of the ApplyMethod parameter causes the DB parameter group to be modified immediately, instead of waiting until the next maintenance window.", + "input": { + "DBParameterGroupName": "test-sqlserver-se-2017", + "Parameters": [ + { + "ParameterName": "clr enabled", + "ParameterValue": "1", + "ApplyMethod": "immediate" + } + ] + }, + "output": { + "DBParameterGroupName": "test-sqlserver-se-2017" + } + } + ] } }, "com.amazonaws.rds#ModifyDBParameterGroupMessage": { @@ -16809,7 +19959,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyDBProxy": { @@ -17058,7 +20209,43 @@ } ], "traits": { - "smithy.api#documentation": "

    Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n

    \n

    Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command\n doesn't apply to RDS Custom.

    " + "smithy.api#documentation": "

    Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n

    \n

    Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command\n doesn't apply to RDS Custom.

    ", + "smithy.api#examples": [ + { + "title": "To modify a DB snapshot", + "documentation": "The following example upgrades a PostgeSQL 10.6 snapshot named db5-snapshot-upg-test to PostgreSQL 11.7. The new DB engine version is shown after the snapshot has finished upgrading and its status is available.", + "input": { + "DBSnapshotIdentifier": "db5-snapshot-upg-test", + "EngineVersion": "11.7" + }, + "output": { + "DBSnapshot": { + "DBSnapshotIdentifier": "db5-snapshot-upg-test", + "DBInstanceIdentifier": "database-5", + "SnapshotCreateTime": "2020-03-27T20:49:17.092Z", + "Engine": "postgres", + "AllocatedStorage": 20, + "Status": "upgrading", + "Port": 5432, + "AvailabilityZone": "us-west-2a", + "VpcId": "vpc-2ff27557", + "InstanceCreateTime": "2020-03-27T19:59:04.735Z", + "MasterUsername": "postgres", + "EngineVersion": "10.6", + "LicenseModel": "postgresql-license", + "SnapshotType": "manual", + "OptionGroupName": "default:postgres-11", + "PercentProgress": 100, + "StorageType": "gp2", + "Encrypted": false, + "DBSnapshotArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-upg-test", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-GJMF75LM42IL6BTFRE4UZJ5YM4" + } + } + } + ] } }, "com.amazonaws.rds#ModifyDBSnapshotAttribute": { @@ -17081,7 +20268,35 @@ } ], "traits": { - "smithy.api#documentation": "

    Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

    \n

    To share a manual DB snapshot with other Amazon Web Services accounts, specify restore\n as the AttributeName and use the ValuesToAdd parameter to add\n a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot.\n Uses the value all to make the manual DB snapshot public, which means it\n can be copied or restored by all Amazon Web Services accounts.

    \n \n

    Don't add the all value for any manual DB snapshots that\n contain private information that you don't want available to all Amazon Web Services\n accounts.

    \n     \n

    If the manual DB snapshot is encrypted, it can be shared, but only by specifying a\n list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You\n can't use all as a value for that parameter in this case.

    \n

    To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or\n whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as\n values for the restore attribute.

    " + "smithy.api#documentation": "

    Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

    \n

    To share a manual DB snapshot with other Amazon Web Services accounts, specify restore\n as the AttributeName and use the ValuesToAdd parameter to add\n a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot.\n Uses the value all to make the manual DB snapshot public, which means it\n can be copied or restored by all Amazon Web Services accounts.

    \n \n

    Don't add the all value for any manual DB snapshots that\n contain private information that you don't want available to all Amazon Web Services\n accounts.

    \n     \n

    If the manual DB snapshot is encrypted, it can be shared, but only by specifying a\n list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You\n can't use all as a value for that parameter in this case.

    \n

    To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or\n whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as\n values for the restore attribute.

    ", + "smithy.api#examples": [ + { + "title": "To allow two AWS accounts to restore a DB snapshot", + "documentation": "The following example grants permission to two AWS accounts, with the identifiers 111122223333 and 444455556666, to restore the DB snapshot named mydbsnapshot.", + "input": { + "DBSnapshotIdentifier": "mydbsnapshot", + "AttributeName": "restore", + "ValuesToAdd": [ + "111122223333", + "444455556666" + ] + }, + "output": { + "DBSnapshotAttributesResult": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "111122223333", + "444455556666" + ] + } + ] + } + } + } + ] } }, "com.amazonaws.rds#ModifyDBSnapshotAttributeMessage": { @@ -17115,7 +20330,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyDBSnapshotAttributeResult": { @@ -17151,6 +20367,9 @@ "smithy.api#documentation": "

    The option group to identify with the upgraded DB snapshot.

    \n

    You can specify this parameter when you upgrade an Oracle DB snapshot.\n The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance.\n For more information, see \n Option group considerations in the Amazon RDS User Guide.\n

    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyDBSnapshotResult": { @@ -17190,7 +20409,62 @@ } ], "traits": { - "smithy.api#documentation": "

    Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

    " + "smithy.api#documentation": "

    Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

    ", + "smithy.api#examples": [ + { + "title": "To modify a DB subnet group", + "documentation": "The following example adds a subnet with the ID subnet-08e41f9e230222222 to the DB subnet group named mysubnetgroup. To keep the existing subnets in the subnet group, include their IDs as values in the --subnet-ids option. Make sure to have subnets with at least two different Availability Zones in the DB subnet group.", + "input": { + "DBSubnetGroupName": "mysubnetgroup", + "DBSubnetGroupDescription": "", + "SubnetIds": [ + "subnet-0a1dc4e1a6f123456", + "subnet-070dd7ecb3aaaaaaa", + "subnet-00f5b198bc0abcdef", + "subnet-08e41f9e230222222" + ] + }, + "output": { + "DBSubnetGroup": { + "DBSubnetGroupName": "mysubnetgroup", + "DBSubnetGroupDescription": "test DB subnet group", + "VpcId": "vpc-0f08e7610a1b2c3d4", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-08e41f9e230222222", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-070dd7ecb3aaaaaaa", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-00f5b198bc0abcdef", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-0a1dc4e1a6f123456", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + } + ], + "DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:mysubnetgroup" + } + } + } + ] } }, "com.amazonaws.rds#ModifyDBSubnetGroupMessage": { @@ -17218,7 +20492,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyDBSubnetGroupResult": { @@ -17261,7 +20536,33 @@ } ], "traits": { - "smithy.api#documentation": "

    Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change \n source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

    \n

    You can see a list of the event categories for a given source type (SourceType) \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.

    " + "smithy.api#documentation": "

    Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change \n source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

    \n

    You can see a list of the event categories for a given source type (SourceType) \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.

    ", + "smithy.api#examples": [ + { + "title": "To modify an event subscription", + "documentation": "The following example turns off the specified event subscription, so that it no longer publishes notifications to the specified Amazon Simple Notification Service topic.", + "input": { + "SubscriptionName": "my-instance-events", + "Enabled": false + }, + "output": { + "EventSubscription": { + "EventCategoriesList": [ + "backup", + "recovery" + ], + "CustomerAwsId": "123456789012", + "SourceType": "db-instance", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "CustSubscriptionId": "my-instance-events", + "Status": "modifying", + "Enabled": false + } + } + } + ] } }, "com.amazonaws.rds#ModifyEventSubscriptionMessage": { @@ -17300,7 +20601,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyEventSubscriptionResult": { @@ -17337,7 +20639,30 @@ } ], "traits": { - "smithy.api#documentation": "

    Modifies a setting for an Amazon Aurora global cluster. You can change one or more database configuration\n parameters by specifying these parameters and the new values in the request. For more information on\n Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.

    \n \n

    This operation only applies to Aurora global database clusters.

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

    Modifies a setting for an Amazon Aurora global cluster. You can change one or more database configuration\n parameters by specifying these parameters and the new values in the request. For more information on\n Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.

    \n \n

    This operation only applies to Aurora global database clusters.

    \n     ", + "smithy.api#examples": [ + { + "title": "To modify a global database cluster", + "documentation": "The following example enables deletion protection for an Aurora MySQL-based global database cluster.", + "input": { + "GlobalClusterIdentifier": "myglobalcluster", + "DeletionProtection": true + }, + "output": { + "GlobalCluster": { + "GlobalClusterIdentifier": "myglobalcluster", + "GlobalClusterResourceId": "cluster-f0e523bfe07aabb", + "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", + "Status": "available", + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.07.2", + "StorageEncrypted": false, + "DeletionProtection": true, + "GlobalClusterMembers": [] + } + } + } + ] } }, "com.amazonaws.rds#ModifyGlobalClusterMessage": { @@ -17373,6 +20698,9 @@ "smithy.api#documentation": "

    Specifies whether to allow major version upgrades.

    \n

    Constraints: Must be enabled if you specify a value for the\n EngineVersion parameter that's a different major version than the global\n cluster's current version.

    \n

    If you upgrade the major version of a global database, the cluster and DB instance parameter\n groups are set to the default parameter groups for the new version. Apply any custom parameter\n groups after completing the upgrade.

    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyGlobalClusterResult": { @@ -17403,7 +20731,28 @@ } ], "traits": { - "smithy.api#documentation": "

    Modifies an existing option group.

    " + "smithy.api#documentation": "

    Modifies an existing option group.

    ", + "smithy.api#examples": [ + { + "title": "To modify an option group", + "documentation": "The following example adds an option to an option group.", + "input": { + "OptionGroupName": "myawsuser-og02", + "OptionsToInclude": [ + { + "OptionName": "MEMCACHED", + "DBSecurityGroupMemberships": [ + "default" + ] + } + ], + "ApplyImmediately": true + }, + "output": { + "OptionGroup": {} + } + } + ] } }, "com.amazonaws.rds#ModifyOptionGroupMessage": { @@ -17437,7 +20786,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#ModifyOptionGroupResult": { @@ -17941,7 +21291,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#OptionGroupQuotaExceededFault": { @@ -18382,7 +21733,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

    " + "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#Outpost": { @@ -18582,7 +21934,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Data returned from the DescribePendingMaintenanceActions action.

    " + "smithy.api#documentation": "

    Data returned from the DescribePendingMaintenanceActions action.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#PendingModifiedValues": { @@ -18773,7 +22126,24 @@ } ], "traits": { - "smithy.api#documentation": "

    Promotes a read replica DB instance to a standalone DB instance.

    \n \n
      \n
    • \n

      Backup duration is a function of the amount of changes to the database since the previous\n backup. If you plan to promote a read replica to a standalone instance, we\n recommend that you enable backups and complete at least one backup prior to\n promotion. In addition, a read replica cannot be promoted to a standalone\n instance when it is in the backing-up status. If you have\n enabled backups on your read replica, configure the automated backup window\n so that daily backups do not interfere with read replica\n promotion.

      \n
      • \n
    • \n

      This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.

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

    Promotes a read replica DB instance to a standalone DB instance.

    \n \n
      \n
    • \n

      Backup duration is a function of the amount of changes to the database since the previous\n backup. If you plan to promote a read replica to a standalone instance, we\n recommend that you enable backups and complete at least one backup prior to\n promotion. In addition, a read replica cannot be promoted to a standalone\n instance when it is in the backing-up status. If you have\n enabled backups on your read replica, configure the automated backup window\n so that daily backups do not interfere with read replica\n promotion.

      \n
      • \n
    • \n

      This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.

      \n
      • \n
    \n     ", + "smithy.api#examples": [ + { + "title": "To promote a read replica", + "documentation": "The following example promotes the specified read replica to become a standalone DB instance.", + "input": { + "DBInstanceIdentifier": "test-instance-repl" + }, + "output": { + "DBInstance": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl", + "StorageType": "standard", + "ReadReplicaSourceDBInstanceIdentifier": "test-instance", + "DBInstanceStatus": "modifying" + } + } + } + ] } }, "com.amazonaws.rds#PromoteReadReplicaDBCluster": { @@ -18808,7 +22178,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#PromoteReadReplicaDBClusterResult": { @@ -18846,7 +22217,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#PromoteReadReplicaResult": { @@ -18897,7 +22269,41 @@ } ], "traits": { - "smithy.api#documentation": "

    Purchases a reserved DB instance offering.

    " + "smithy.api#documentation": "

    Purchases a reserved DB instance offering.

    ", + "smithy.api#examples": [ + { + "title": "To purchase a reserved DB instance", + "documentation": "The following example shows how to buy the reserved DB instance offering from the previous example.", + "input": { + "ReservedDBInstancesOfferingId": "", + "ReservedDBInstanceId": "8ba30be1-b9ec-447f-8f23-6114e3f4c7b4" + }, + "output": { + "ReservedDBInstance": { + "ReservedDBInstanceId": "ri-2020-06-29-16-54-57-670", + "ReservedDBInstancesOfferingId": "8ba30be1-b9ec-447f-8f23-6114e3f4c7b4", + "DBInstanceClass": "db.t2.micro", + "StartTime": "2020-06-29T16:54:57.670Z", + "Duration": 31536000, + "FixedPrice": 51, + "UsagePrice": 0, + "CurrencyCode": "USD", + "DBInstanceCount": 1, + "ProductDescription": "mysql", + "OfferingType": "Partial Upfront", + "MultiAZ": false, + "State": "payment-pending", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.006, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedDBInstanceArn": "arn:aws:rds:us-west-2:123456789012:ri:ri-2020-06-29-16-54-57-670" + } + } + } + ] } }, "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingMessage": { @@ -18927,7 +22333,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingResult": { @@ -19044,6 +22451,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#RebootDBClusterResult": { @@ -19074,7 +22484,30 @@ } ], "traits": { - "smithy.api#documentation": "

    You might need to reboot your DB instance, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB parameter group associated with the DB instance, \n you must reboot the instance for the changes to take effect.

    \n

    Rebooting a DB instance restarts the database engine service. \n Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

    \n

    For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.\n

    \n

    This command doesn't apply to RDS Custom.

    \n

    If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.

    " + "smithy.api#documentation": "

    You might need to reboot your DB instance, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB parameter group associated with the DB instance, \n you must reboot the instance for the changes to take effect.

    \n

    Rebooting a DB instance restarts the database engine service. \n Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

    \n

    For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.\n

    \n

    This command doesn't apply to RDS Custom.

    \n

    If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.

    ", + "smithy.api#examples": [ + { + "title": "To reboot a DB instance", + "documentation": "The following example starts a reboot of the specified DB instance.", + "input": { + "DBInstanceIdentifier": "test-mysql-instance" + }, + "output": { + "DBInstance": { + "DBInstanceIdentifier": "test-mysql-instance", + "DBInstanceClass": "db.t3.micro", + "Engine": "mysql", + "DBInstanceStatus": "rebooting", + "MasterUsername": "admin", + "Endpoint": { + "Address": "test-mysql-instance.############.us-west-2.rds.amazonaws.com", + "Port": 3306, + "HostedZoneId": "Z1PVIF0EXAMPLE" + } + } + } + } + ] } }, "com.amazonaws.rds#RebootDBInstanceMessage": { @@ -19095,7 +22528,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#RebootDBInstanceResult": { @@ -19247,7 +22681,44 @@ } ], "traits": { - "smithy.api#documentation": "

    Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a\n standalone cluster with read-write capability instead of being read-only and receiving data from a\n primary cluster in a different Region.

    \n \n

    This action only applies to Aurora DB clusters.

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

    Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a\n standalone cluster with read-write capability instead of being read-only and receiving data from a\n primary cluster in a different Region.

    \n \n

    This action only applies to Aurora DB clusters.

    \n     ", + "smithy.api#examples": [ + { + "title": "To detach an Aurora secondary cluster from an Aurora global database cluster", + "documentation": "The following example detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster changes from being read-only to a standalone cluster with read-write capability.", + "input": { + "GlobalClusterIdentifier": "myglobalcluster", + "DbClusterIdentifier": "arn:aws:rds:us-west-2:123456789012:cluster:DB-1" + }, + "output": { + "GlobalCluster": { + "GlobalClusterIdentifier": "myglobalcluster", + "GlobalClusterResourceId": "cluster-abc123def456gh", + "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", + "Status": "available", + "Engine": "aurora-postgresql", + "EngineVersion": "10.11", + "StorageEncrypted": true, + "DeletionProtection": false, + "GlobalClusterMembers": [ + { + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:js-global-cluster", + "Readers": [ + "arn:aws:rds:us-west-2:123456789012:cluster:DB-1" + ], + "IsWriter": true + }, + { + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:DB-1", + "Readers": [], + "IsWriter": false, + "GlobalWriteForwardingStatus": "disabled" + } + ] + } + } + } + ] } }, "com.amazonaws.rds#RemoveFromGlobalClusterMessage": { @@ -19265,6 +22736,9 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.

    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#RemoveFromGlobalClusterResult": { @@ -19298,7 +22772,17 @@ } ], "traits": { - "smithy.api#documentation": "

    Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a\n DB cluster.

    \n

    For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

    " + "smithy.api#documentation": "

    Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a\n DB cluster.

    \n

    For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

    ", + "smithy.api#examples": [ + { + "title": "To disassociate an Identity and Access Management (IAM) role from a DB cluster", + "documentation": "The following example removes a role from a DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster", + "RoleArn": "arn:aws:iam::123456789012:role/RDSLoadFromS3" + } + } + ] } }, "com.amazonaws.rds#RemoveRoleFromDBClusterMessage": { @@ -19324,6 +22808,9 @@ "smithy.api#documentation": "

    The name of the feature for the DB cluster that the IAM role is to be disassociated from.\n For information about supported feature names, see DBEngineVersion.

    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#RemoveRoleFromDBInstance": { @@ -19373,6 +22860,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#RemoveSourceIdentifierFromSubscription": { @@ -19392,7 +22882,36 @@ } ], "traits": { - "smithy.api#documentation": "

    Removes a source identifier from an existing RDS event notification subscription.

    " + "smithy.api#documentation": "

    Removes a source identifier from an existing RDS event notification subscription.

    ", + "smithy.api#examples": [ + { + "title": "To remove a source identifier from a subscription", + "documentation": "The following example removes the specified source identifier from an existing subscription.", + "input": { + "SubscriptionName": "my-instance-events", + "SourceIdentifier": "test-instance-repl" + }, + "output": { + "EventSubscription": { + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "Status": "modifying", + "CustSubscriptionId": "my-instance-events", + "CustomerAwsId": "123456789012", + "SourceIdsList": [ + "test-instance" + ], + "SourceType": "db-instance", + "Enabled": false + } + } + } + ] } }, "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionMessage": { @@ -19414,7 +22933,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionResult": { @@ -19457,7 +22977,20 @@ } ], "traits": { - "smithy.api#documentation": "

    Removes metadata tags from an Amazon RDS resource.

    \n

    For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.\n

    " + "smithy.api#documentation": "

    Removes metadata tags from an Amazon RDS resource.

    \n

    For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.\n

    ", + "smithy.api#examples": [ + { + "title": "To remove tags from a resource", + "documentation": "The following example removes tags from a resource.", + "input": { + "ResourceName": "arn:aws:rds:us-east-1:123456789012:db:mydbinstance", + "TagKeys": [ + "Name", + "Environment" + ] + } + } + ] } }, "com.amazonaws.rds#RemoveTagsFromResourceMessage": { @@ -19479,7 +23012,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#ReplicaMode": { @@ -19651,7 +23185,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeReservedDBInstances action.

    " + "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeReservedDBInstances action.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#ReservedDBInstanceNotFoundFault": { @@ -19786,7 +23321,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

    " + "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#ReservedDBInstancesOfferingNotFoundFault": { @@ -19823,7 +23359,20 @@ } ], "traits": { - "smithy.api#documentation": "

    Modifies the parameters of a DB cluster parameter group to the default value. To\n reset specific parameters submit a list of the following: ParameterName \n and ApplyMethod. To reset the\n entire DB cluster parameter group, specify the DBClusterParameterGroupName \n and ResetAllParameters parameters.

    \n

    When resetting the entire group, dynamic parameters are updated immediately and static parameters\n are set to pending-reboot to take effect on the next DB instance restart \n or RebootDBInstance request. You must call RebootDBInstance for every\n DB instance in your DB cluster that you want the updated static parameter to apply to.

    \n

    For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

    " + "smithy.api#documentation": "

    Modifies the parameters of a DB cluster parameter group to the default value. To\n reset specific parameters submit a list of the following: ParameterName \n and ApplyMethod. To reset the\n entire DB cluster parameter group, specify the DBClusterParameterGroupName \n and ResetAllParameters parameters.

    \n

    When resetting the entire group, dynamic parameters are updated immediately and static parameters\n are set to pending-reboot to take effect on the next DB instance restart \n or RebootDBInstance request. You must call RebootDBInstance for every\n DB instance in your DB cluster that you want the updated static parameter to apply to.

    \n

    For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

    ", + "smithy.api#examples": [ + { + "title": "To reset all parameters to their default values", + "documentation": "The following example resets all parameter values in a customer-created DB cluster parameter group to their default values.", + "input": { + "DBClusterParameterGroupName": "mydbclpg", + "ResetAllParameters": true + }, + "output": { + "DBClusterParameterGroupName": "mydbclpg" + } + } + ] } }, "com.amazonaws.rds#ResetDBClusterParameterGroupMessage": { @@ -19851,7 +23400,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#ResetDBParameterGroup": { @@ -19871,7 +23421,20 @@ } ], "traits": { - "smithy.api#documentation": "

    Modifies the parameters of a DB parameter group to the engine/system default value.\n To reset specific parameters, provide a list of the following:\n ParameterName and ApplyMethod. To reset the entire DB\n parameter group, specify the DBParameterGroup name and\n ResetAllParameters parameters. When resetting the entire group, dynamic\n parameters are updated immediately and static parameters are set to\n pending-reboot to take effect on the next DB instance restart or\n RebootDBInstance request.

    " + "smithy.api#documentation": "

    Modifies the parameters of a DB parameter group to the engine/system default value.\n To reset specific parameters, provide a list of the following:\n ParameterName and ApplyMethod. To reset the entire DB\n parameter group, specify the DBParameterGroup name and\n ResetAllParameters parameters. When resetting the entire group, dynamic\n parameters are updated immediately and static parameters are set to\n pending-reboot to take effect on the next DB instance restart or\n RebootDBInstance request.

    ", + "smithy.api#examples": [ + { + "title": "To reset all parameters to their default values", + "documentation": "The following example resets all parameter values in a customer-created DB parameter group to their default values.", + "input": { + "DBParameterGroupName": "mypg", + "ResetAllParameters": true + }, + "output": { + "DBParameterGroupName": "mypg" + } + } + ] } }, "com.amazonaws.rds#ResetDBParameterGroupMessage": { @@ -19899,7 +23462,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#ResourceNotFoundFault": { @@ -19995,7 +23559,69 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.

    \n \n

    This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 action has completed and the DB\n cluster is available.

    \n     \n

    For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n \n

    This action only applies to Aurora DB clusters. The source DB engine must be MySQL.

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

    Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.

    \n \n

    This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 action has completed and the DB\n cluster is available.

    \n     \n

    For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n \n

    This action only applies to Aurora DB clusters. The source DB engine must be MySQL.

    \n     ", + "smithy.api#examples": [ + { + "title": "To restore an Amazon Aurora DB cluster from Amazon S3", + "documentation": "The following example restores an Amazon Aurora MySQL version 5.7-compatible DB cluster from a MySQL 5.7 DB backup file in Amazon S3.", + "input": { + "DBClusterIdentifier": "cluster-s3-restore", + "Engine": "aurora-mysql", + "MasterUsername": "admin", + "MasterUserPassword": "mypassword", + "SourceEngine": "mysql", + "SourceEngineVersion": "5.7.28", + "S3BucketName": "mybucket", + "S3Prefix": "test-backup", + "S3IngestionRoleArn": "arn:aws:iam::123456789012:role/service-role/TestBackup" + }, + "output": { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-west-2c", + "us-west-2a", + "us-west-2b" + ], + "BackupRetentionPeriod": 1, + "DBClusterIdentifier": "cluster-s3-restore", + "DBClusterParameterGroup": "default.aurora-mysql5.7", + "DBSubnetGroup": "default", + "Status": "creating", + "Endpoint": "cluster-s3-restore.cluster-co3xyzabc123.us-west-2.rds.amazonaws.com", + "ReaderEndpoint": "cluster-s3-restore.cluster-ro-co3xyzabc123.us-west-2.rds.amazonaws.com", + "MultiAZ": false, + "Engine": "aurora-mysql", + "EngineVersion": "5.7.12", + "Port": 3306, + "MasterUsername": "admin", + "PreferredBackupWindow": "11:15-11:45", + "PreferredMaintenanceWindow": "thu:12:19-thu:12:49", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-########", + "Status": "active" + } + ], + "HostedZoneId": "Z1PVIF0EXAMPLE", + "StorageEncrypted": false, + "DbClusterResourceId": "cluster-SU5THYQQHOWCXZZDGXREXAMPLE", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:cluster-s3-restore", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2020-07-27T14:22:08.095Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false, + "CopyTagsToSnapshot": false, + "CrossAccountClone": false, + "DomainMemberships": [] + } + } + } + ] } }, "com.amazonaws.rds#RestoreDBClusterFromS3Message": { @@ -20218,6 +23844,9 @@ "smithy.api#documentation": "

    Specifies the storage type to be associated with the DB cluster.

    \n

    Valid values: aurora, aurora-iopt1\n

    \n

    Default: aurora\n

    \n

    Valid for: Aurora DB clusters only

    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#RestoreDBClusterFromS3Result": { @@ -20296,7 +23925,66 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

    \n

    The target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.

    \n \n

    This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot action has completed and the DB\n cluster is available.

    \n     \n

    For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

    " + "smithy.api#documentation": "

    Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

    \n

    The target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.

    \n \n

    This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot action has completed and the DB\n cluster is available.

    \n     \n

    For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

    ", + "smithy.api#examples": [ + { + "title": "To restore a DB cluster from a snapshot", + "documentation": "The following example restores an Aurora PostgreSQL DB cluster compatible with PostgreSQL version 10.7 from a DB cluster snapshot named test-instance-snapshot.", + "input": { + "DBClusterIdentifier": "newdbcluster", + "SnapshotIdentifier": "test-instance-snapshot", + "Engine": "aurora-postgresql", + "EngineVersion": "10.7" + }, + "output": { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-west-2c", + "us-west-2a", + "us-west-2b" + ], + "BackupRetentionPeriod": 7, + "DatabaseName": "", + "DBClusterIdentifier": "newdbcluster", + "DBClusterParameterGroup": "default.aurora-postgresql10", + "DBSubnetGroup": "default", + "Status": "creating", + "Endpoint": "newdbcluster.cluster-############.us-west-2.rds.amazonaws.com", + "ReaderEndpoint": "newdbcluster.cluster-ro-############.us-west-2.rds.amazonaws.com", + "MultiAZ": false, + "Engine": "aurora-postgresql", + "EngineVersion": "10.7", + "Port": 5432, + "MasterUsername": "postgres", + "PreferredBackupWindow": "09:33-10:03", + "PreferredMaintenanceWindow": "sun:12:22-sun:12:52", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-########", + "Status": "active" + } + ], + "HostedZoneId": "Z1PVIF0EXAMPLE", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6", + "DbClusterResourceId": "cluster-5DSB5IFQDDUVAWOUWM1EXAMPLE", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:newdbcluster", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2020-06-05T15:06:58.634Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false, + "CopyTagsToSnapshot": false, + "CrossAccountClone": false, + "DomainMemberships": [] + } + } + } + ] } }, "com.amazonaws.rds#RestoreDBClusterFromSnapshotMessage": { @@ -20472,7 +24160,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#RestoreDBClusterFromSnapshotResult": { @@ -20498,6 +24187,9 @@ { "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" }, + { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault" + }, { "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, @@ -20551,7 +24243,66 @@ } ], "traits": { - "smithy.api#documentation": "

    Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.

    \n \n

    For Aurora, this action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime action has completed and the DB\n cluster is available.

    \n     \n

    For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

    " + "smithy.api#documentation": "

    Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.

    \n \n

    For Aurora, this action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime action has completed and the DB\n cluster is available.

    \n     \n

    For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

    \n

    For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

    ", + "smithy.api#examples": [ + { + "title": "To restore a DB cluster to a specified time", + "documentation": "The following example restores the DB cluster named database-4 to the latest possible time. Using copy-on-write as the restore type restores the new DB cluster as a clone of the source DB cluster.", + "input": { + "DBClusterIdentifier": "sample-cluster-clone", + "RestoreType": "copy-on-write", + "SourceDBClusterIdentifier": "database-4", + "UseLatestRestorableTime": true + }, + "output": { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-west-2c", + "us-west-2a", + "us-west-2b" + ], + "BackupRetentionPeriod": 7, + "DatabaseName": "", + "DBClusterIdentifier": "sample-cluster-clone", + "DBClusterParameterGroup": "default.aurora-postgresql10", + "DBSubnetGroup": "default", + "Status": "creating", + "Endpoint": "sample-cluster-clone.cluster-############.us-west-2.rds.amazonaws.com", + "ReaderEndpoint": "sample-cluster-clone.cluster-ro-############.us-west-2.rds.amazonaws.com", + "MultiAZ": false, + "Engine": "aurora-postgresql", + "EngineVersion": "10.7", + "Port": 5432, + "MasterUsername": "postgres", + "PreferredBackupWindow": "09:33-10:03", + "PreferredMaintenanceWindow": "sun:12:22-sun:12:52", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-########", + "Status": "active" + } + ], + "HostedZoneId": "Z1PVIF0EXAMPLE", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6", + "DbClusterResourceId": "cluster-BIZ77GDSA2XBSTNPFW1EXAMPLE", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-clone", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "CloneGroupId": "8d19331a-099a-45a4-b4aa-11aa22bb33cc44dd", + "ClusterCreateTime": "2020-03-10T19:57:38.967Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false, + "CopyTagsToSnapshot": false, + "CrossAccountClone": false + } + } + } + ] } }, "com.amazonaws.rds#RestoreDBClusterToPointInTimeMessage": { @@ -20573,8 +24324,7 @@ "SourceDBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The identifier of the source DB cluster from which to restore.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing DBCluster.

      \n
      • \n
    \n

    Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    The identifier of the source DB cluster from which to restore.

    \n

    Constraints:

    \n
      \n
    • \n

      Must match the identifier of an existing DBCluster.

      \n
      • \n
    \n

    Valid for: Aurora DB clusters and Multi-AZ DB clusters

    " } }, "RestoreToTime": { @@ -20715,10 +24465,17 @@ "traits": { "smithy.api#documentation": "

    The network type of the DB cluster.

    \n

    Valid values:

    \n
      \n
    • \n

      \n IPV4\n

      \n
      • \n
    • \n

      \n DUAL\n

      \n
      • \n
    \n

    The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

    \n

    For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

    \n

    Valid for: Aurora DB clusters only

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

    The resource ID of the source DB cluster from which to restore.

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

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#RestoreDBClusterToPointInTimeResult": { @@ -20809,7 +24566,38 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most\n of the source's original configuration, including the default security group and DB parameter group. By default, the new DB\n instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group\n associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

    \n

    If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance\n before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you\n have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as\n the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original\n DB instance with the DB instance created from the snapshot.

    \n

    If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.

    \n \n

    This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

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

    Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most\n of the source's original configuration, including the default security group and DB parameter group. By default, the new DB\n instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group\n associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

    \n

    If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance\n before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you\n have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as\n the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original\n DB instance with the DB instance created from the snapshot.

    \n

    If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.

    \n \n

    This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

    \n     ", + "smithy.api#examples": [ + { + "title": "To restore a DB instance from a DB snapshot", + "documentation": "The following example creates a new DB instance named db7-new-instance with the db.t3.small DB instance class from the specified DB snapshot. The source DB instance from which the snapshot was taken uses a deprecated DB instance class, so you can't upgrade it.", + "input": { + "DBInstanceIdentifier": "db7-new-instance", + "DBSnapshotIdentifier": "db7-test-snapshot", + "DBInstanceClass": "db.t3.small" + }, + "output": { + "DBInstance": { + "DBInstanceIdentifier": "db7-new-instance", + "DBInstanceClass": "db.t3.small", + "Engine": "mysql", + "DBInstanceStatus": "creating", + "PreferredMaintenanceWindow": "mon:07:37-mon:08:07", + "PendingModifiedValues": {}, + "MultiAZ": false, + "EngineVersion": "5.7.22", + "AutoMinorVersionUpgrade": true, + "ReadReplicaDBInstanceIdentifiers": [], + "LicenseModel": "general-public-license", + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:db7-new-instance", + "IAMDatabaseAuthenticationEnabled": false, + "PerformanceInsightsEnabled": false, + "DeletionProtection": false, + "AssociatedRoles": [] + } + } + } + ] } }, "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotMessage": { @@ -21049,7 +24837,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotResult": { @@ -21429,6 +25218,9 @@ "smithy.api#documentation": "

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

    \n

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

    \n

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

    \n

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

    \n

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

    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#RestoreDBInstanceFromS3Result": { @@ -21522,7 +25314,97 @@ } ], "traits": { - "smithy.api#documentation": "

    Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

    \n

    The target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.

    \n \n

    This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

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

    Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

    \n

    The target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.

    \n \n

    This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

    \n     ", + "smithy.api#examples": [ + { + "title": "To restore a DB instance to a point in time", + "documentation": "The following example restores test-instance to a new DB instance named restored-test-instance, as of the specified time.", + "input": { + "SourceDBInstanceIdentifier": "test-instance", + "TargetDBInstanceIdentifier": "restored-test-instance", + "RestoreTime": "2018-07-30T23:45:00.000Z" + }, + "output": { + "DBInstance": { + "PubliclyAccessible": true, + "MasterUsername": "mymasteruser", + "MonitoringInterval": 0, + "LicenseModel": "general-public-license", + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-e5e5b0d2" + } + ], + "CopyTagsToSnapshot": false, + "OptionGroupMemberships": [ + { + "Status": "in-sync", + "OptionGroupName": "default:mysql-5-6" + } + ], + "PendingModifiedValues": {}, + "Engine": "mysql", + "MultiAZ": false, + "DBSecurityGroups": [], + "DBParameterGroups": [ + { + "DBParameterGroupName": "default.mysql5.6", + "ParameterApplyStatus": "in-sync" + } + ], + "AutoMinorVersionUpgrade": true, + "PreferredBackupWindow": "12:58-13:28", + "DBSubnetGroup": { + "Subnets": [ + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-77e8db03", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-c39989a1", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-4b267b0d", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + } + } + ], + "DBSubnetGroupName": "default", + "VpcId": "vpc-c1c5b3a3", + "DBSubnetGroupDescription": "default", + "SubnetGroupStatus": "Complete" + }, + "ReadReplicaDBInstanceIdentifiers": [], + "AllocatedStorage": 200, + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:restored-test-instance", + "BackupRetentionPeriod": 7, + "DBName": "sample", + "PreferredMaintenanceWindow": "tue:10:16-tue:10:46", + "DBInstanceStatus": "available", + "EngineVersion": "5.6.27", + "AvailabilityZone": "us-west-2b", + "DomainMemberships": [], + "StorageType": "gp2", + "DbiResourceId": "db-VNZUCCBTEDC4WR7THXNJO72HVQ", + "CACertificateIdentifier": "rds-ca-2015", + "StorageEncrypted": false, + "DBInstanceClass": "db.t2.small", + "DbInstancePort": 0, + "DBInstanceIdentifier": "restored-test-instance" + } + } + } + ] } }, "com.amazonaws.rds#RestoreDBInstanceToPointInTimeMessage": { @@ -21787,7 +25669,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#RestoreDBInstanceToPointInTimeResult": { @@ -21841,7 +25724,20 @@ } ], "traits": { - "smithy.api#documentation": "

    Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required \n parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either \n EC2SecurityGroupName or EC2SecurityGroupId).

    \n \n

    EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

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

    Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required \n parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either \n EC2SecurityGroupName or EC2SecurityGroupId).

    \n \n

    EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

    \n     ", + "smithy.api#examples": [ + { + "title": "To revoke ingress for a DB security group", + "documentation": "This example revokes ingress for the specified CIDR block associated with the specified DB security group.", + "input": { + "DBSecurityGroupName": "mydbsecuritygroup", + "CIDRIP": "203.0.113.5/32" + }, + "output": { + "DBSecurityGroup": {} + } + } + ] } }, "com.amazonaws.rds#RevokeDBSecurityGroupIngressMessage": { @@ -21880,7 +25776,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#input": {} } }, "com.amazonaws.rds#RevokeDBSecurityGroupIngressResult": { @@ -22226,7 +26123,8 @@ } }, "traits": { - "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeSourceRegions action.

    " + "smithy.api#documentation": "

    Contains the result of a successful invocation of the DescribeSourceRegions action.

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#SourceType": { @@ -22317,7 +26215,26 @@ } ], "traits": { - "smithy.api#documentation": "

    Starts a database activity stream to monitor activity on the database.\n For more information, see \n \n Monitoring Amazon Aurora with Database Activity Streams\n in the Amazon Aurora User Guide or\n \n Monitoring Amazon RDS with Database Activity Streams\n in the Amazon RDS User Guide.

    " + "smithy.api#documentation": "

    Starts a database activity stream to monitor activity on the database.\n For more information, see \n \n Monitoring Amazon Aurora with Database Activity Streams\n in the Amazon Aurora User Guide or\n \n Monitoring Amazon RDS with Database Activity Streams\n in the Amazon RDS User Guide.

    ", + "smithy.api#examples": [ + { + "title": "To start a database activity stream", + "documentation": "The following example starts an asynchronous activity stream to monitor an Aurora cluster named my-pg-cluster.", + "input": { + "ResourceArn": "arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster", + "Mode": "async", + "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", + "ApplyImmediately": true + }, + "output": { + "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", + "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S", + "Status": "starting", + "Mode": "async", + "ApplyImmediately": true + } + } + ] } }, "com.amazonaws.rds#StartActivityStreamRequest": { @@ -22426,7 +26343,29 @@ } ], "traits": { - "smithy.api#documentation": "

    Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster\n CLI command, or the StopDBCluster action.

    \n

    For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

    \n \n

    This action only applies to Aurora DB clusters.

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

    Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster\n CLI command, or the StopDBCluster action.

    \n

    For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

    \n \n

    This action only applies to Aurora DB clusters.

    \n     ", + "smithy.api#examples": [ + { + "title": "To start a DB cluster", + "documentation": "The following example starts a DB cluster and its DB instances.", + "input": { + "DBClusterIdentifier": "mydbcluster" + }, + "output": { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-east-1a", + "us-east-1e", + "us-east-1b" + ], + "BackupRetentionPeriod": 1, + "DatabaseName": "mydb", + "DBClusterIdentifier": "mydbcluster" + } + } + } + ] } }, "com.amazonaws.rds#StartDBClusterMessage": { @@ -22439,6 +26378,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#StartDBClusterResult": { @@ -22496,7 +26438,21 @@ } ], "traits": { - "smithy.api#documentation": "

    Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.

    \n

    For more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n

    \n \n

    This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.

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

    Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.

    \n

    For more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n

    \n \n

    This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.

    \n     ", + "smithy.api#examples": [ + { + "title": "To start a DB instance", + "documentation": "The following example starts the specified DB instance.", + "input": { + "DBInstanceIdentifier": "test-instance" + }, + "output": { + "DBInstance": { + "DBInstanceStatus": "starting" + } + } + } + ] } }, "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplication": { @@ -22525,7 +26481,40 @@ } ], "traits": { - "smithy.api#documentation": "

    Enables replication of automated backups to a different Amazon Web Services Region.

    \n

    This command doesn't apply to RDS Custom.

    \n

    For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

    " + "smithy.api#documentation": "

    Enables replication of automated backups to a different Amazon Web Services Region.

    \n

    This command doesn't apply to RDS Custom.

    \n

    For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

    ", + "smithy.api#examples": [ + { + "title": "To enable cross-Region automated backups", + "documentation": "The following example replicates automated backups from a DB instance in the US East (N. Virginia) Region. The backup retention period is 14 days.", + "input": { + "SourceDBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "BackupRetentionPeriod": 14 + }, + "output": { + "DBInstanceAutomatedBackup": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", + "Region": "us-east-1", + "DBInstanceIdentifier": "new-orcl-db", + "RestoreWindow": {}, + "AllocatedStorage": 20, + "Status": "pending", + "Port": 1521, + "InstanceCreateTime": "2020-12-04T15:28:31Z", + "MasterUsername": "admin", + "Engine": "oracle-se2", + "EngineVersion": "12.1.0.2.v21", + "LicenseModel": "bring-your-own-license", + "OptionGroupName": "default:oracle-se2-12-1", + "Encrypted": false, + "StorageType": "gp2", + "IAMDatabaseAuthenticationEnabled": false, + "BackupRetentionPeriod": 14, + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + } + } + } + ] } }, "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationMessage": { @@ -22556,6 +26545,9 @@ "smithy.api#documentation": "

    In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request \n for the StartDBInstanceAutomatedBackupsReplication operation to call \n in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the\n StartDBInstanceAutomatedBackupsReplication API operation that can run in \n the Amazon Web Services Region that contains the source DB instance.

    \n

    This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

    \n

    To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

    \n \n

    If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

    \n     " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationResult": { @@ -22579,6 +26571,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#StartDBInstanceResult": { @@ -22633,7 +26628,31 @@ } ], "traits": { - "smithy.api#documentation": "

    Starts an export of DB snapshot or DB cluster data to Amazon S3. \n The provided IAM role must have access to the S3 bucket.

    \n

    You can't export snapshot data from RDS Custom DB instances.

    \n

    You can't export cluster data from Multi-AZ DB clusters.

    \n

    For more information on exporting DB snapshot data, see \n Exporting DB snapshot \n data to Amazon S3 in the Amazon RDS User Guide\n or Exporting DB \n cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.

    \n

    For more information on exporting DB cluster data, see \n Exporting DB \n cluster data to Amazon S3 in the Amazon Aurora User Guide.

    " + "smithy.api#documentation": "

    Starts an export of DB snapshot or DB cluster data to Amazon S3. \n The provided IAM role must have access to the S3 bucket.

    \n

    You can't export snapshot data from RDS Custom DB instances.

    \n

    You can't export cluster data from Multi-AZ DB clusters.

    \n

    For more information on exporting DB snapshot data, see \n Exporting DB snapshot \n data to Amazon S3 in the Amazon RDS User Guide\n or Exporting DB \n cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.

    \n

    For more information on exporting DB cluster data, see \n Exporting DB \n cluster data to Amazon S3 in the Amazon Aurora User Guide.

    ", + "smithy.api#examples": [ + { + "title": "To export a snapshot to Amazon S3", + "documentation": "The following example exports a DB snapshot named db5-snapshot-test to the Amazon S3 bucket named mybucket.", + "input": { + "ExportTaskIdentifier": "my-s3-export", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test", + "S3BucketName": "mybucket", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff" + }, + "output": { + "ExportTaskIdentifier": "my-s3-export", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test", + "SnapshotTime": "2020-03-27T20:48:42.023Z", + "S3Bucket": "mybucket", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", + "Status": "STARTING", + "PercentProgress": 0, + "TotalExtractedDataInGB": 0 + } + } + ] } }, "com.amazonaws.rds#StartExportTaskMessage": { @@ -22686,6 +26705,9 @@ "smithy.api#documentation": "

    The data to be exported from the snapshot or cluster. \n If this parameter is not provided, all of the data is exported.\n Valid values are the following:

    \n
      \n
    • \n

      \n database - Export all the data from a specified database.

      \n
      • \n
    • \n

      \n database.table\n table-name - \n Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

      \n
      • \n
    • \n

      \n database.schema\n schema-name - Export a database schema of the snapshot or cluster. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

      \n
      • \n
    • \n

      \n database.schema.table\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

      \n
      • \n
    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#StopActivityStream": { @@ -22714,7 +26736,22 @@ } ], "traits": { - "smithy.api#documentation": "

    Stops a database activity stream that was started using the Amazon Web Services console, \n the start-activity-stream CLI command, or the StartActivityStream action.

    \n

    For more information, see \n \n Monitoring Amazon Aurora with Database Activity Streams\n in the Amazon Aurora User Guide\n or \n Monitoring Amazon RDS with Database Activity Streams\n in the Amazon RDS User Guide.

    " + "smithy.api#documentation": "

    Stops a database activity stream that was started using the Amazon Web Services console, \n the start-activity-stream CLI command, or the StartActivityStream action.

    \n

    For more information, see \n \n Monitoring Amazon Aurora with Database Activity Streams\n in the Amazon Aurora User Guide\n or \n Monitoring Amazon RDS with Database Activity Streams\n in the Amazon RDS User Guide.

    ", + "smithy.api#examples": [ + { + "title": "To stop a database activity stream", + "documentation": "The following example stops an activity stream in an Aurora cluster named my-pg-cluster.", + "input": { + "ResourceArn": "arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster", + "ApplyImmediately": true + }, + "output": { + "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", + "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S", + "Status": "stopping" + } + } + ] } }, "com.amazonaws.rds#StopActivityStreamRequest": { @@ -22784,7 +26821,29 @@ } ], "traits": { - "smithy.api#documentation": "

    Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's\n metadata, including its endpoints and DB parameter groups. Aurora also\n retains the transaction logs so you can do a point-in-time restore if necessary.

    \n

    For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

    \n \n

    This action only applies to Aurora DB clusters.

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

    Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's\n metadata, including its endpoints and DB parameter groups. Aurora also\n retains the transaction logs so you can do a point-in-time restore if necessary.

    \n

    For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

    \n \n

    This action only applies to Aurora DB clusters.

    \n     ", + "smithy.api#examples": [ + { + "title": "To stop a DB cluster", + "documentation": "The following example stops a DB cluster and its DB instances.", + "input": { + "DBClusterIdentifier": "mydbcluster" + }, + "output": { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-east-1a", + "us-east-1e", + "us-east-1b" + ], + "BackupRetentionPeriod": 1, + "DatabaseName": "mydb", + "DBClusterIdentifier": "mydbcluster" + } + } + } + ] } }, "com.amazonaws.rds#StopDBClusterMessage": { @@ -22797,6 +26856,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#StopDBClusterResult": { @@ -22836,7 +26898,21 @@ } ], "traits": { - "smithy.api#documentation": "

    Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, \n DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if \n necessary.

    \n

    For more information, see \n \n Stopping an Amazon RDS DB Instance Temporarily in the \n Amazon RDS User Guide.\n

    \n \n

    This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora clusters, use StopDBCluster instead.

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

    Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, \n DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if \n necessary.

    \n

    For more information, see \n \n Stopping an Amazon RDS DB Instance Temporarily in the \n Amazon RDS User Guide.\n

    \n \n

    This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora clusters, use StopDBCluster instead.

    \n     ", + "smithy.api#examples": [ + { + "title": "To stop a DB instance", + "documentation": "The following example stops the specified DB instance.", + "input": { + "DBInstanceIdentifier": "test-instance" + }, + "output": { + "DBInstance": { + "DBInstanceStatus": "stopping" + } + } + } + ] } }, "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplication": { @@ -22856,7 +26932,42 @@ } ], "traits": { - "smithy.api#documentation": "

    Stops automated backup replication for a DB instance.

    \n

    This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.

    \n

    For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

    " + "smithy.api#documentation": "

    Stops automated backup replication for a DB instance.

    \n

    This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.

    \n

    For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

    ", + "smithy.api#examples": [ + { + "title": "To stop replicating automated backups", + "documentation": "The following example ends replication of automated backups. Replicated backups are retained according to the set backup retention period.", + "input": { + "SourceDBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db" + }, + "output": { + "DBInstanceAutomatedBackup": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", + "Region": "us-east-1", + "DBInstanceIdentifier": "new-orcl-db", + "RestoreWindow": { + "EarliestTime": "2020-12-04T23:13:21.030Z", + "LatestTime": "2020-12-07T19:59:57Z" + }, + "AllocatedStorage": 20, + "Status": "replicating", + "Port": 1521, + "InstanceCreateTime": "2020-12-04T15:28:31Z", + "MasterUsername": "admin", + "Engine": "oracle-se2", + "EngineVersion": "12.1.0.2.v21", + "LicenseModel": "bring-your-own-license", + "OptionGroupName": "default:oracle-se2-12-1", + "Encrypted": false, + "StorageType": "gp2", + "IAMDatabaseAuthenticationEnabled": false, + "BackupRetentionPeriod": 7, + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + } + } + } + ] } }, "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage": { @@ -22869,6 +26980,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationResult": { @@ -22898,6 +27012,9 @@ "smithy.api#documentation": "

    The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

    " } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#StopDBInstanceResult": { @@ -23231,6 +27348,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.rds#SwitchoverReadReplicaResult": { @@ -23298,7 +27418,8 @@ } }, "traits": { - "smithy.api#documentation": "

    " + "smithy.api#documentation": "

    ", + "smithy.api#output": {} } }, "com.amazonaws.rds#TargetDBClusterParameterGroupName": { @@ -23545,6 +27666,12 @@ "traits": { "smithy.api#documentation": "

    A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.

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

    A value that indicates whether the target engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

    \n

    Valid for: Aurora DB clusters only

    " + } } }, "traits": { diff --git a/codegen/sdk/aws-models/rekognition.json b/codegen/sdk/aws-models/rekognition.json index d42a1cdaeced..4693921e0c78 100644 --- a/codegen/sdk/aws-models/rekognition.json +++ b/codegen/sdk/aws-models/rekognition.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.

    ", + "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\n returned. Use ClientRequestToken to prevent the same request from being processed more than\n once.

    ", "smithy.api#idempotencyToken": {} } } @@ -402,7 +402,7 @@ "Bytes": { "target": "com.amazonaws.rekognition#LivenessImageBlob", "traits": { - "smithy.api#documentation": "

    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.

    \n

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

    \n

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

    \n

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

    \n

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

    \n

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

    \n

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

    " + "smithy.api#documentation": "

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

    \n

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

    \n

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

    \n

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

    \n

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

    \n

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

    \n

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

    ", + "smithy.api#examples": [ + { + "title": "To create an Amazon Rekognition Custom Labels dataset", + "documentation": "Creates an Amazon Rekognition Custom Labels dataset with a manifest file stored in an Amazon S3 bucket.", + "input": { + "DatasetSource": { + "GroundTruthManifest": { + "S3Object": { + "Bucket": "my-bucket", + "Name": "datasets/flowers_training/manifests/output/output.manifest" + } + } + }, + "DatasetType": "TRAIN", + "ProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815" + }, + "output": { + "DatasetArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/train/1690476084535" + } + } + ] } }, "com.amazonaws.rekognition#CreateDatasetRequest": { @@ -1481,7 +1502,7 @@ "DatasetType": { "target": "com.amazonaws.rekognition#DatasetType", "traits": { - "smithy.api#documentation": "

    \nThe type of the dataset. Specify train to create a training dataset. Specify test \n to create a test dataset.\n

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

    \nThe type of the dataset. Specify TRAIN to create a training dataset. Specify TEST \n to create a test dataset.\n

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

    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.

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

    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.

    \n

    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.

    \n

    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.

    ", "smithy.api#idempotent": {} } }, @@ -1547,7 +1568,7 @@ "KmsKeyId": { "target": "com.amazonaws.rekognition#KmsKeyId", "traits": { - "smithy.api#documentation": "

    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.

    \n

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

    " + "smithy.api#documentation": "

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

    \n

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

    ", + "smithy.api#examples": [ + { + "title": "To create an Amazon Rekognition Custom Labels project", + "documentation": "Creates an Amazon Rekognition Custom Labels project.", + "input": { + "ProjectName": "my-project" + }, + "output": { + "ProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690405809285" + } + } + ] } }, "com.amazonaws.rekognition#CreateProjectRequest": { @@ -1704,7 +1737,24 @@ } ], "traits": { - "smithy.api#documentation": "

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

    \n

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

    \n \n

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

    \n

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

    \n

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

    \n     \n

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

    \n

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

    \n

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

    \n

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

    \n

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

    " + "smithy.api#documentation": "

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

    \n

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

    \n \n

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

    \n

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

    \n

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

    \n     \n

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

    \n

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

    \n

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

    \n

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

    \n

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

    ", + "smithy.api#examples": [ + { + "title": "To train an Amazon Rekognition Custom Labels model", + "documentation": "Trains a version of an Amazon Rekognition Custom Labels model.", + "input": { + "ProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815", + "VersionName": "1", + "OutputConfig": { + "S3Bucket": "output_bucket", + "S3KeyPrefix": "output_folder" + } + }, + "output": { + "ProjectVersionArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958" + } + } + ] } }, "com.amazonaws.rekognition#CreateProjectVersionRequest": { @@ -1934,7 +1984,7 @@ } ], "traits": { - "smithy.api#documentation": "

    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.

    \n

    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.

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

    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.

    \n

    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.

    ", "smithy.api#examples": [ { "title": "CreateUser", @@ -1967,7 +2017,7 @@ "ClientRequestToken": { "target": "com.amazonaws.rekognition#ClientRequestToken", "traits": { - "smithy.api#documentation": "

    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.

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

    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.

    ", "smithy.api#idempotencyToken": {} } } @@ -2474,7 +2524,17 @@ } ], "traits": { - "smithy.api#documentation": "

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

    \n

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

    \n

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

    " + "smithy.api#documentation": "

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

    \n

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

    \n

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

    ", + "smithy.api#examples": [ + { + "title": "To delete an Amazon Rekognition Custom Labels dataset", + "documentation": "Deletes an Amazon Rekognition Custom Labels dataset.", + "input": { + "DatasetArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/test/1690556733321" + }, + "output": {} + } + ] } }, "com.amazonaws.rekognition#DeleteDatasetRequest": { @@ -2622,7 +2682,19 @@ } ], "traits": { - "smithy.api#documentation": "

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

    \n

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

    \n

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

    " + "smithy.api#documentation": "

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

    \n

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

    \n

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

    ", + "smithy.api#examples": [ + { + "title": "To delete an Amazon Rekognition Custom Labels project", + "documentation": "Deletes an Amazon Rekognition Custom Labels projects.", + "input": { + "ProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690405809285" + }, + "output": { + "Status": "DELETING" + } + } + ] } }, "com.amazonaws.rekognition#DeleteProjectPolicy": { @@ -2768,7 +2840,19 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes an Amazon Rekognition Custom Labels model.

    \n

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

    \n

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

    " + "smithy.api#documentation": "

    Deletes an Amazon Rekognition Custom Labels model.

    \n

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

    \n

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

    ", + "smithy.api#examples": [ + { + "title": "To delete an Amazon Rekognition Custom Labels model", + "documentation": "Deletes a version of an Amazon Rekognition Custom Labels model.", + "input": { + "ProjectVersionArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958" + }, + "output": { + "Status": "DELETING" + } + } + ] } }, "com.amazonaws.rekognition#DeleteProjectVersionRequest": { @@ -2926,7 +3010,7 @@ "ClientRequestToken": { "target": "com.amazonaws.rekognition#ClientRequestToken", "traits": { - "smithy.api#documentation": "

    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.

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

    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.

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

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

    \n

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

    \n

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

    \n

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

    \n

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

    \n

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

    \n

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

    \n

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

    \n

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

    " + "smithy.api#documentation": "

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

    \n

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

    \n

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

    \n

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

    \n

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

    \n

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

    \n

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

    \n

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

    \n

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

    ", + "smithy.api#examples": [ + { + "title": "To detect custom labels in an image with an Amazon Rekognition Custom Labels model", + "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.

    \n

    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).

    " + "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.

    \n

    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).

    \n

    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.

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

    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.

    \n

    For an example, see Analyzing images stored in an Amazon S3 bucket in the\n Amazon Rekognition Developer Guide.

    \n

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

    \n

    \n Optional Parameters\n

    \n

    You 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.

    \n

    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.

    \n

    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

    \n Response Elements\n

    \n

    For each object, scene, and concept the API returns one or more labels. The API\n returns the following types of information about labels:

    \n
      \n
    • \n

      Name - The name of the detected label.

      \n
      • \n
    • \n

      Confidence - The level of confidence in the label assigned to a detected object.\n

      \n
      • \n
    • \n

      Parents - 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.

      \n
      • \n
    • \n

      Aliases - Possible Aliases for the label.

      \n
      • \n
    • \n

      Categories - The label categories that the detected label belongs to.

      \n
      • \n
    • \n

      BoundingBox — 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.

      \n
      • \n
    \n

    The API returns the following information regarding the image, as part of the\n ImageProperties structure:

    \n
      \n
    • \n

      Quality - 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.

      \n
      • \n
    • \n

      Dominant Color - An array of the dominant colors in the image.

      \n
      • \n
    • \n

      Foreground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground.

      \n
      • \n
    • \n

      Background - Information about the sharpness, brightness, and dominant colors of the input image’s background.

      \n
      • \n
    \n

    The 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

    \n {Name: rock,Confidence: 79.2097}\n

    \n

    \n {Name: sea,Confidence: 75.061}\n

    \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

    \n {Name: plant,Confidence: 99.0562}\n

    \n

    \n {Name: tulip,Confidence: 99.0562}\n

    \n

    In this example, the detection algorithm more precisely identifies the flower as a\n tulip.

    \n \n

    If the object detected is a person, the operation doesn't provide the same facial\n details that the DetectFaces operation provides.

    \n     \n

    This is a stateless API operation that doesn't return any data.

    \n

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

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

    Detects instances of real-world entities within an image (JPEG or PNG) 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.

    \n

    For an example, see Analyzing images stored in an Amazon S3 bucket in the\n Amazon Rekognition Developer Guide.

    \n

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

    \n

    \n Optional Parameters\n

    \n

    You 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.

    \n

    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.

    \n

    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

    \n Response Elements\n

    \n

    For each object, scene, and concept the API returns one or more labels. The API\n returns the following types of information about labels:

    \n
      \n
    • \n

      Name - The name of the detected label.

      \n
      • \n
    • \n

      Confidence - The level of confidence in the label assigned to a detected object.\n

      \n
      • \n
    • \n

      Parents - 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.

      \n
      • \n
    • \n

      Aliases - Possible Aliases for the label.

      \n
      • \n
    • \n

      Categories - The label categories that the detected label belongs to.

      \n
      • \n
    • \n

      BoundingBox — 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.

      \n
      • \n
    \n

    The API returns the following information regarding the image, as part of the\n ImageProperties structure:

    \n
      \n
    • \n

      Quality - 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.

      \n
      • \n
    • \n

      Dominant Color - An array of the dominant colors in the image.

      \n
      • \n
    • \n

      Foreground - Information about the sharpness, brightness, and dominant colors of the\n input image’s foreground.

      \n
      • \n
    • \n

      Background - Information about the sharpness, brightness, and dominant colors of the\n input image’s background.

      \n
      • \n
    \n

    The 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

    \n {Name: rock,Confidence: 79.2097}\n

    \n

    \n {Name: sea,Confidence: 75.061}\n

    \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

    \n {Name: plant,Confidence: 99.0562}\n

    \n

    \n {Name: tulip,Confidence: 99.0562}\n

    \n

    In this example, the detection algorithm more precisely identifies the flower as a\n tulip.

    \n \n

    If the object detected is a person, the operation doesn't provide the same facial\n details that the DetectFaces operation provides.

    \n     \n

    This is a stateless API operation that doesn't return any data.

    \n

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

    ", "smithy.api#examples": [ { "title": "To detect labels", @@ -3800,7 +3913,7 @@ "DominantColors": { "target": "com.amazonaws.rekognition#DominantColors", "traits": { - "smithy.api#documentation": "

    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.

    \n

    If MinConfidence is not specified, the operation returns labels with a\n confidence values greater than or equal to 55 percent.

    " + "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.

    \n

    If 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.

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

    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

    \n

    You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. \n The training dataset must contain the images that you want to split. The test dataset \n must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset.

    \n

    Distributing a dataset takes a while to complete. To check the status call DescribeDataset. The operation\n is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. \n If the dataset split fails, the value of Status is UPDATE_FAILED.

    \n

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

    " + "smithy.api#documentation": "

    Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project.\n DistributeDatasetEntries moves 20% of the training dataset images to the test dataset.\n An entry is a JSON Line that describes an image.\n

    \n

    You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. \n The training dataset must contain the images that you want to split. The test dataset \n must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset.

    \n

    Distributing a dataset takes a while to complete. To check the status call DescribeDataset. The operation\n is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. \n If the dataset split fails, the value of Status is UPDATE_FAILED.

    \n

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

    ", + "smithy.api#examples": [ + { + "title": "To distribute an Amazon Rekognition Custom Labels dataset", + "documentation": "Distributes an Amazon Rekognition Custom Labels training dataset to a test dataset.", + "input": { + "Datasets": [ + { + "Arn": "arn:aws:rekognition:us-east-1:111122223333:project/my-proj-2/dataset/train/1690564858106" + }, + { + "Arn": "arn:aws:rekognition:us-east-1:111122223333:project/my-proj-2/dataset/test/1690564858106" + } + ] + }, + "output": {} + } + ] } }, "com.amazonaws.rekognition#DistributeDatasetEntriesRequest": { @@ -4786,7 +4916,7 @@ } }, "traits": { - "smithy.api#documentation": "

    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.

    \n

    Face 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

    \n GetFaceDetection returns an array of detected faces (Faces) sorted by the time the faces were detected.

    \n

    Use MaxResults parameter to limit the number of labels returned. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a 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.

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

    Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.

    \n

    Face 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

    \n GetFaceDetection returns an array of detected faces (Faces) sorted by the time the faces were detected.

    \n

    Use MaxResults parameter to limit the number of labels returned. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a 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.

    \n

    Note that for the GetFaceDetection operation, the returned values for\n FaceOccluded and EyeDirection will always be \"null\".

    ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5770,7 +5900,7 @@ "JobId": { "target": "com.amazonaws.rekognition#JobId", "traits": { - "smithy.api#documentation": "

    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.

    " + "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.

    \n

    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.

    " } }, "com.amazonaws.rekognition#GetFaceLivenessSessionResultsRequest": { @@ -5854,7 +5984,7 @@ "Confidence": { "target": "com.amazonaws.rekognition#Percent", "traits": { - "smithy.api#documentation": "

    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.

    \n

    Text 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

    \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.

    \n

    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.

    \n

    Use 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.

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

    Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.

    \n

    Text 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

    \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.

    \n

    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.

    \n

    Use 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.

    ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6528,7 +6658,7 @@ "JobId": { "target": "com.amazonaws.rekognition#JobId", "traits": { - "smithy.api#documentation": "

    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.

    " + "smithy.api#documentation": "

    Blob of image bytes up to 5 MBs. Note that the maximum image size you can\n pass to DetectCustomLabels is 4MB.

    " } }, "S3Object": { @@ -7405,7 +7535,7 @@ "Instances": { "target": "com.amazonaws.rekognition#Instances", "traits": { - "smithy.api#documentation": "

    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.

    " + "smithy.api#documentation": "

    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.

    " } }, "Parents": { @@ -7428,7 +7558,7 @@ } }, "traits": { - "smithy.api#documentation": "

    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.

    \n

    JSON Lines in the response include information about non-terminal\n errors found in the dataset. \n Non terminal errors are reported in errors lists within each JSON Line. The\n same information is reported in the training and testing validation result manifests that\n Amazon Rekognition Custom Labels creates during model training.\n

    \n

    You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.\n

    \n

    This operation requires permissions to perform the rekognition:ListDatasetEntries action.

    ", + "smithy.api#examples": [ + { + "title": "To list the entries in an Amazon Rekognition Custom Labels dataset", + "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", + "ContainsLabels": [ + "camellia" + ], + "Labeled": true, + "SourceRefContains": "camellia4.jpg", + "HasErrors": true, + "NextToken": "", + "MaxResults": 100 + }, + "output": { + "DatasetEntries": [ + "{\"source-ref\":\"s3://custom-labels-console-us-east-1-1111111111/assets/flowers_1_train_dataset/camellia4.jpg\",\"camellia\":1,\"camellia-metadata\":{\"confidence\":1,\"job-name\":\"labeling-job/camellia\",\"class-name\":\"camellia\",\"human-annotated\":\"yes\",\"creation-date\":\"2021-07-11T03:32:13.456Z\",\"type\":\"groundtruth/image-classification\"},\"with_leaves\":1,\"with_leaves-metadata\":{\"confidence\":1,\"job-name\":\"labeling-job/with_leaves\",\"class-name\":\"with_leaves\",\"human-annotated\":\"yes\",\"creation-date\":\"2021-07-11T03:32:13.456Z\",\"type\":\"groundtruth/image-classification\"},\"cl-metadata\":{\"is_labeled\":true}}" + ], + "NextToken": "" + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8092,6 +8245,39 @@ ], "traits": { "smithy.api#documentation": "

    Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see \n Labeling images.\n

    \n

    \n Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images\n in the Amazon Rekognition Custom Labels Developer Guide.

    ", + "smithy.api#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.

    \n

    The 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.

    \n

    Information 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.

    ", + "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.

    \n

    The 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.

    \n

    Information 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.

    ", "smithy.api#examples": [ { "title": "SearchUsersByImage", @@ -11931,13 +12081,13 @@ "SearchedFace": { "target": "com.amazonaws.rekognition#SearchedFaceDetails", "traits": { - "smithy.api#documentation": "

    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.

    \n

    Once the model is running, you can detect custom labels in new images by calling \n DetectCustomLabels.

    \n \n

    You are charged for the amount of time that the model is running. To stop a running\n model, call StopProjectVersion.

    \n     \n

    For more information, see Running a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels Guide.

    \n

    This operation requires permissions to perform the \n rekognition:StartProjectVersion action.

    " + "smithy.api#documentation": "

    Starts the running of the version of a model. Starting a model takes a while\n to complete. To check the current state of the model, use DescribeProjectVersions.

    \n

    Once the model is running, you can detect custom labels in new images by calling \n DetectCustomLabels.

    \n \n

    You are charged for the amount of time that the model is running. To stop a running\n model, call StopProjectVersion.

    \n     \n

    For more information, see Running a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels Guide.

    \n

    This operation requires permissions to perform the \n rekognition:StartProjectVersion action.

    ", + "smithy.api#examples": [ + { + "title": "To start an Amazon Rekognition Custom Labels model", + "documentation": "Starts a version of an Amazon Rekognition Custom Labels model.", + "input": { + "ProjectVersionArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958", + "MinInferenceUnits": 1, + "MaxInferenceUnits": 1 + }, + "output": { + "Status": "STARTING" + } + } + ] } }, "com.amazonaws.rekognition#StartProjectVersionRequest": { @@ -13329,7 +13493,19 @@ } ], "traits": { - "smithy.api#documentation": "

    Stops a running model. The operation might take a while to complete. To\n check the current status, call DescribeProjectVersions.

    \n

    This operation requires permissions to perform the rekognition:StopProjectVersion action.

    " + "smithy.api#documentation": "

    Stops a running model. The operation might take a while to complete. To\n check the current status, call DescribeProjectVersions.

    \n

    This operation requires permissions to perform the rekognition:StopProjectVersion action.

    ", + "smithy.api#examples": [ + { + "title": "To stop an Amazon Rekognition Custom Labels model.", + "documentation": "Stops a version of an Amazon Rekognition Custom Labels model.", + "input": { + "ProjectVersionArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958" + }, + "output": { + "Status": "STOPPING" + } + } + ] } }, "com.amazonaws.rekognition#StopProjectVersionRequest": { @@ -14235,7 +14411,7 @@ } }, "traits": { - "smithy.api#documentation": "

    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

    \n

    If the source-ref field in the JSON line references an existing image, the existing image in the dataset\n is updated. \n If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset.

    \n

    You specify the changes that you want to make in the Changes input parameter. \n There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less\nthan 5MB.

    \n

    \n UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete.\n Use DescribeDataset to check the \n current status. The dataset updated successfully if the value of Status is\n UPDATE_COMPLETE.

    \n

    To check if any non-terminal errors occured, call ListDatasetEntries\n and check for the presence of errors lists in the JSON Lines.

    \n

    Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). \n Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.\n

    \n

    This operation requires permissions to perform the rekognition:UpdateDatasetEntries action.

    " + "smithy.api#documentation": "

    Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the\n information for a single image, including\n the image location, assigned labels, and object location bounding boxes. For more information, \n see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.\n

    \n

    If the source-ref field in the JSON line references an existing image, the existing image in the dataset\n is updated. \n If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset.

    \n

    You specify the changes that you want to make in the Changes input parameter. \n There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less\nthan 5MB.

    \n

    \n UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete.\n Use DescribeDataset to check the \n current status. The dataset updated successfully if the value of Status is\n UPDATE_COMPLETE.

    \n

    To check if any non-terminal errors occured, call ListDatasetEntries\n and check for the presence of errors lists in the JSON Lines.

    \n

    Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). \n Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.\n

    \n

    This operation requires permissions to perform the rekognition:UpdateDatasetEntries action.

    ", + "smithy.api#examples": [ + { + "title": "To-add dataset entries to an Amazon Rekognition Custom Labels dataset", + "documentation": "Adds dataset entries to an Amazon Rekognition Custom Labels dataset.", + "input": { + "DatasetArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-proj-2/dataset/train/1690564858106", + "Changes": { + "GroundTruth": "{\"source-ref\":\"s3://custom-labels-console-us-east-1-111111111/assets/flowers_1_test_dataset/mediterranean_spurge4.jpg\",\"mediterranean_spurge\":1,\"mediterranean_spurge-metadata\":{\"confidence\":1,\"job-name\":\"labeling-job/mediterranean_spurge\",\"class-name\":\"mediterranean_spurge\",\"human-annotated\":\"yes\",\"creation-date\":\"2021-07-11T03:33:42.025Z\",\"type\":\"groundtruth/image-classification\"},\"with_leaves\":1,\"with_leaves-metadata\":{\"confidence\":1,\"job-name\":\"labeling-job/with_leaves\",\"class-name\":\"with_leaves\",\"human-annotated\":\"yes\",\"creation-date\":\"2021-07-11T03:33:42.025Z\",\"type\":\"groundtruth/image-classification\"}}" + } + }, + "output": {} + } + ] } }, "com.amazonaws.rekognition#UpdateDatasetEntriesRequest": { diff --git a/codegen/sdk/aws-models/resiliencehub.json b/codegen/sdk/aws-models/resiliencehub.json index 268b0b4957ee..a8cfaef70c87 100644 --- a/codegen/sdk/aws-models/resiliencehub.json +++ b/codegen/sdk/aws-models/resiliencehub.json @@ -43,7 +43,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Adds the resource mapping for the draft application version. You can also update an existing resource mapping to a new physical resource.

    ", + "smithy.api#documentation": "

    Adds the resource mapping for the draft application version. You can also update an\n existing resource mapping to a new physical resource.

    ", "smithy.api#http": { "method": "POST", "uri": "/add-draft-app-version-resource-mappings", @@ -57,7 +57,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -76,7 +76,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -90,7 +90,7 @@ "resourceMappings": { "target": "com.amazonaws.resiliencehub#ResourceMappingList", "traits": { - "smithy.api#documentation": "

    Mappings used to map logical resources from the template to physical resources. You can\n use the mapping type CFN_STACK if the application template uses\n a logical stack name. Or you can map individual resources by using the mapping type\n RESOURCE. We recommend using the mapping type CFN_STACK if the\n application is backed by a CloudFormation stack.

    ", + "smithy.api#documentation": "

    List of sources that are used to map a logical resource from the template to a physical\n resource. You can use sources such as CloudFormation, Terraform state files,\n AppRegistry applications, or Amazon EKS.

    ", "smithy.api#required": {} } } @@ -123,47 +123,50 @@ "recommendationId": { "target": "com.amazonaws.resiliencehub#Uuid", "traits": { - "smithy.api#documentation": "

    The identifier of the alarm recommendation.

    ", + "smithy.api#documentation": "

    Identifier\n of the alarm recommendation.

    ", "smithy.api#required": {} } }, "referenceId": { "target": "com.amazonaws.resiliencehub#SpecReferenceId", "traits": { - "smithy.api#documentation": "

    The reference identifier of the alarm recommendation.

    ", + "smithy.api#documentation": "

    Reference\n identifier of the alarm recommendation.

    ", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.resiliencehub#String500", "traits": { - "smithy.api#documentation": "

    The name of the alarm recommendation.

    ", + "smithy.api#documentation": "

    Name of the alarm recommendation.

    ", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.resiliencehub#EntityDescription", "traits": { - "smithy.api#documentation": "

    The description of the recommendation.

    " + "smithy.api#documentation": "

    Description of the alarm recommendation.

    " } }, "type": { "target": "com.amazonaws.resiliencehub#AlarmType", "traits": { - "smithy.api#documentation": "

    The type of alarm recommendation.

    ", + "smithy.api#documentation": "

    Type of alarm recommendation.

    ", "smithy.api#required": {} } }, "appComponentName": { "target": "com.amazonaws.resiliencehub#EntityId", "traits": { - "smithy.api#documentation": "

    The Application Component for the CloudWatch alarm recommendation.

    " + "smithy.api#deprecated": { + "message": "An alarm recommendation can be attached to multiple Application Components, hence this property will be replaced by the new property 'appComponentNames'." + }, + "smithy.api#documentation": "

    Application Component name for the CloudWatch alarm\n recommendation. This\n name is saved as the first item in the appComponentNames\n list.

    " } }, "items": { "target": "com.amazonaws.resiliencehub#RecommendationItemList", "traits": { - "smithy.api#documentation": "

    The list of CloudWatch alarm recommendations.

    " + "smithy.api#documentation": "

    List of CloudWatch alarm recommendations.

    " } }, "prerequisite": { @@ -171,6 +174,12 @@ "traits": { "smithy.api#documentation": "

    The prerequisite for the alarm recommendation.

    " } + }, + "appComponentNames": { + "target": "com.amazonaws.resiliencehub#AppComponentNameList", + "traits": { + "smithy.api#documentation": "

    List of Application Component names for the CloudWatch alarm recommendation.

    " + } } }, "traits": { @@ -228,77 +237,101 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.resiliencehub#EntityName", "traits": { - "smithy.api#documentation": "

    The name for the application.

    ", + "smithy.api#documentation": "

    Name\n for the application.

    ", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.resiliencehub#EntityDescription", "traits": { - "smithy.api#documentation": "

    The optional description for an app.

    " + "smithy.api#documentation": "

    Optional\n description for an\n application.

    " } }, "policyArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " } }, "creationTime": { "target": "com.amazonaws.resiliencehub#TimeStamp", "traits": { - "smithy.api#documentation": "

    The timestamp for when the app was created.

    ", + "smithy.api#documentation": "

    Timestamp\n for when the app was created.

    ", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.resiliencehub#AppStatusType", "traits": { - "smithy.api#documentation": "

    The status of the application.

    " + "smithy.api#documentation": "

    Status of the application.

    " } }, "complianceStatus": { "target": "com.amazonaws.resiliencehub#AppComplianceStatusType", "traits": { - "smithy.api#documentation": "

    The current status of compliance for the resiliency policy.

    " + "smithy.api#documentation": "

    Current\n status of compliance for the resiliency policy.

    " } }, "lastAppComplianceEvaluationTime": { "target": "com.amazonaws.resiliencehub#TimeStamp", "traits": { - "smithy.api#documentation": "

    The timestamp for the most recent compliance evaluation.

    " + "smithy.api#documentation": "

    Timestamp\n for the most recent compliance evaluation.

    " } }, "resiliencyScore": { "target": "com.amazonaws.resiliencehub#Double", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

    The current resiliency score for the application.

    " + "smithy.api#documentation": "

    Current\n resiliency score for the application.

    " } }, "lastResiliencyScoreEvaluationTime": { "target": "com.amazonaws.resiliencehub#TimeStamp", "traits": { - "smithy.api#documentation": "

    The timestamp for the most recent resiliency score evaluation.

    " + "smithy.api#documentation": "

    Timestamp\n for the most recent resiliency score evaluation.

    " } }, "tags": { "target": "com.amazonaws.resiliencehub#TagMap", "traits": { - "smithy.api#documentation": "

    The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.

    " + "smithy.api#documentation": "

    Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.

    " } }, "assessmentSchedule": { "target": "com.amazonaws.resiliencehub#AppAssessmentScheduleType", "traits": { - "smithy.api#documentation": "

    \n Assessment execution schedule with 'Daily' or 'Disabled' values.\n

    " + "smithy.api#documentation": "

    Assessment\n execution schedule with 'Daily' or 'Disabled' values.

    " + } + }, + "permissionModel": { + "target": "com.amazonaws.resiliencehub#PermissionModel", + "traits": { + "smithy.api#documentation": "

    Defines the roles and credentials that Resilience Hub would use while creating the\n application, importing its resources, and running an assessment.

    " + } + }, + "eventSubscriptions": { + "target": "com.amazonaws.resiliencehub#EventSubscriptionList", + "traits": { + "smithy.api#documentation": "

    The list of events you would like to subscribe and get notification for. Currently,\n Resilience Hub supports notifications only for Drift\n detected and Scheduled assessment failure\n events.

    " + } + }, + "driftStatus": { + "target": "com.amazonaws.resiliencehub#AppDriftStatusType", + "traits": { + "smithy.api#documentation": "

    Indicates if compliance drifts (deviations) were detected while running an assessment for\n your application.

    " + } + }, + "lastDriftEvaluationTime": { + "target": "com.amazonaws.resiliencehub#TimeStamp", + "traits": { + "smithy.api#documentation": "

    Indicates the last time\n that\n a drift was evaluated.

    " } } }, @@ -312,13 +345,13 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " } }, "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The version of the application.

    " + "smithy.api#documentation": "

    Version of an application.

    " } }, "invoker": { @@ -331,44 +364,44 @@ "cost": { "target": "com.amazonaws.resiliencehub#Cost", "traits": { - "smithy.api#documentation": "

    The cost for the application.

    " + "smithy.api#documentation": "

    Cost for the application.

    " } }, "resiliencyScore": { "target": "com.amazonaws.resiliencehub#ResiliencyScore", "traits": { - "smithy.api#documentation": "

    The current resiliency score for the application.

    " + "smithy.api#documentation": "

    Current resiliency score for an application.

    " } }, "compliance": { "target": "com.amazonaws.resiliencehub#AssessmentCompliance", "traits": { - "smithy.api#documentation": "

    The application compliance against the resiliency policy.

    " + "smithy.api#documentation": "

    Application\n compliance against the resiliency policy.

    " } }, "complianceStatus": { "target": "com.amazonaws.resiliencehub#ComplianceStatus", "traits": { - "smithy.api#documentation": "

    The current status of the compliance for the resiliency policy.

    " + "smithy.api#documentation": "

    Current status of the compliance for the resiliency policy.

    " } }, "assessmentStatus": { "target": "com.amazonaws.resiliencehub#AssessmentStatus", "traits": { - "smithy.api#documentation": "

    The current status of the assessment for the resiliency policy.

    ", + "smithy.api#documentation": "

    Current status of the assessment for the resiliency policy.

    ", "smithy.api#required": {} } }, "startTime": { "target": "com.amazonaws.resiliencehub#TimeStamp", "traits": { - "smithy.api#documentation": "

    The starting time for the action.

    " + "smithy.api#documentation": "

    Starting time for the action.

    " } }, "endTime": { "target": "com.amazonaws.resiliencehub#TimeStamp", "traits": { - "smithy.api#documentation": "

    The end time for the action.

    " + "smithy.api#documentation": "

    End time for the action.

    " } }, "message": { @@ -380,32 +413,44 @@ "assessmentName": { "target": "com.amazonaws.resiliencehub#EntityName", "traits": { - "smithy.api#documentation": "

    The name of the assessment.

    " + "smithy.api#documentation": "

    Name of the assessment.

    " } }, "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "policy": { "target": "com.amazonaws.resiliencehub#ResiliencyPolicy", "traits": { - "smithy.api#documentation": "

    The resiliency policy.

    " + "smithy.api#documentation": "

    Resiliency policy of an application.

    " } }, "tags": { "target": "com.amazonaws.resiliencehub#TagMap", "traits": { - "smithy.api#documentation": "

    The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.

    " + "smithy.api#documentation": "

    Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.

    " } }, "resourceErrorsDetails": { "target": "com.amazonaws.resiliencehub#ResourceErrorsDetails", "traits": { - "smithy.api#documentation": "

    \n A resource error object containing a list of errors retrieving an application's resources.\n

    " + "smithy.api#documentation": "

    A resource error object containing a list of errors retrieving an application's\n resources.

    " + } + }, + "versionName": { + "target": "com.amazonaws.resiliencehub#EntityVersion", + "traits": { + "smithy.api#documentation": "

    Version name of the published application.

    " + } + }, + "driftStatus": { + "target": "com.amazonaws.resiliencehub#DriftStatus", + "traits": { + "smithy.api#documentation": "

    Indicates if compliance drifts (deviations) were detected while running an assessment for\n your application.

    " } } }, @@ -434,76 +479,88 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " } }, "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The version of the application.

    " + "smithy.api#documentation": "

    Version of an application.

    " } }, "assessmentStatus": { "target": "com.amazonaws.resiliencehub#AssessmentStatus", "traits": { - "smithy.api#documentation": "

    The current status of the assessment for the resiliency policy.

    ", + "smithy.api#documentation": "

    Current status of the assessment for the resiliency policy.

    ", "smithy.api#required": {} } }, "invoker": { "target": "com.amazonaws.resiliencehub#AssessmentInvoker", "traits": { - "smithy.api#documentation": "

    The entity that invoked the assessment.

    " + "smithy.api#documentation": "

    Entity that invoked the assessment.

    " } }, "startTime": { "target": "com.amazonaws.resiliencehub#TimeStamp", "traits": { - "smithy.api#documentation": "

    The starting time for the action.

    " + "smithy.api#documentation": "

    Starting time for the action.

    " } }, "endTime": { "target": "com.amazonaws.resiliencehub#TimeStamp", "traits": { - "smithy.api#documentation": "

    The end time for the action.

    " + "smithy.api#documentation": "

    End time for the action.

    " } }, "message": { "target": "com.amazonaws.resiliencehub#String500", "traits": { - "smithy.api#documentation": "

    The message from the assessment run.

    " + "smithy.api#documentation": "

    Message from the assessment run.

    " } }, "assessmentName": { "target": "com.amazonaws.resiliencehub#EntityName", "traits": { - "smithy.api#documentation": "

    The name of the assessment.

    " + "smithy.api#documentation": "

    Name of the assessment.

    " } }, "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "complianceStatus": { "target": "com.amazonaws.resiliencehub#ComplianceStatus", "traits": { - "smithy.api#documentation": "

    The current status of compliance for the resiliency policy.

    " + "smithy.api#documentation": "

    TCurrent status of compliance for the resiliency policy.

    " } }, "cost": { "target": "com.amazonaws.resiliencehub#Cost", "traits": { - "smithy.api#documentation": "

    The cost for the application.

    " + "smithy.api#documentation": "

    Cost for an application.

    " } }, "resiliencyScore": { "target": "com.amazonaws.resiliencehub#Double", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

    The current resiliency score for the application.

    " + "smithy.api#documentation": "

    Current resiliency score for the application.

    " + } + }, + "versionName": { + "target": "com.amazonaws.resiliencehub#EntityVersion", + "traits": { + "smithy.api#documentation": "

    Name of an application version.

    " + } + }, + "driftStatus": { + "target": "com.amazonaws.resiliencehub#DriftStatus", + "traits": { + "smithy.api#documentation": "

    Indicates if compliance drifts (deviations) were detected while running an assessment for\n your application.

    " } } }, @@ -546,7 +603,7 @@ "name": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    The name of the Application Component.

    ", + "smithy.api#documentation": "

    Name of the Application Component.

    ", "smithy.api#required": {} } }, @@ -560,7 +617,7 @@ "id": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    Unique identifier of the Application Component.

    " + "smithy.api#documentation": "

    Identifier\n of the Application Component.

    " } }, "additionalInfo": { @@ -586,7 +643,7 @@ "appComponentName": { "target": "com.amazonaws.resiliencehub#EntityId", "traits": { - "smithy.api#documentation": "

    The name of the Application Component.

    " + "smithy.api#documentation": "

    Name of the Application Component.

    " } }, "compliance": { @@ -604,7 +661,7 @@ "status": { "target": "com.amazonaws.resiliencehub#ComplianceStatus", "traits": { - "smithy.api#documentation": "

    The status of the action.

    " + "smithy.api#documentation": "

    Status of the action.

    " } }, "resiliencyScore": { @@ -630,6 +687,25 @@ "target": "com.amazonaws.resiliencehub#String255" } }, + "com.amazonaws.resiliencehub#AppDriftStatusType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NotChecked", + "name": "NOT_CHECKED" + }, + { + "value": "NotDetected", + "name": "NOT_DETECTED" + }, + { + "value": "Detected", + "name": "DETECTED" + } + ] + } + }, "com.amazonaws.resiliencehub#AppInputSource": { "type": "structure", "members": { @@ -703,7 +779,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -743,13 +819,19 @@ "assessmentSchedule": { "target": "com.amazonaws.resiliencehub#AppAssessmentScheduleType", "traits": { - "smithy.api#documentation": "

    \n Assessment execution schedule with 'Daily' or 'Disabled' values.\n

    " + "smithy.api#documentation": "

    Assessment execution schedule with 'Daily' or 'Disabled' values.

    " } }, "status": { "target": "com.amazonaws.resiliencehub#AppStatusType", "traits": { - "smithy.api#documentation": "

    The status of the application.

    " + "smithy.api#documentation": "

    Status of the application.

    " + } + }, + "driftStatus": { + "target": "com.amazonaws.resiliencehub#AppDriftStatusType", + "traits": { + "smithy.api#documentation": "

    Indicates if compliance drifts (deviations) were detected while running an assessment for\n your application.

    " } } }, @@ -785,13 +867,31 @@ "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The version of the application.

    ", + "smithy.api#documentation": "

    Version of an application.

    ", "smithy.api#required": {} } + }, + "identifier": { + "target": "com.amazonaws.resiliencehub#LongOptional", + "traits": { + "smithy.api#documentation": "

    Identifier of the application version.

    " + } + }, + "creationTime": { + "target": "com.amazonaws.resiliencehub#TimeStamp", + "traits": { + "smithy.api#documentation": "

    Creation time of the application version.

    " + } + }, + "versionName": { + "target": "com.amazonaws.resiliencehub#EntityVersion", + "traits": { + "smithy.api#documentation": "

    Name of the application version.

    " + } } }, "traits": { - "smithy.api#documentation": "

    The version of the application.

    " + "smithy.api#documentation": "

    Version of an application.

    " } }, "com.amazonaws.resiliencehub#Arn": { @@ -878,6 +978,9 @@ { "target": "com.amazonaws.resiliencehub#AddDraftAppVersionResourceMappings" }, + { + "target": "com.amazonaws.resiliencehub#BatchUpdateRecommendationStatus" + }, { "target": "com.amazonaws.resiliencehub#CreateApp" }, @@ -947,6 +1050,9 @@ { "target": "com.amazonaws.resiliencehub#ListAlarmRecommendations" }, + { + "target": "com.amazonaws.resiliencehub#ListAppAssessmentComplianceDrifts" + }, { "target": "com.amazonaws.resiliencehub#ListAppAssessments" }, @@ -1963,6 +2069,167 @@ } } }, + "com.amazonaws.resiliencehub#BatchUpdateRecommendationStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#BatchUpdateRecommendationStatusRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#BatchUpdateRecommendationStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Enables you to include or exclude one or more operational recommendations.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/batch-update-recommendation-status", + "code": 200 + } + } + }, + "com.amazonaws.resiliencehub#BatchUpdateRecommendationStatusFailedEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#BatchUpdateRecommendationStatusFailedEntry" + } + }, + "com.amazonaws.resiliencehub#BatchUpdateRecommendationStatusFailedEntry": { + "type": "structure", + "members": { + "entryId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "

    An identifier of an entry in this batch that is used to communicate the result.

    \n \n

    The entryIds of a batch request need to be unique within a request.

    \n     ", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.resiliencehub#ErrorMessage", + "traits": { + "smithy.api#documentation": "

    Indicates the error that occurred while excluding an operational recommendation.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    List\n of operational recommendations that did not get included or excluded.

    " + } + }, + "com.amazonaws.resiliencehub#BatchUpdateRecommendationStatusRequest": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#required": {} + } + }, + "requestEntries": { + "target": "com.amazonaws.resiliencehub#UpdateRecommendationStatusRequestEntries", + "traits": { + "smithy.api#documentation": "

    Defines the list of operational recommendations that need to be included or excluded.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.resiliencehub#BatchUpdateRecommendationStatusResponse": { + "type": "structure", + "members": { + "appArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#required": {} + } + }, + "successfulEntries": { + "target": "com.amazonaws.resiliencehub#BatchUpdateRecommendationStatusSuccessfulEntries", + "traits": { + "smithy.api#documentation": "

    A list of items that were included or excluded.

    ", + "smithy.api#required": {} + } + }, + "failedEntries": { + "target": "com.amazonaws.resiliencehub#BatchUpdateRecommendationStatusFailedEntries", + "traits": { + "smithy.api#documentation": "

    A list of items with error details about each item, which could not be included or excluded.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.resiliencehub#BatchUpdateRecommendationStatusSuccessfulEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#BatchUpdateRecommendationStatusSuccessfulEntry" + } + }, + "com.amazonaws.resiliencehub#BatchUpdateRecommendationStatusSuccessfulEntry": { + "type": "structure", + "members": { + "entryId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "

    An identifier for an entry in this batch that is used to communicate the result.

    \n \n

    The entryIds of a batch request need to be unique within a request.

    \n     ", + "smithy.api#required": {} + } + }, + "referenceId": { + "target": "com.amazonaws.resiliencehub#SpecReferenceId", + "traits": { + "smithy.api#documentation": "

    Reference identifier of the operational recommendation.

    ", + "smithy.api#required": {} + } + }, + "item": { + "target": "com.amazonaws.resiliencehub#UpdateRecommendationStatusItem", + "traits": { + "smithy.api#documentation": "

    The operational recommendation item.

    ", + "smithy.api#required": {} + } + }, + "excluded": { + "target": "com.amazonaws.resiliencehub#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    Indicates\n if\n the operational recommendation was successfully excluded.

    ", + "smithy.api#required": {} + } + }, + "excludeReason": { + "target": "com.amazonaws.resiliencehub#ExcludeRecommendationReason", + "traits": { + "smithy.api#documentation": "

    Indicates the reason for excluding an operational recommendation.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    List\n of operational recommendations that were successfully included or excluded.

    " + } + }, "com.amazonaws.resiliencehub#BooleanOptional": { "type": "boolean" }, @@ -1976,6 +2243,80 @@ "smithy.api#pattern": "^[A-za-z0-9_.-]{0,63}$" } }, + "com.amazonaws.resiliencehub#ComplianceDrift": { + "type": "structure", + "members": { + "entityId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "

    Identifier of an entity in which drift was detected. For compliance drift, the entity ID\n can be either application ID or the AppComponent ID.

    " + } + }, + "entityType": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "

    The type of entity in which drift was detected. For compliance drifts, Resilience Hub supports AWS::ResilienceHub::AppComponent and\n AWS::ResilienceHub::Application.

    " + } + }, + "driftType": { + "target": "com.amazonaws.resiliencehub#DriftType", + "traits": { + "smithy.api#documentation": "

    The type of drift detected. Currently, Resilience Hub supports only ApplicationCompliance drift type.

    " + } + }, + "appId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "

    Identifier\n of your application.

    " + } + }, + "appVersion": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "

    Published version of your application on which drift was detected.

    " + } + }, + "expectedReferenceId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "

    Assessment identifier of a previous assessment of the same application version. Resilience Hub uses the previous assessment (associated with the reference identifier) to\n compare the compliance with the current assessment to identify drifts.

    " + } + }, + "expectedValue": { + "target": "com.amazonaws.resiliencehub#AssessmentCompliance", + "traits": { + "smithy.api#documentation": "

    The expected compliance value of an entity.

    " + } + }, + "actualReferenceId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "

    Assessment identifier that is associated with this drift item.

    " + } + }, + "actualValue": { + "target": "com.amazonaws.resiliencehub#AssessmentCompliance", + "traits": { + "smithy.api#documentation": "

    Actual\n compliance value of the entity.

    " + } + }, + "diffType": { + "target": "com.amazonaws.resiliencehub#DifferenceType", + "traits": { + "smithy.api#documentation": "

    Difference\n type between actual and expected\n recovery\n point\n objective\n (RPO) and\n recovery\n time\n objective\n (RTO) values. Currently, Resilience Hub supports only NotEqual difference type.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Indicates\n the compliance drifts (recovery time objective (RTO) and recovery point\n objective (RPO)) that\n were detected for an assessed entity.

    " + } + }, + "com.amazonaws.resiliencehub#ComplianceDriftList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#ComplianceDrift" + } + }, "com.amazonaws.resiliencehub#ComplianceStatus": { "type": "string", "traits": { @@ -2003,27 +2344,27 @@ "appComponentName": { "target": "com.amazonaws.resiliencehub#EntityId", "traits": { - "smithy.api#documentation": "

    The name of the Application Component.

    ", + "smithy.api#documentation": "

    Name of the Application Component.

    ", "smithy.api#required": {} } }, "recommendationStatus": { "target": "com.amazonaws.resiliencehub#RecommendationComplianceStatus", "traits": { - "smithy.api#documentation": "

    The recommendation status.

    ", + "smithy.api#documentation": "

    Status of the recommendation.

    ", "smithy.api#required": {} } }, "configRecommendations": { "target": "com.amazonaws.resiliencehub#ConfigRecommendationList", "traits": { - "smithy.api#documentation": "

    The list of recommendations.

    ", + "smithy.api#documentation": "

    List of recommendations.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    Defines recommendations for an Resilience Hub Application Component, returned as an object. This\n object contains component names, configuration recommendations, and recommendation\n statuses.

    " + "smithy.api#documentation": "

    Defines recommendations for an Resilience Hub Application Component, returned as an\n object. This object contains component names, configuration recommendations, and\n recommendation statuses.

    " } }, "com.amazonaws.resiliencehub#ComponentRecommendationList": { @@ -2044,7 +2385,7 @@ "appComponentName": { "target": "com.amazonaws.resiliencehub#EntityId", "traits": { - "smithy.api#documentation": "

    The name of the Application Component.

    " + "smithy.api#documentation": "

    Name of the Application Component.

    " } }, "compliance": { @@ -2094,13 +2435,13 @@ "referenceId": { "target": "com.amazonaws.resiliencehub#SpecReferenceId", "traits": { - "smithy.api#documentation": "

    The reference identifier for the recommendation configuration.

    ", + "smithy.api#documentation": "

    Reference\n identifier for the recommendation configuration.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    Defines a configuration recommendation.

    " + "smithy.api#documentation": "

    Defines a recommendation configuration.

    " } }, "com.amazonaws.resiliencehub#ConfigRecommendationList": { @@ -2250,7 +2591,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates an Resilience Hub application. An Resilience Hub application is a\n collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe an Resilience Hub application, you provide an\n application name, resources from one or more CloudFormation stacks, Resource Groups,\n Terraform state files, AppRegistry applications, and an appropriate resiliency policy. For\n more information about the number of resources supported per application, see Service Quotas.

    \n

    After you create an Resilience Hub application, you publish it so that you can run a resiliency\n assessment on it. You can then use recommendations from the assessment to improve resiliency\n by running another assessment, comparing results, and then iterating the process until you\n achieve your goals for recovery time objective (RTO) and recovery point objective\n (RPO).

    ", + "smithy.api#documentation": "

    Creates an Resilience Hub application. An Resilience Hub application is a\n collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe a Resilience Hub application, you provide an\n application name, resources from one or more CloudFormation stacks, Resource Groups, Terraform state files, AppRegistry applications, and an appropriate\n resiliency policy. In addition, you can also add resources that are located on Amazon Elastic Kubernetes Service (Amazon EKS) clusters as optional resources. For more information\n about the number of resources supported per application, see Service\n quotas.

    \n

    After you create an Resilience Hub application, you publish it so that you can run a resiliency\n assessment on it. You can then use recommendations from the assessment to improve resiliency\n by running another assessment, comparing results, and then iterating the process until you\n achieve your goals for recovery time objective (RTO) and recovery point objective\n (RPO).

    ", "smithy.api#http": { "method": "POST", "uri": "/create-app", @@ -2264,7 +2605,7 @@ "name": { "target": "com.amazonaws.resiliencehub#EntityName", "traits": { - "smithy.api#documentation": "

    The name for the application.

    ", + "smithy.api#documentation": "

    Name of the application.

    ", "smithy.api#required": {} } }, @@ -2277,13 +2618,13 @@ "policyArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " } }, "tags": { "target": "com.amazonaws.resiliencehub#TagMap", "traits": { - "smithy.api#documentation": "

    The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.

    " + "smithy.api#documentation": "

    Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.

    " } }, "clientToken": { @@ -2298,6 +2639,18 @@ "traits": { "smithy.api#documentation": "

    \n Assessment execution schedule with 'Daily' or 'Disabled' values.\n

    " } + }, + "permissionModel": { + "target": "com.amazonaws.resiliencehub#PermissionModel", + "traits": { + "smithy.api#documentation": "

    Defines the roles and credentials that Resilience Hub would use while creating the\n application, importing its resources, and running an assessment.

    " + } + }, + "eventSubscriptions": { + "target": "com.amazonaws.resiliencehub#EventSubscriptionList", + "traits": { + "smithy.api#documentation": "

    The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports only Drift detected and Scheduled assessment failure events notification.

    " + } } } }, @@ -2359,27 +2712,27 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    The identifier of the Application Component.

    " + "smithy.api#documentation": "

    Identifier of the Application Component.

    " } }, "name": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    The name of the Application Component.

    ", + "smithy.api#documentation": "

    Name of the Application Component.

    ", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

    ", + "smithy.api#documentation": "

    Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

    ", "smithy.api#required": {} } }, @@ -2404,21 +2757,21 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The Resilience Hub application version.

    ", + "smithy.api#documentation": "

    Resilience Hub application version.

    ", "smithy.api#required": {} } }, "appComponent": { "target": "com.amazonaws.resiliencehub#AppComponent", "traits": { - "smithy.api#documentation": "

    The list of Application Components that belong to this resource.

    " + "smithy.api#documentation": "

    List of Application Components that belong to this resource.

    " } } } @@ -2469,53 +2822,53 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "resourceName": { "target": "com.amazonaws.resiliencehub#EntityName", "traits": { - "smithy.api#documentation": "

    The name of the resource.

    " + "smithy.api#documentation": "

    Name of the resource.

    " } }, "logicalResourceId": { "target": "com.amazonaws.resiliencehub#LogicalResourceId", "traits": { - "smithy.api#documentation": "

    The logical identifier of the resource.

    ", + "smithy.api#documentation": "

    Logical identifier of the resource.

    ", "smithy.api#required": {} } }, "physicalResourceId": { "target": "com.amazonaws.resiliencehub#String2048", "traits": { - "smithy.api#documentation": "

    The physical identifier of the resource.

    ", + "smithy.api#documentation": "

    Physical identifier of the resource.

    ", "smithy.api#required": {} } }, "awsRegion": { "target": "com.amazonaws.resiliencehub#AwsRegion", "traits": { - "smithy.api#documentation": "

    The Amazon Web Services region that owns the physical resource.

    " + "smithy.api#documentation": "

    Amazon Web Services region that owns the physical resource.

    " } }, "awsAccountId": { "target": "com.amazonaws.resiliencehub#CustomerId", "traits": { - "smithy.api#documentation": "

    The Amazon Web Services account that owns the physical resource.

    " + "smithy.api#documentation": "

    Amazon Web Services account that owns the physical resource.

    " } }, "resourceType": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    The type of resource.

    ", + "smithy.api#documentation": "

    Type of resource.

    ", "smithy.api#required": {} } }, "appComponents": { "target": "com.amazonaws.resiliencehub#AppComponentNameList", "traits": { - "smithy.api#documentation": "

    The list of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

    ", + "smithy.api#documentation": "

    List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

    ", "smithy.api#required": {} } }, @@ -2540,14 +2893,14 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The Resilience Hub application version.

    ", + "smithy.api#documentation": "

    Resilience Hub application version.

    ", "smithy.api#required": {} } }, @@ -2623,7 +2976,7 @@ "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -2644,7 +2997,7 @@ "tags": { "target": "com.amazonaws.resiliencehub#TagMap", "traits": { - "smithy.api#documentation": "

    The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.

    " + "smithy.api#documentation": "

    Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.

    " } }, "bucketName": { @@ -2749,7 +3102,7 @@ "tags": { "target": "com.amazonaws.resiliencehub#TagMap", "traits": { - "smithy.api#documentation": "

    The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.

    " + "smithy.api#documentation": "

    Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.

    " } } } @@ -2877,7 +3230,7 @@ "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -2896,7 +3249,7 @@ "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -2952,7 +3305,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -2989,13 +3342,13 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " } }, "appInputSource": { "target": "com.amazonaws.resiliencehub#AppInputSource", "traits": { - "smithy.api#documentation": "

    The name of the input source from where the application resource is imported from.

    " + "smithy.api#documentation": "

    Name of the input source from where the application resource is imported from.

    " } } } @@ -3006,7 +3359,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -3031,7 +3384,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } } @@ -3080,14 +3433,14 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    The identifier of the Application Component.

    ", + "smithy.api#documentation": "

    Identifier of the Application Component.

    ", "smithy.api#required": {} } }, @@ -3106,21 +3459,21 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The Resilience Hub application version.

    ", + "smithy.api#documentation": "

    Resilience Hub application version.

    ", "smithy.api#required": {} } }, "appComponent": { "target": "com.amazonaws.resiliencehub#AppComponent", "traits": { - "smithy.api#documentation": "

    The list of Application Components that belong to this resource.

    " + "smithy.api#documentation": "

    List of Application Components that belong to this resource.

    " } } } @@ -3168,38 +3521,38 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "resourceName": { "target": "com.amazonaws.resiliencehub#EntityName", "traits": { - "smithy.api#documentation": "

    The name of the resource.

    " + "smithy.api#documentation": "

    Name of the resource.

    " } }, "logicalResourceId": { "target": "com.amazonaws.resiliencehub#LogicalResourceId", "traits": { - "smithy.api#documentation": "

    The logical identifier of the resource.

    " + "smithy.api#documentation": "

    Logical identifier of the resource.

    " } }, "physicalResourceId": { "target": "com.amazonaws.resiliencehub#String2048", "traits": { - "smithy.api#documentation": "

    The physical identifier of the resource.

    " + "smithy.api#documentation": "

    Physical identifier of the resource.

    " } }, "awsRegion": { "target": "com.amazonaws.resiliencehub#AwsRegion", "traits": { - "smithy.api#documentation": "

    The Amazon Web Services region that owns the physical resource.

    " + "smithy.api#documentation": "

    Amazon Web Services region that owns the physical resource.

    " } }, "awsAccountId": { "target": "com.amazonaws.resiliencehub#CustomerId", "traits": { - "smithy.api#documentation": "

    The Amazon Web Services account that owns the physical resource.

    " + "smithy.api#documentation": "

    Amazon Web Services account that owns the physical resource.

    " } }, "clientToken": { @@ -3217,14 +3570,14 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The Resilience Hub application version.

    ", + "smithy.api#documentation": "

    Resilience Hub application version.

    ", "smithy.api#required": {} } }, @@ -3302,7 +3655,7 @@ "status": { "target": "com.amazonaws.resiliencehub#RecommendationTemplateStatus", "traits": { - "smithy.api#documentation": "

    The status of the action.

    ", + "smithy.api#documentation": "

    Status of the action.

    ", "smithy.api#required": {} } } @@ -3351,7 +3704,7 @@ "policyArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -3370,7 +3723,7 @@ "policyArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } } @@ -3450,7 +3803,7 @@ "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } } @@ -3474,7 +3827,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } } @@ -3569,21 +3922,21 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The Resilience Hub application version.

    ", + "smithy.api#documentation": "

    Resilience Hub application version.

    ", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    The identifier of the Application Component.

    ", + "smithy.api#documentation": "

    Identifier of the Application Component.

    ", "smithy.api#required": {} } } @@ -3595,21 +3948,21 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The Resilience Hub application version.

    ", + "smithy.api#documentation": "

    Resilience Hub application version.

    ", "smithy.api#required": {} } }, "appComponent": { "target": "com.amazonaws.resiliencehub#AppComponent", "traits": { - "smithy.api#documentation": "

    The list of Application Components that belong to this resource.

    " + "smithy.api#documentation": "

    List of Application Components that belong to this resource.

    " } } } @@ -3620,14 +3973,14 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The Resilience Hub application version.

    ", + "smithy.api#documentation": "

    Resilience Hub application version.

    ", "smithy.api#required": {} } } @@ -3676,45 +4029,45 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The Resilience Hub application version.

    ", + "smithy.api#documentation": "

    Resilience Hub application version.

    ", "smithy.api#required": {} } }, "resourceName": { "target": "com.amazonaws.resiliencehub#EntityName", "traits": { - "smithy.api#documentation": "

    The name of the resource.

    " + "smithy.api#documentation": "

    Name of the resource.

    " } }, "logicalResourceId": { "target": "com.amazonaws.resiliencehub#LogicalResourceId", "traits": { - "smithy.api#documentation": "

    The logical identifier of the resource.

    " + "smithy.api#documentation": "

    Logical identifier of the resource.

    " } }, "physicalResourceId": { "target": "com.amazonaws.resiliencehub#String2048", "traits": { - "smithy.api#documentation": "

    The physical identifier of the resource.

    " + "smithy.api#documentation": "

    Physical identifier of the resource.

    " } }, "awsRegion": { "target": "com.amazonaws.resiliencehub#AwsRegion", "traits": { - "smithy.api#documentation": "

    The Amazon Web Services region that owns the physical resource.

    " + "smithy.api#documentation": "

    Amazon Web Services region that owns the physical resource.

    " } }, "awsAccountId": { "target": "com.amazonaws.resiliencehub#CustomerId", "traits": { - "smithy.api#documentation": "

    The Amazon Web Services account that owns the physical resource.

    " + "smithy.api#documentation": "

    Amazon Web Services account that owns the physical resource.

    " } } } @@ -3725,14 +4078,14 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The Resilience Hub application version.

    ", + "smithy.api#documentation": "

    Resilience Hub application version.

    ", "smithy.api#required": {} } }, @@ -3784,7 +4137,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -3809,7 +4162,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -3830,7 +4183,7 @@ "status": { "target": "com.amazonaws.resiliencehub#ResourceResolutionStatusType", "traits": { - "smithy.api#documentation": "

    The status of the action.

    ", + "smithy.api#documentation": "

    Status of the action.

    ", "smithy.api#required": {} } }, @@ -3848,14 +4201,14 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The Resilience Hub application version.

    ", + "smithy.api#documentation": "

    Resilience Hub application version.

    ", "smithy.api#required": {} } }, @@ -3907,7 +4260,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -3926,7 +4279,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -3940,7 +4293,7 @@ "appTemplateBody": { "target": "com.amazonaws.resiliencehub#AppTemplateBody", "traits": { - "smithy.api#documentation": "

    A JSON string that provides information about your application structure. To learn more\n about the appTemplateBody template, see the sample template provided in the\n Examples section.

    \n

    The appTemplateBody JSON string has the following structure:

    \n
      \n
    • \n

      \n \n resources\n \n

      \n

      The list of logical resources that\n must\n be included in the Resilience Hub application.

      \n

      Type: Array

      \n \n

      Don't add the resources that you want to exclude.

      \n       \n

      Each resources array item includes the following fields:

      \n
        \n
      • \n

        \n \n logicalResourceId\n \n

        \n

        The logical identifier of the resource.

        \n

        Type: Object

        \n

        Each logicalResourceId object includes the following fields:

        \n
          \n
        • \n

          \n identifier\n

          \n

          The identifier of the resource.

          \n

          Type: String

          \n
          • \n
        • \n

          \n logicalStackName\n

          \n

          The name of the CloudFormation stack this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n resourceGroupName\n

          \n

          The name of the resource group this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n terraformSourceName\n

          \n

          The name of the Terraform S3 state file this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n eksSourceName\n

          \n

          The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

          \n \n

          This parameter accepts values in \"eks-cluster/namespace\" format.

          \n           \n

          Type: String

          \n
          • \n
        \n
        • \n
      • \n

        \n \n type\n \n

        \n

        The type of resource.

        \n

        Type: string

        \n
        • \n
      • \n

        \n \n name\n \n

        \n

        The name of the resource.

        \n

        Type: String

        \n
        • \n
      • \n

        \n additionalInfo\n

        \n

        Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

        \n \n

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        \n

        Key: \"failover-regions\"\n

        \n

        Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n

        \n         \n
        • \n
      \n
      • \n
    • \n

      \n \n appComponents\n \n

      \n

      The list of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

      \n

      Type: Array

      \n

      Each appComponents array item includes the following fields:

      \n
        \n
      • \n

        \n name\n

        \n

        The name of the Application Component.

        \n

        Type: String

        \n
        • \n
      • \n

        \n type\n

        \n

        The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

        \n

        Type: String

        \n
        • \n
      • \n

        \n resourceNames\n

        \n

        The list of included resources that are assigned to the Application Component.

        \n

        Type: Array of strings

        \n
        • \n
      • \n

        \n additionalInfo\n

        \n

        Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

        \n \n

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        \n

        Key: \"failover-regions\"\n

        \n

        Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n

        \n         \n
        • \n
      \n
      • \n
    • \n

      \n \n excludedResources\n \n

      \n

      The list of logical resource identifiers to be excluded from the application.

      \n

      Type: Array

      \n \n

      Don't add the resources that you want to include.

      \n       \n

      Each excludedResources array item includes the following fields:

      \n
        \n
      • \n

        \n \n logicalResourceIds\n \n

        \n

        The logical identifier of the resource.

        \n

        Type: Object

        \n \n

        You can configure only one of the following fields:

        \n
          \n
        • \n

          \n logicalStackName\n

          \n
          • \n
        • \n

          \n resourceGroupName\n

          \n
          • \n
        • \n

          \n terraformSourceName\n

          \n
          • \n
        • \n

          \n eksSourceName\n

          \n
          • \n
        \n         \n

        Each logicalResourceIds object includes the following fields:

        \n
          \n
        • \n

          \n identifier\n

          \n

          The identifier of the resource.

          \n

          Type: String

          \n
          • \n
        • \n

          \n logicalStackName\n

          \n

          The name of the CloudFormation stack this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n resourceGroupName\n

          \n

          The name of the resource group this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n terraformSourceName\n

          \n

          The name of the Terraform S3 state file this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n eksSourceName\n

          \n

          The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

          \n \n

          This parameter accepts values in \"eks-cluster/namespace\" format.

          \n           \n

          Type: String

          \n
          • \n
        \n
        • \n
      \n
      • \n
    • \n

      \n \n version\n \n

      \n

      The Resilience Hub application version.

      \n
      • \n
    • \n

      \n additionalInfo\n

      \n

      Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

      \n \n

      Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

      \n

      Key: \"failover-regions\"\n

      \n

      Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n

      \n       \n
      • \n
    ", + "smithy.api#documentation": "

    A JSON string that provides information about your application structure. To learn more\n about the appTemplateBody template, see the sample template provided in the\n Examples section.

    \n

    The appTemplateBody JSON string has the following structure:

    \n
      \n
    • \n

      \n \n resources\n \n

      \n

      The list of logical resources that must be included in the Resilience Hub\n application.

      \n

      Type: Array

      \n \n

      Don't add the resources that you want to exclude.

      \n       \n

      Each resources array item includes the following fields:

      \n
        \n
      • \n

        \n \n logicalResourceId\n \n

        \n

        Logical identifier of the resource.

        \n

        Type: Object

        \n

        Each logicalResourceId object includes the following fields:

        \n
          \n
        • \n

          \n identifier\n

          \n

          Identifier of the resource.

          \n

          Type: String

          \n
          • \n
        • \n

          \n logicalStackName\n

          \n

          The name of the CloudFormation stack this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n resourceGroupName\n

          \n

          The name of the resource group this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n terraformSourceName\n

          \n

          The name of the Terraform S3 state file this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n eksSourceName\n

          \n

          Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

          \n \n

          This parameter accepts values in \"eks-cluster/namespace\" format.

          \n           \n

          Type: String

          \n
          • \n
        \n
        • \n
      • \n

        \n \n type\n \n

        \n

        The type of resource.

        \n

        Type: string

        \n
        • \n
      • \n

        \n \n name\n \n

        \n

        The name of the resource.

        \n

        Type: String

        \n
        • \n
      • \n

        \n additionalInfo\n

        \n

        Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

        \n \n

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        \n

        Key: \"failover-regions\"\n

        \n

        Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n

        \n         \n
        • \n
      \n
      • \n
    • \n

      \n \n appComponents\n \n

      \n

      List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

      \n

      Type: Array

      \n

      Each appComponents array item includes the following fields:

      \n
        \n
      • \n

        \n name\n

        \n

        Name of the Application Component.

        \n

        Type: String

        \n
        • \n
      • \n

        \n type\n

        \n

        Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

        \n

        Type: String

        \n
        • \n
      • \n

        \n resourceNames\n

        \n

        The list of included resources that are assigned to the Application Component.

        \n

        Type: Array of strings

        \n
        • \n
      • \n

        \n additionalInfo\n

        \n

        Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

        \n \n

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        \n

        Key: \"failover-regions\"\n

        \n

        Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n

        \n         \n
        • \n
      \n
      • \n
    • \n

      \n \n excludedResources\n \n

      \n

      The list of logical resource identifiers to be excluded from the application.

      \n

      Type: Array

      \n \n

      Don't add the resources that you want to include.

      \n       \n

      Each excludedResources array item includes the following fields:

      \n
        \n
      • \n

        \n \n logicalResourceIds\n \n

        \n

        Logical identifier of the resource.

        \n

        Type: Object

        \n \n

        You can configure only one of the following fields:

        \n
          \n
        • \n

          \n logicalStackName\n

          \n
          • \n
        • \n

          \n resourceGroupName\n

          \n
          • \n
        • \n

          \n terraformSourceName\n

          \n
          • \n
        • \n

          \n eksSourceName\n

          \n
          • \n
        \n         \n

        Each logicalResourceIds object includes the following fields:

        \n
          \n
        • \n

          \n identifier\n

          \n

          Identifier of the resource.

          \n

          Type: String

          \n
          • \n
        • \n

          \n logicalStackName\n

          \n

          The name of the CloudFormation stack this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n resourceGroupName\n

          \n

          The name of the resource group this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n terraformSourceName\n

          \n

          The name of the Terraform S3 state file this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n eksSourceName\n

          \n

          Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

          \n \n

          This parameter accepts values in \"eks-cluster/namespace\" format.

          \n           \n

          Type: String

          \n
          • \n
        \n
        • \n
      \n
      • \n
    • \n

      \n \n version\n \n

      \n

      Resilience Hub application version.

      \n
      • \n
    • \n

      \n additionalInfo\n

      \n

      Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

      \n \n

      Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

      \n

      Key: \"failover-regions\"\n

      \n

      Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n

      \n       \n
      • \n
    ", "smithy.api#required": {} } } @@ -3986,7 +4339,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } } @@ -3998,7 +4351,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -4012,7 +4365,7 @@ "status": { "target": "com.amazonaws.resiliencehub#ResourceImportStatusType", "traits": { - "smithy.api#documentation": "

    The status of the action.

    ", + "smithy.api#documentation": "

    Status of the action.

    ", "smithy.api#required": {} } }, @@ -4071,7 +4424,7 @@ "policyArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } } @@ -4089,6 +4442,17 @@ } } }, + "com.amazonaws.resiliencehub#DifferenceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NotEqual", + "name": "NOT_EQUAL" + } + ] + } + }, "com.amazonaws.resiliencehub#DisruptionCompliance": { "type": "structure", "members": { @@ -4109,7 +4473,7 @@ "rtoReferenceId": { "target": "com.amazonaws.resiliencehub#String500", "traits": { - "smithy.api#documentation": "

    The RTO reference identifier.

    " + "smithy.api#documentation": "

    Reference\n identifier of the RTO.

    " } }, "rtoDescription": { @@ -4128,7 +4492,7 @@ "rpoReferenceId": { "target": "com.amazonaws.resiliencehub#String500", "traits": { - "smithy.api#documentation": "

    The RPO reference identifier.

    " + "smithy.api#documentation": "

    Reference\n identifier of\n the\n RPO\n .

    " } }, "rpoDescription": { @@ -4218,6 +4582,36 @@ "smithy.api#default": 0 } }, + "com.amazonaws.resiliencehub#DriftStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NotChecked", + "name": "NOT_CHECKED" + }, + { + "value": "NotDetected", + "name": "NOT_DETECTED" + }, + { + "value": "Detected", + "name": "DETECTED" + } + ] + } + }, + "com.amazonaws.resiliencehub#DriftType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ApplicationCompliance", + "name": "APPLICATION_COMPLIANCE" + } + ] + } + }, "com.amazonaws.resiliencehub#EksNamespace": { "type": "string", "traits": { @@ -4240,7 +4634,7 @@ "eksClusterArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: \narn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: \narn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -4262,7 +4656,7 @@ "eksClusterArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: \narn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Amazon Elastic Kubernetes Service cluster. The format for this ARN is: \narn:aws:eks:region:account-id:cluster/cluster-name. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -4275,7 +4669,7 @@ } }, "traits": { - "smithy.api#documentation": "

    The input source of the namespace that is located on your Amazon Elastic Kubernetes Service cluster.

    " + "smithy.api#documentation": "

    The input source of the namespace that is located on your Amazon Elastic Kubernetes Service\n cluster.

    " } }, "com.amazonaws.resiliencehub#EksSourceList": { @@ -4302,49 +4696,123 @@ "com.amazonaws.resiliencehub#EntityName": { "type": "string", "traits": { - "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$" + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$" + } + }, + "com.amazonaws.resiliencehub#EntityNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#EntityName" + } + }, + "com.amazonaws.resiliencehub#EntityVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\S{1,50}$" + } + }, + "com.amazonaws.resiliencehub#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.resiliencehub#EstimatedCostTier": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "L1", + "name": "L1" + }, + { + "value": "L2", + "name": "L2" + }, + { + "value": "L3", + "name": "L3" + }, + { + "value": "L4", + "name": "L4" + } + ] + } + }, + "com.amazonaws.resiliencehub#EventSubscription": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "

    Unique name to identify an event subscription.

    ", + "smithy.api#required": {} + } + }, + "eventType": { + "target": "com.amazonaws.resiliencehub#EventType", + "traits": { + "smithy.api#documentation": "

    The type of event you would like to subscribe and get notification for. Currently, Resilience Hub\n supports\n notifications only for Drift detected\n (DriftDetected) and Scheduled assessment\n failure (ScheduledAssessmentFailure) events.

    ", + "smithy.api#required": {} + } + }, + "snsTopicArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id.\n For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Indicates an event you would like to subscribe and get notification for. Currently,\n Resilience Hub\n supports\n notifications only for Drift detected and Scheduled assessment failure events.

    " } }, - "com.amazonaws.resiliencehub#EntityNameList": { + "com.amazonaws.resiliencehub#EventSubscriptionList": { "type": "list", "member": { - "target": "com.amazonaws.resiliencehub#EntityName" - } - }, - "com.amazonaws.resiliencehub#EntityVersion": { - "type": "string", - "traits": { - "smithy.api#pattern": "^\\S{1,50}$" - } - }, - "com.amazonaws.resiliencehub#ErrorMessage": { - "type": "string", + "target": "com.amazonaws.resiliencehub#EventSubscription" + }, "traits": { "smithy.api#length": { "min": 0, - "max": 500 + "max": 10 } } }, - "com.amazonaws.resiliencehub#EstimatedCostTier": { + "com.amazonaws.resiliencehub#EventType": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "L1", - "name": "L1" + "value": "ScheduledAssessmentFailure", + "name": "SCHEDULED_ASSESSMENT_FAILURE" }, { - "value": "L2", - "name": "L2" + "value": "DriftDetected", + "name": "DRIFT_DETECTED" + } + ] + } + }, + "com.amazonaws.resiliencehub#ExcludeRecommendationReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AlreadyImplemented", + "name": "ALREADY_IMPLEMENTED" }, { - "value": "L3", - "name": "L3" + "value": "NotRelevant", + "name": "NOT_RELEVANT" }, { - "value": "L4", - "name": "L4" + "value": "ComplexityOfImplementation", + "name": "COMPLEXITY_OF_IMPLEMENTATION" } ] } @@ -4400,6 +4868,30 @@ ] } }, + "com.amazonaws.resiliencehub#IamRoleArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):iam::[0-9]{12}:role/(([^/][!-~]+/){1,511})?[A-Za-z0-9_+=,.@-]{1,64}$" + } + }, + "com.amazonaws.resiliencehub#IamRoleArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#IamRoleArn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.resiliencehub#IamRoleName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([^/]([!-~]+/){1,511})?[A-Za-z0-9_+=,.@-]{1,64}$" + } + }, "com.amazonaws.resiliencehub#ImportResourcesToDraftAppVersion": { "type": "operation", "input": { @@ -4421,6 +4913,9 @@ { "target": "com.amazonaws.resiliencehub#ResourceNotFoundException" }, + { + "target": "com.amazonaws.resiliencehub#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.resiliencehub#ThrottlingException" }, @@ -4443,7 +4938,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -4479,7 +4974,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -4499,7 +4994,7 @@ "status": { "target": "com.amazonaws.resiliencehub#ResourceImportStatusType", "traits": { - "smithy.api#documentation": "

    The status of the action.

    ", + "smithy.api#documentation": "

    Status of the action.

    ", "smithy.api#required": {} } }, @@ -4581,7 +5076,7 @@ "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -4594,7 +5089,7 @@ "maxResults": { "target": "com.amazonaws.resiliencehub#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    " + "smithy.api#documentation": "

    Maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    " } } } @@ -4612,9 +5107,93 @@ "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    Token for the next set of results, or null if there are no more results.

    " + } + } + } + }, + "com.amazonaws.resiliencehub#ListAppAssessmentComplianceDrifts": { + "type": "operation", + "input": { + "target": "com.amazonaws.resiliencehub#ListAppAssessmentComplianceDriftsRequest" + }, + "output": { + "target": "com.amazonaws.resiliencehub#ListAppAssessmentComplianceDriftsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.resiliencehub#AccessDeniedException" + }, + { + "target": "com.amazonaws.resiliencehub#InternalServerException" + }, + { + "target": "com.amazonaws.resiliencehub#ThrottlingException" + }, + { + "target": "com.amazonaws.resiliencehub#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    List of compliance drifts that were detected while running an assessment.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/list-app-assessment-compliance-drifts", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.resiliencehub#ListAppAssessmentComplianceDriftsRequest": { + "type": "structure", + "members": { + "assessmentArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "

    Indicates the unique token number of the next application to be checked for compliance and regulatory requirements from the list of applications.

    " + } + }, + "maxResults": { + "target": "com.amazonaws.resiliencehub#MaxResults", + "traits": { + "smithy.api#documentation": "

    Indicates the maximum number of applications requested.

    " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.resiliencehub#ListAppAssessmentComplianceDriftsResponse": { + "type": "structure", + "members": { + "complianceDrifts": { + "target": "com.amazonaws.resiliencehub#ComplianceDriftList", + "traits": { + "smithy.api#documentation": "

    Indicates compliance drifts (recovery time objective (RTO) and recovery point objective (RPO)) detected for an assessed entity.

    ", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.resiliencehub#NextToken", + "traits": { + "smithy.api#documentation": "

    Token number of the next application to be checked for compliance and regulatory requirements from the list of applications.

    " } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.resiliencehub#ListAppAssessments": { @@ -4663,7 +5242,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#httpQuery": "appArn" } }, @@ -4712,7 +5291,7 @@ "maxResults": { "target": "com.amazonaws.resiliencehub#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    ", + "smithy.api#documentation": "

    Maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    ", "smithy.api#httpQuery": "maxResults" } } @@ -4724,7 +5303,7 @@ "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    Token for the next set of results, or null if there are no more results.

    " } }, "assessmentSummaries": { @@ -4787,13 +5366,13 @@ "maxResults": { "target": "com.amazonaws.resiliencehub#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    " + "smithy.api#documentation": "

    Maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    " } }, "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } } @@ -4812,7 +5391,7 @@ "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    Token for the next set of results, or null if there are no more results.

    " } } } @@ -4862,7 +5441,7 @@ "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -4875,7 +5454,7 @@ "maxResults": { "target": "com.amazonaws.resiliencehub#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    " + "smithy.api#documentation": "

    Maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    " } } } @@ -4893,7 +5472,7 @@ "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    Token for the next set of results, or null if there are no more results.

    " } } } @@ -4943,14 +5522,14 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The Resilience Hub application version.

    ", + "smithy.api#documentation": "

    Resilience Hub application version.

    ", "smithy.api#required": {} } }, @@ -4981,7 +5560,7 @@ "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    Token for the next set of results, or null if there are no more results.

    " } } } @@ -5034,14 +5613,14 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The version of the Application Component.

    ", + "smithy.api#documentation": "

    Version of the Application Component.

    ", "smithy.api#required": {} } }, @@ -5065,14 +5644,14 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The Resilience Hub application version.

    ", + "smithy.api#documentation": "

    Resilience Hub application version.

    ", "smithy.api#required": {} } }, @@ -5085,7 +5664,7 @@ "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    Token for the next set of results, or null if there are no more results.

    " } } } @@ -5135,7 +5714,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -5155,7 +5734,7 @@ "maxResults": { "target": "com.amazonaws.resiliencehub#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    " + "smithy.api#documentation": "

    Maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    " } } } @@ -5173,7 +5752,7 @@ "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    Token for the next set of results, or null if there are no more results.

    " } } } @@ -5226,7 +5805,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -5252,7 +5831,7 @@ "maxResults": { "target": "com.amazonaws.resiliencehub#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    " + "smithy.api#documentation": "

    Maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    " } } } @@ -5277,7 +5856,7 @@ "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    Token for the next set of results, or null if there are no more results.

    " } } } @@ -5324,7 +5903,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -5337,7 +5916,19 @@ "maxResults": { "target": "com.amazonaws.resiliencehub#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    " + "smithy.api#documentation": "

    Maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    " + } + }, + "startTime": { + "target": "com.amazonaws.resiliencehub#TimeStamp", + "traits": { + "smithy.api#documentation": "

    Lower limit of the time range to filter the application versions.

    " + } + }, + "endTime": { + "target": "com.amazonaws.resiliencehub#TimeStamp", + "traits": { + "smithy.api#documentation": "

    Upper limit of the time range to filter the application versions.

    " } } } @@ -5355,7 +5946,7 @@ "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    Token for the next set of results, or null if there are no more results.

    " } } } @@ -5410,7 +6001,7 @@ "maxResults": { "target": "com.amazonaws.resiliencehub#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    ", + "smithy.api#documentation": "

    Maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    ", "smithy.api#httpQuery": "maxResults" } }, @@ -5424,7 +6015,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#httpQuery": "appArn" } } @@ -5443,7 +6034,7 @@ "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    Token for the next set of results, or null if there are no more results.

    " } } } @@ -5491,7 +6082,7 @@ "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#httpQuery": "assessmentArn", "smithy.api#required": {} } @@ -5506,7 +6097,7 @@ "status": { "target": "com.amazonaws.resiliencehub#RecommendationTemplateStatusList", "traits": { - "smithy.api#documentation": "

    The status of the action.

    ", + "smithy.api#documentation": "

    Status of the action.

    ", "smithy.api#httpQuery": "status" } }, @@ -5534,7 +6125,7 @@ "maxResults": { "target": "com.amazonaws.resiliencehub#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    ", + "smithy.api#documentation": "

    Maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    ", "smithy.api#httpQuery": "maxResults" } } @@ -5546,7 +6137,7 @@ "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    Token for the next set of results, or null if there are no more results.

    " } }, "recommendationTemplates": { @@ -5617,7 +6208,7 @@ "maxResults": { "target": "com.amazonaws.resiliencehub#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    ", + "smithy.api#documentation": "

    Maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    ", "smithy.api#httpQuery": "maxResults" } } @@ -5636,7 +6227,7 @@ "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    Token for the next set of results, or null if there are no more results.

    " } } } @@ -5695,13 +6286,13 @@ "maxResults": { "target": "com.amazonaws.resiliencehub#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    " + "smithy.api#documentation": "

    Maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    " } }, "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } } @@ -5713,7 +6304,7 @@ "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    Token for the next set of results, or null if there are no more results.

    " } }, "sopRecommendations": { @@ -5778,7 +6369,7 @@ "maxResults": { "target": "com.amazonaws.resiliencehub#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    ", + "smithy.api#documentation": "

    Maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    ", "smithy.api#httpQuery": "maxResults" } } @@ -5797,7 +6388,7 @@ "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    Token for the next set of results, or null if there are no more results.

    " } } } @@ -5856,7 +6447,7 @@ "tags": { "target": "com.amazonaws.resiliencehub#TagMap", "traits": { - "smithy.api#documentation": "

    The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.

    " + "smithy.api#documentation": "

    Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.

    " } } } @@ -5915,13 +6506,13 @@ "maxResults": { "target": "com.amazonaws.resiliencehub#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    " + "smithy.api#documentation": "

    Maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    " } }, "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } } @@ -5933,7 +6524,7 @@ "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    Token for the next set of results, or null if there are no more results.

    " } }, "testRecommendations": { @@ -5993,7 +6584,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -6019,7 +6610,7 @@ "maxResults": { "target": "com.amazonaws.resiliencehub#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    " + "smithy.api#documentation": "

    Maximum number of results to include in the response. If more results exist than the specified \nMaxResults value, a token is included in the response so that the remaining results can be retrieved.

    " } } } @@ -6044,7 +6635,7 @@ "nextToken": { "target": "com.amazonaws.resiliencehub#NextToken", "traits": { - "smithy.api#documentation": "

    The token for the next set of results, or null if there are no more results.

    " + "smithy.api#documentation": "

    Token for the next set of results, or null if there are no more results.

    " } } } @@ -6055,7 +6646,7 @@ "identifier": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    The identifier of the resource.

    ", + "smithy.api#documentation": "

    Identifier\n of the resource.

    ", "smithy.api#required": {} } }, @@ -6074,13 +6665,13 @@ "terraformSourceName": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    \n The name of the Terraform S3 state file this resource belongs to. \n

    " + "smithy.api#documentation": "

    The name of the Terraform S3 state file this resource belongs to.

    " } }, "eksSourceName": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

    \n \n

    This parameter accepts values in \"eks-cluster/namespace\" format.

    \n     " + "smithy.api#documentation": "

    Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

    \n \n

    This parameter accepts values in \"eks-cluster/namespace\" format.

    \n     " } } }, @@ -6088,6 +6679,9 @@ "smithy.api#documentation": "

    Defines a logical resource identifier.

    " } }, + "com.amazonaws.resiliencehub#LongOptional": { + "type": "long" + }, "com.amazonaws.resiliencehub#MaxResults": { "type": "integer", "traits": { @@ -6103,6 +6697,48 @@ "smithy.api#pattern": "^\\S{1,2000}$" } }, + "com.amazonaws.resiliencehub#PermissionModel": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.resiliencehub#PermissionModelType", + "traits": { + "smithy.api#documentation": "

    Defines how Resilience Hub scans your resources. It can scan for the resources by\n using a pre-existing role in your Amazon Web Services account, or by using the credentials of\n the current IAM user.

    ", + "smithy.api#required": {} + } + }, + "invokerRoleName": { + "target": "com.amazonaws.resiliencehub#IamRoleName", + "traits": { + "smithy.api#documentation": "

    Existing Amazon Web Services\n IAM role name in the primary Amazon Web Services account that will be assumed by\n Resilience Hub Service Principle to obtain a read-only access to your application\n resources while running an assessment.

    \n \n

    You must have iam:passRole permission for this role while creating or\n updating the application.

    \n     " + } + }, + "crossAccountRoleArns": { + "target": "com.amazonaws.resiliencehub#IamRoleArnList", + "traits": { + "smithy.api#documentation": "

    Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These\n ARNs are used for querying purposes while importing resources and assessing your\n application.

    \n \n
      \n
    • \n

      These ARNs are required only when your resources are in other accounts and you have\n different role name in these accounts. Else, the invoker role name will be used in the\n other accounts.

      \n
      • \n
    • \n

      These roles must have a trust policy with iam:AssumeRole permission to\n the invoker role in the primary account.

      \n
      • \n
    \n     " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Defines the roles and credentials that Resilience Hub would use while creating the\n application, importing its resources, and running an assessment.

    " + } + }, + "com.amazonaws.resiliencehub#PermissionModelType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LegacyIAMUser", + "name": "LEGACY_IAM_USER" + }, + { + "value": "RoleBased", + "name": "ROLE_BASED" + } + ] + } + }, "com.amazonaws.resiliencehub#PhysicalIdentifierType": { "type": "string", "traits": { @@ -6130,14 +6766,14 @@ "logicalResourceId": { "target": "com.amazonaws.resiliencehub#LogicalResourceId", "traits": { - "smithy.api#documentation": "

    The logical identifier of the resource.

    ", + "smithy.api#documentation": "

    Logical\n identifier of the resource.

    ", "smithy.api#required": {} } }, "physicalResourceId": { "target": "com.amazonaws.resiliencehub#PhysicalResourceId", "traits": { - "smithy.api#documentation": "

    The physical identifier of the resource.

    ", + "smithy.api#documentation": "

    Identifier\n of the physical\n resource.

    ", "smithy.api#required": {} } }, @@ -6169,18 +6805,18 @@ "sourceType": { "target": "com.amazonaws.resiliencehub#ResourceSourceType", "traits": { - "smithy.api#documentation": "

    The type of input source.

    " + "smithy.api#documentation": "

    Type of input source.

    " } }, "parentResourceName": { "target": "com.amazonaws.resiliencehub#EntityName", "traits": { - "smithy.api#documentation": "

    The name of the parent resource.

    " + "smithy.api#documentation": "

    Name of the parent resource.

    " } } }, "traits": { - "smithy.api#documentation": "

    Defines a physical resource. A physical resource is a resource that exists in your\n account. It can be identified using an Amazon Resource Name (ARN) or an Resilience Hub-native\n identifier.

    " + "smithy.api#documentation": "

    Defines a physical resource. A physical resource is a resource that exists in your\n account. It can be identified using an Amazon Resource Name (ARN) or an Resilience Hub-native identifier.

    " } }, "com.amazonaws.resiliencehub#PhysicalResourceId": { @@ -6189,14 +6825,14 @@ "identifier": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    The identifier of the physical resource.

    ", + "smithy.api#documentation": "

    Identifier\n of the physical resource.

    ", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.resiliencehub#PhysicalIdentifierType", "traits": { - "smithy.api#documentation": "

    Specifies the type of physical resource identifier.

    \n
    \n
    Arn
    \n
    \n

    The resource identifier is an Amazon Resource Name (ARN) .

    \n
    \n
    Native
    \n
    \n

    The resource identifier is an Resilience Hub-native identifier.

    \n
    \n
    ", + "smithy.api#documentation": "

    Specifies the type of physical resource identifier.

    \n
    \n
    Arn
    \n
    \n

    The resource identifier is an Amazon Resource Name (ARN) and it can identify the\n following list of resources:

    \n
      \n
    • \n

      \n AWS::ECS::Service\n

      \n
      • \n
    • \n

      \n AWS::EFS::FileSystem\n

      \n
      • \n
    • \n

      \n AWS::ElasticLoadBalancingV2::LoadBalancer\n

      \n
      • \n
    • \n

      \n AWS::Lambda::Function\n

      \n
      • \n
    • \n

      \n AWS::SNS::Topic\n

      \n
      • \n
    \n
    \n
    Native
    \n
    \n

    The resource identifier is an Resilience Hub-native identifier and it can\n identify the following list of resources:

    \n
      \n
    • \n

      \n AWS::ApiGateway::RestApi\n

      \n
      • \n
    • \n

      \n AWS::ApiGatewayV2::Api\n

      \n
      • \n
    • \n

      \n AWS::AutoScaling::AutoScalingGroup\n

      \n
      • \n
    • \n

      \n AWS::DocDB::DBCluster\n

      \n
      • \n
    • \n

      \n AWS::DocDB::DBGlobalCluster\n

      \n
      • \n
    • \n

      \n AWS::DocDB::DBInstance\n

      \n
      • \n
    • \n

      \n AWS::DynamoDB::GlobalTable\n

      \n
      • \n
    • \n

      \n AWS::DynamoDB::Table\n

      \n
      • \n
    • \n

      \n AWS::EC2::EC2Fleet\n

      \n
      • \n
    • \n

      \n AWS::EC2::Instance\n

      \n
      • \n
    • \n

      \n AWS::EC2::NatGateway\n

      \n
      • \n
    • \n

      \n AWS::EC2::Volume\n

      \n
      • \n
    • \n

      \n AWS::ElasticLoadBalancing::LoadBalancer\n

      \n
      • \n
    • \n

      \n AWS::RDS::DBCluster\n

      \n
      • \n
    • \n

      \n AWS::RDS::DBInstance\n

      \n
      • \n
    • \n

      \n AWS::RDS::GlobalCluster\n

      \n
      • \n
    • \n

      \n AWS::Route53::RecordSet\n

      \n
      • \n
    • \n

      \n AWS::S3::Bucket\n

      \n
      • \n
    • \n

      \n AWS::SQS::Queue\n

      \n
      • \n
    \n
    \n
    ", "smithy.api#required": {} } }, @@ -6266,9 +6902,15 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } + }, + "versionName": { + "target": "com.amazonaws.resiliencehub#EntityVersion", + "traits": { + "smithy.api#documentation": "

    Name of the application version.

    " + } } } }, @@ -6278,7 +6920,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -6287,6 +6929,18 @@ "traits": { "smithy.api#documentation": "

    The version of the application.

    " } + }, + "identifier": { + "target": "com.amazonaws.resiliencehub#LongOptional", + "traits": { + "smithy.api#documentation": "

    Identifier of the application version.

    " + } + }, + "versionName": { + "target": "com.amazonaws.resiliencehub#EntityVersion", + "traits": { + "smithy.api#documentation": "

    Name of the application version.

    " + } } } }, @@ -6333,14 +6987,14 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "appTemplateBody": { "target": "com.amazonaws.resiliencehub#AppTemplateBody", "traits": { - "smithy.api#documentation": "

    A JSON string that provides information about your application structure. To learn more\n about the appTemplateBody template, see the sample template provided in the\n Examples section.

    \n

    The appTemplateBody JSON string has the following structure:

    \n
      \n
    • \n

      \n \n resources\n \n

      \n

      The list of logical resources that\n must\n be included in the Resilience Hub application.

      \n

      Type: Array

      \n \n

      Don't add the resources that you want to exclude.

      \n       \n

      Each resources array item includes the following fields:

      \n
        \n
      • \n

        \n \n logicalResourceId\n \n

        \n

        The logical identifier of the resource.

        \n

        Type: Object

        \n

        Each logicalResourceId object includes the following fields:

        \n
          \n
        • \n

          \n identifier\n

          \n

          The identifier of the resource.

          \n

          Type: String

          \n
          • \n
        • \n

          \n logicalStackName\n

          \n

          The name of the CloudFormation stack this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n resourceGroupName\n

          \n

          The name of the resource group this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n terraformSourceName\n

          \n

          The name of the Terraform S3 state file this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n eksSourceName\n

          \n

          The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

          \n \n

          This parameter accepts values in \"eks-cluster/namespace\" format.

          \n           \n

          Type: String

          \n
          • \n
        \n
        • \n
      • \n

        \n \n type\n \n

        \n

        The type of resource.

        \n

        Type: string

        \n
        • \n
      • \n

        \n \n name\n \n

        \n

        The name of the resource.

        \n

        Type: String

        \n
        • \n
      • \n

        \n additionalInfo\n

        \n

        Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

        \n \n

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        \n

        Key: \"failover-regions\"\n

        \n

        Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n

        \n         \n
        • \n
      \n
      • \n
    • \n

      \n \n appComponents\n \n

      \n

      The list of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

      \n

      Type: Array

      \n

      Each appComponents array item includes the following fields:

      \n
        \n
      • \n

        \n name\n

        \n

        The name of the Application Component.

        \n

        Type: String

        \n
        • \n
      • \n

        \n type\n

        \n

        The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

        \n

        Type: String

        \n
        • \n
      • \n

        \n resourceNames\n

        \n

        The list of included resources that are assigned to the Application Component.

        \n

        Type: Array of strings

        \n
        • \n
      • \n

        \n additionalInfo\n

        \n

        Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

        \n \n

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        \n

        Key: \"failover-regions\"\n

        \n

        Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n

        \n         \n
        • \n
      \n
      • \n
    • \n

      \n \n excludedResources\n \n

      \n

      The list of logical resource identifiers to be excluded from the application.

      \n

      Type: Array

      \n \n

      Don't add the resources that you want to include.

      \n       \n

      Each excludedResources array item includes the following fields:

      \n
        \n
      • \n

        \n \n logicalResourceIds\n \n

        \n

        The logical identifier of the resource.

        \n

        Type: Object

        \n \n

        You can configure only one of the following fields:

        \n
          \n
        • \n

          \n logicalStackName\n

          \n
          • \n
        • \n

          \n resourceGroupName\n

          \n
          • \n
        • \n

          \n terraformSourceName\n

          \n
          • \n
        • \n

          \n eksSourceName\n

          \n
          • \n
        \n         \n

        Each logicalResourceIds object includes the following fields:

        \n
          \n
        • \n

          \n identifier\n

          \n

          The identifier of the resource.

          \n

          Type: String

          \n
          • \n
        • \n

          \n logicalStackName\n

          \n

          The name of the CloudFormation stack this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n resourceGroupName\n

          \n

          The name of the resource group this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n terraformSourceName\n

          \n

          The name of the Terraform S3 state file this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n eksSourceName\n

          \n

          The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

          \n \n

          This parameter accepts values in \"eks-cluster/namespace\" format.

          \n           \n

          Type: String

          \n
          • \n
        \n
        • \n
      \n
      • \n
    • \n

      \n \n version\n \n

      \n

      The Resilience Hub application version.

      \n
      • \n
    • \n

      \n additionalInfo\n

      \n

      Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

      \n \n

      Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

      \n

      Key: \"failover-regions\"\n

      \n

      Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n

      \n       \n
      • \n
    ", + "smithy.api#documentation": "

    A JSON string that provides information about your application structure. To learn more\n about the appTemplateBody template, see the sample template provided in the\n Examples section.

    \n

    The appTemplateBody JSON string has the following structure:

    \n
      \n
    • \n

      \n \n resources\n \n

      \n

      The list of logical resources that must be included in the Resilience Hub\n application.

      \n

      Type: Array

      \n \n

      Don't add the resources that you want to exclude.

      \n       \n

      Each resources array item includes the following fields:

      \n
        \n
      • \n

        \n \n logicalResourceId\n \n

        \n

        Logical identifier of the resource.

        \n

        Type: Object

        \n

        Each logicalResourceId object includes the following fields:

        \n
          \n
        • \n

          \n identifier\n

          \n

          Identifier of the resource.

          \n

          Type: String

          \n
          • \n
        • \n

          \n logicalStackName\n

          \n

          The name of the CloudFormation stack this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n resourceGroupName\n

          \n

          The name of the resource group this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n terraformSourceName\n

          \n

          The name of the Terraform S3 state file this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n eksSourceName\n

          \n

          Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

          \n \n

          This parameter accepts values in \"eks-cluster/namespace\" format.

          \n           \n

          Type: String

          \n
          • \n
        \n
        • \n
      • \n

        \n \n type\n \n

        \n

        The type of resource.

        \n

        Type: string

        \n
        • \n
      • \n

        \n \n name\n \n

        \n

        The name of the resource.

        \n

        Type: String

        \n
        • \n
      • \n

        \n additionalInfo\n

        \n

        Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

        \n \n

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        \n

        Key: \"failover-regions\"\n

        \n

        Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n

        \n         \n
        • \n
      \n
      • \n
    • \n

      \n \n appComponents\n \n

      \n

      List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

      \n

      Type: Array

      \n

      Each appComponents array item includes the following fields:

      \n
        \n
      • \n

        \n name\n

        \n

        Name of the Application Component.

        \n

        Type: String

        \n
        • \n
      • \n

        \n type\n

        \n

        Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

        \n

        Type: String

        \n
        • \n
      • \n

        \n resourceNames\n

        \n

        The list of included resources that are assigned to the Application Component.

        \n

        Type: Array of strings

        \n
        • \n
      • \n

        \n additionalInfo\n

        \n

        Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

        \n \n

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        \n

        Key: \"failover-regions\"\n

        \n

        Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n

        \n         \n
        • \n
      \n
      • \n
    • \n

      \n \n excludedResources\n \n

      \n

      The list of logical resource identifiers to be excluded from the application.

      \n

      Type: Array

      \n \n

      Don't add the resources that you want to include.

      \n       \n

      Each excludedResources array item includes the following fields:

      \n
        \n
      • \n

        \n \n logicalResourceIds\n \n

        \n

        Logical identifier of the resource.

        \n

        Type: Object

        \n \n

        You can configure only one of the following fields:

        \n
          \n
        • \n

          \n logicalStackName\n

          \n
          • \n
        • \n

          \n resourceGroupName\n

          \n
          • \n
        • \n

          \n terraformSourceName\n

          \n
          • \n
        • \n

          \n eksSourceName\n

          \n
          • \n
        \n         \n

        Each logicalResourceIds object includes the following fields:

        \n
          \n
        • \n

          \n identifier\n

          \n

          Identifier of the resource.

          \n

          Type: String

          \n
          • \n
        • \n

          \n logicalStackName\n

          \n

          The name of the CloudFormation stack this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n resourceGroupName\n

          \n

          The name of the resource group this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n terraformSourceName\n

          \n

          The name of the Terraform S3 state file this resource belongs to.

          \n

          Type: String

          \n
          • \n
        • \n

          \n eksSourceName\n

          \n

          Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

          \n \n

          This parameter accepts values in \"eks-cluster/namespace\" format.

          \n           \n

          Type: String

          \n
          • \n
        \n
        • \n
      \n
      • \n
    • \n

      \n \n version\n \n

      \n

      Resilience Hub application version.

      \n
      • \n
    • \n

      \n additionalInfo\n

      \n

      Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

      \n \n

      Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

      \n

      Key: \"failover-regions\"\n

      \n

      Value: \"[{\"region\":\"<REGION>\", \"accounts\":[{\"id\":\"<ACCOUNT_ID>\"}]}]\"\n

      \n       \n
      • \n
    ", "smithy.api#required": {} } } @@ -6352,7 +7006,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " } }, "appVersion": { @@ -6450,13 +7104,13 @@ "resourceId": { "target": "com.amazonaws.resiliencehub#String500", "traits": { - "smithy.api#documentation": "

    The resource identifier.

    " + "smithy.api#documentation": "

    Identifier of the resource.

    " } }, "targetAccountId": { "target": "com.amazonaws.resiliencehub#CustomerId", "traits": { - "smithy.api#documentation": "

    The target account identifier.

    " + "smithy.api#documentation": "

    Identifier\n of the target account.

    " } }, "targetRegion": { @@ -6470,6 +7124,18 @@ "traits": { "smithy.api#documentation": "

    Specifies if the recommendation has already been implemented.

    " } + }, + "excluded": { + "target": "com.amazonaws.resiliencehub#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    Indicates if an operational recommendation item is excluded.

    " + } + }, + "excludeReason": { + "target": "com.amazonaws.resiliencehub#ExcludeRecommendationReason", + "traits": { + "smithy.api#documentation": "

    Indicates the reason for excluding an operational recommendation.

    " + } } }, "traits": { @@ -6494,14 +7160,14 @@ "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition:resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " } }, "recommendationIds": { @@ -6520,34 +7186,34 @@ "format": { "target": "com.amazonaws.resiliencehub#TemplateFormat", "traits": { - "smithy.api#documentation": "

    The format of the recommendation template.

    \n
    \n
    CfnJson
    \n
    \n

    The template is CloudFormation JSON.

    \n
    \n
    CfnYaml
    \n
    \n

    The template is CloudFormation YAML.

    \n
    \n
    ", + "smithy.api#documentation": "

    Format of the recommendation template.

    \n
    \n
    CfnJson
    \n
    \n

    The template is CloudFormation JSON.

    \n
    \n
    CfnYaml
    \n
    \n

    The template is CloudFormation YAML.

    \n
    \n
    ", "smithy.api#required": {} } }, "recommendationTemplateArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the recommendation template.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) for the recommendation template.

    ", "smithy.api#required": {} } }, "message": { "target": "com.amazonaws.resiliencehub#String500", "traits": { - "smithy.api#documentation": "

    The message for the recommendation template.

    " + "smithy.api#documentation": "

    Message for the recommendation template.

    " } }, "status": { "target": "com.amazonaws.resiliencehub#RecommendationTemplateStatus", "traits": { - "smithy.api#documentation": "

    The status of the action.

    ", + "smithy.api#documentation": "

    Status of the action.

    ", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.resiliencehub#EntityName", "traits": { - "smithy.api#documentation": "

    The name for the recommendation template.

    ", + "smithy.api#documentation": "

    Name for the recommendation template.

    ", "smithy.api#required": {} } }, @@ -6566,7 +7232,7 @@ "tags": { "target": "com.amazonaws.resiliencehub#TagMap", "traits": { - "smithy.api#documentation": "

    The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.

    " + "smithy.api#documentation": "

    Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.

    " } }, "needsReplacements": { @@ -6664,7 +7330,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -6712,7 +7378,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " } }, "appVersion": { @@ -6766,7 +7432,7 @@ "policyArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " } }, "policyName": { @@ -6814,7 +7480,7 @@ "tags": { "target": "com.amazonaws.resiliencehub#TagMap", "traits": { - "smithy.api#documentation": "

    The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.

    " + "smithy.api#documentation": "

    Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.

    " } } }, @@ -6845,6 +7511,10 @@ { "value": "NonCritical", "name": "NON_CRITICAL" + }, + { + "value": "NotApplicable", + "name": "NOT_APPLICABLE" } ] } @@ -6915,7 +7585,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -6934,7 +7604,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -6955,7 +7625,7 @@ "status": { "target": "com.amazonaws.resiliencehub#ResourceResolutionStatusType", "traits": { - "smithy.api#documentation": "

    The status of the action.

    ", + "smithy.api#documentation": "

    Status of the action.

    ", "smithy.api#required": {} } } @@ -6967,24 +7637,24 @@ "logicalResourceId": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    \n This is the identifier of the resource.\n

    " + "smithy.api#documentation": "

    Identifier\n of the\n logical resource.

    " } }, "physicalResourceId": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    \n This is the identifier of the physical resource.\n

    " + "smithy.api#documentation": "

    Identifier\n of the physical resource.

    " } }, "reason": { "target": "com.amazonaws.resiliencehub#ErrorMessage", "traits": { - "smithy.api#documentation": "

    \n This is the error message.\n

    " + "smithy.api#documentation": "

    This is the error message.

    " } } }, "traits": { - "smithy.api#documentation": "

    \n Defines application resource errors.\n

    " + "smithy.api#documentation": "

    Defines application resource errors.

    " } }, "com.amazonaws.resiliencehub#ResourceErrorList": { @@ -6999,18 +7669,18 @@ "resourceErrors": { "target": "com.amazonaws.resiliencehub#ResourceErrorList", "traits": { - "smithy.api#documentation": "

    \n A list of errors retrieving an application's resources.\n

    " + "smithy.api#documentation": "

    A list of errors retrieving an application's resources.

    " } }, "hasMoreErrors": { "target": "com.amazonaws.resiliencehub#BooleanOptional", "traits": { - "smithy.api#documentation": "

    \n This indicates if there are more errors not listed in the resourceErrors list.\n

    " + "smithy.api#documentation": "

    This indicates if there are more errors not listed in the resourceErrors list.

    " } } }, "traits": { - "smithy.api#documentation": "

    \n A list of errors retrieving an application's resources.\n

    " + "smithy.api#documentation": "

    A list of errors retrieving an application's resources.

    " } }, "com.amazonaws.resiliencehub#ResourceId": { @@ -7063,7 +7733,7 @@ "resourceName": { "target": "com.amazonaws.resiliencehub#EntityName", "traits": { - "smithy.api#documentation": "

    The name of the resource this resource is mapped to.

    " + "smithy.api#documentation": "

    Name\n of the resource that\n the\n resource is mapped to.

    " } }, "logicalStackName": { @@ -7081,7 +7751,7 @@ "resourceGroupName": { "target": "com.amazonaws.resiliencehub#EntityName", "traits": { - "smithy.api#documentation": "

    The name of the resource group this resource is mapped to.

    " + "smithy.api#documentation": "

    Name\n of the resource group\n that\n the\n resource is mapped to.

    " } }, "mappingType": { @@ -7094,20 +7764,20 @@ "physicalResourceId": { "target": "com.amazonaws.resiliencehub#PhysicalResourceId", "traits": { - "smithy.api#documentation": "

    The identifier of this resource.

    ", + "smithy.api#documentation": "

    Identifier\n of the physical resource.

    ", "smithy.api#required": {} } }, "terraformSourceName": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    \n The short name of the Terraform source.\n

    " + "smithy.api#documentation": "

    The short name of the Terraform source.

    " } }, "eksSourceName": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    The name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

    \n \n

    This parameter accepts values in \"eks-cluster/namespace\" format.

    \n     " + "smithy.api#documentation": "

    Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

    \n \n

    This parameter accepts values in \"eks-cluster/namespace\" format.

    \n     " } } }, @@ -7288,13 +7958,13 @@ "appComponentName": { "target": "com.amazonaws.resiliencehub#EntityId", "traits": { - "smithy.api#documentation": "

    The name of the Application Component.

    " + "smithy.api#documentation": "

    Name of the Application Component.

    " } }, "description": { "target": "com.amazonaws.resiliencehub#String500", "traits": { - "smithy.api#documentation": "

    The description of the SOP recommendation.

    " + "smithy.api#documentation": "

    Description of the SOP recommendation.

    " } }, "recommendationId": { @@ -7307,7 +7977,7 @@ "name": { "target": "com.amazonaws.resiliencehub#DocumentName", "traits": { - "smithy.api#documentation": "

    The name of the SOP recommendation.

    " + "smithy.api#documentation": "

    Name of the SOP recommendation.

    " } }, "items": { @@ -7319,14 +7989,14 @@ "referenceId": { "target": "com.amazonaws.resiliencehub#SpecReferenceId", "traits": { - "smithy.api#documentation": "

    The reference identifier for the SOP recommendation.

    ", + "smithy.api#documentation": "

    Reference\n identifier for the SOP recommendation.

    ", "smithy.api#required": {} } }, "prerequisite": { "target": "com.amazonaws.resiliencehub#String500", "traits": { - "smithy.api#documentation": "

    The prerequisite for the SOP recommendation.

    " + "smithy.api#documentation": "

    Prerequisite for the SOP recommendation.

    " } } }, @@ -7406,7 +8076,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -7434,7 +8104,7 @@ "tags": { "target": "com.amazonaws.resiliencehub#TagMap", "traits": { - "smithy.api#documentation": "

    The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.

    " + "smithy.api#documentation": "

    Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.

    " } } } @@ -7584,7 +8254,7 @@ "resourceArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the resource.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7633,13 +8303,13 @@ "s3StateFileUrl": { "target": "com.amazonaws.resiliencehub#S3Url", "traits": { - "smithy.api#documentation": "

    \n The URL of the Terraform s3 state file you need to import.\n

    ", + "smithy.api#documentation": "

    The URL of the Terraform s3 state file you need to import.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    \n The Terraform s3 state file you need to import.\n

    " + "smithy.api#documentation": "

    The Terraform s3 state file you need to import.

    " } }, "com.amazonaws.resiliencehub#TerraformSourceList": { @@ -7660,44 +8330,44 @@ "referenceId": { "target": "com.amazonaws.resiliencehub#SpecReferenceId", "traits": { - "smithy.api#documentation": "

    The reference identifier for the test recommendation.

    ", + "smithy.api#documentation": "

    Reference\n identifier for the test recommendation.

    ", "smithy.api#required": {} } }, "appComponentName": { "target": "com.amazonaws.resiliencehub#EntityId", "traits": { - "smithy.api#documentation": "

    The name of the Application Component.

    " + "smithy.api#documentation": "

    Name of the Application Component.

    " } }, "name": { "target": "com.amazonaws.resiliencehub#DocumentName", "traits": { - "smithy.api#documentation": "

    The name of the test recommendation.

    " + "smithy.api#documentation": "

    Name of the test recommendation.

    " } }, "intent": { "target": "com.amazonaws.resiliencehub#EntityDescription", "traits": { - "smithy.api#documentation": "

    The intent of the test recommendation.

    " + "smithy.api#documentation": "

    Intent of the test recommendation.

    " } }, "risk": { "target": "com.amazonaws.resiliencehub#TestRisk", "traits": { - "smithy.api#documentation": "

    The level of risk for this test recommendation.

    " + "smithy.api#documentation": "

    Level of risk for this test recommendation.

    " } }, "type": { "target": "com.amazonaws.resiliencehub#TestType", "traits": { - "smithy.api#documentation": "

    The type of test recommendation.

    " + "smithy.api#documentation": "

    Type of test recommendation.

    " } }, "description": { "target": "com.amazonaws.resiliencehub#String500", "traits": { - "smithy.api#documentation": "

    The description for the test recommendation.

    " + "smithy.api#documentation": "

    Description for the test recommendation.

    " } }, "items": { @@ -7709,13 +8379,13 @@ "prerequisite": { "target": "com.amazonaws.resiliencehub#String500", "traits": { - "smithy.api#documentation": "

    The prerequisite of the test recommendation.

    " + "smithy.api#documentation": "

    Prerequisite of the test recommendation.

    " } }, "dependsOnAlarms": { "target": "com.amazonaws.resiliencehub#AlarmReferenceIdList", "traits": { - "smithy.api#documentation": "

    \n A list of recommended alarms that are used in the test and must be exported before or with the test.\n

    " + "smithy.api#documentation": "

    A list of recommended alarms that are used in the test and must be exported before or\n with the test.

    " } } }, @@ -7799,14 +8469,14 @@ "logicalResourceId": { "target": "com.amazonaws.resiliencehub#LogicalResourceId", "traits": { - "smithy.api#documentation": "

    The logical resource identifier for the unsupported resource.

    ", + "smithy.api#documentation": "

    Logical\n resource identifier for the unsupported resource.

    ", "smithy.api#required": {} } }, "physicalResourceId": { "target": "com.amazonaws.resiliencehub#PhysicalResourceId", "traits": { - "smithy.api#documentation": "

    The physical resource identifier for the unsupported resource.

    ", + "smithy.api#documentation": "

    Physical\n resource identifier for the unsupported resource.

    ", "smithy.api#required": {} } }, @@ -7874,7 +8544,7 @@ "resourceArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the resource.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7936,7 +8606,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -7949,7 +8619,7 @@ "policyArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    " } }, "clearResiliencyPolicyArn": { @@ -7963,6 +8633,18 @@ "traits": { "smithy.api#documentation": "

    \n Assessment execution schedule with 'Daily' or 'Disabled' values.\n

    " } + }, + "permissionModel": { + "target": "com.amazonaws.resiliencehub#PermissionModel", + "traits": { + "smithy.api#documentation": "

    Defines the roles and credentials that Resilience Hub would use while creating\n an\n application, importing its resources, and running an assessment.

    " + } + }, + "eventSubscriptions": { + "target": "com.amazonaws.resiliencehub#EventSubscriptionList", + "traits": { + "smithy.api#documentation": "

    The list of events you would like to subscribe and get notification for.\n Currently, Resilience Hub supports notifications only for Drift\n detected and Scheduled assessment failure\n events.

    " + } } } }, @@ -8058,27 +8740,27 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    The identifier of the Application Component.

    ", + "smithy.api#documentation": "

    Identifier of the Application Component.

    ", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    The name of the Application Component.

    " + "smithy.api#documentation": "

    Name of the Application Component.

    " } }, "type": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    The type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

    " + "smithy.api#documentation": "

    Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

    " } }, "additionalInfo": { @@ -8095,21 +8777,21 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The Resilience Hub application version.

    ", + "smithy.api#documentation": "

    Resilience Hub application version.

    ", "smithy.api#required": {} } }, "appComponent": { "target": "com.amazonaws.resiliencehub#AppComponent", "traits": { - "smithy.api#documentation": "

    The list of Application Components that belong to this resource.

    " + "smithy.api#documentation": "

    List of Application Components that belong to this resource.

    " } } } @@ -8120,7 +8802,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, @@ -8178,50 +8860,50 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "resourceName": { "target": "com.amazonaws.resiliencehub#EntityName", "traits": { - "smithy.api#documentation": "

    The name of the resource.

    " + "smithy.api#documentation": "

    Name of the resource.

    " } }, "logicalResourceId": { "target": "com.amazonaws.resiliencehub#LogicalResourceId", "traits": { - "smithy.api#documentation": "

    The logical identifier of the resource.

    " + "smithy.api#documentation": "

    Logical identifier of the resource.

    " } }, "physicalResourceId": { "target": "com.amazonaws.resiliencehub#String2048", "traits": { - "smithy.api#documentation": "

    The physical identifier of the resource.

    " + "smithy.api#documentation": "

    Physical identifier of the resource.

    " } }, "awsRegion": { "target": "com.amazonaws.resiliencehub#AwsRegion", "traits": { - "smithy.api#documentation": "

    The Amazon Web Services region that owns the physical resource.

    " + "smithy.api#documentation": "

    Amazon Web Services region that owns the physical resource.

    " } }, "awsAccountId": { "target": "com.amazonaws.resiliencehub#CustomerId", "traits": { - "smithy.api#documentation": "

    The Amazon Web Services account that owns the physical resource.

    " + "smithy.api#documentation": "

    Amazon Web Services account that owns the physical resource.

    " } }, "resourceType": { "target": "com.amazonaws.resiliencehub#String255", "traits": { - "smithy.api#documentation": "

    The type of resource.

    " + "smithy.api#documentation": "

    Type of resource.

    " } }, "appComponents": { "target": "com.amazonaws.resiliencehub#AppComponentNameList", "traits": { - "smithy.api#documentation": "

    The list of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

    " + "smithy.api#documentation": "

    List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

    " } }, "additionalInfo": { @@ -8244,14 +8926,14 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The Resilience Hub application version.

    ", + "smithy.api#documentation": "

    Resilience Hub application version.

    ", "smithy.api#required": {} } }, @@ -8269,14 +8951,14 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: \narn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, "appVersion": { "target": "com.amazonaws.resiliencehub#EntityVersion", "traits": { - "smithy.api#documentation": "

    The Resilience Hub application version.

    ", + "smithy.api#documentation": "

    Resilience Hub application version.

    ", "smithy.api#required": {} } }, @@ -8288,6 +8970,86 @@ } } }, + "com.amazonaws.resiliencehub#UpdateRecommendationStatusItem": { + "type": "structure", + "members": { + "resourceId": { + "target": "com.amazonaws.resiliencehub#String500", + "traits": { + "smithy.api#documentation": "

    Resource identifier of the operational recommendation item.

    " + } + }, + "targetAccountId": { + "target": "com.amazonaws.resiliencehub#CustomerId", + "traits": { + "smithy.api#documentation": "

    Identifier of the target Amazon Web Services account.

    " + } + }, + "targetRegion": { + "target": "com.amazonaws.resiliencehub#AwsRegion", + "traits": { + "smithy.api#documentation": "

    Identifier of the target Amazon Web Services Region.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Defines the operational recommendation item that needs a status update.

    " + } + }, + "com.amazonaws.resiliencehub#UpdateRecommendationStatusRequestEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#UpdateRecommendationStatusRequestEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.resiliencehub#UpdateRecommendationStatusRequestEntry": { + "type": "structure", + "members": { + "entryId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "

    An identifier for an entry in this batch that is used to communicate the result.

    \n \n

    The entryIds of a batch request need to be unique within a request.

    \n     ", + "smithy.api#required": {} + } + }, + "referenceId": { + "target": "com.amazonaws.resiliencehub#SpecReferenceId", + "traits": { + "smithy.api#documentation": "

    Reference identifier of the operational recommendation item.

    ", + "smithy.api#required": {} + } + }, + "item": { + "target": "com.amazonaws.resiliencehub#UpdateRecommendationStatusItem", + "traits": { + "smithy.api#documentation": "

    The operational recommendation item.

    ", + "smithy.api#required": {} + } + }, + "excluded": { + "target": "com.amazonaws.resiliencehub#BooleanOptional", + "traits": { + "smithy.api#documentation": "

    Indicates if the operational recommendation needs to be excluded. If set to True, the\n operational recommendation will be excluded.

    ", + "smithy.api#required": {} + } + }, + "excludeReason": { + "target": "com.amazonaws.resiliencehub#ExcludeRecommendationReason", + "traits": { + "smithy.api#documentation": "

    Indicates the reason for excluding an operational recommendation.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Defines the operational recommendation item that is to be included or excluded.

    " + } + }, "com.amazonaws.resiliencehub#UpdateResiliencyPolicy": { "type": "operation", "input": { @@ -8331,7 +9093,7 @@ "policyArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", + "smithy.api#documentation": "

    Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition:resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference guide.

    ", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/route-53.json b/codegen/sdk/aws-models/route-53.json index 5d050f8b5890..388346dd5b73 100644 --- a/codegen/sdk/aws-models/route-53.json +++ b/codegen/sdk/aws-models/route-53.json @@ -2718,6 +2718,12 @@ "traits": { "smithy.api#enumValue": "ap-southeast-4" } + }, + "il_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "il-central-1" + } } }, "traits": { @@ -3480,7 +3486,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates resource record sets in a specified hosted zone based on the settings in a\n\t\t\tspecified traffic policy version. In addition, CreateTrafficPolicyInstance\n\t\t\tassociates the resource record sets with a specified domain name (such as example.com)\n\t\t\tor subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for\n\t\t\tthe domain or subdomain name by using the resource record sets that\n\t\t\t\tCreateTrafficPolicyInstance created.

    \n \n

    After you submit an CreateTrafficPolicyInstance request, there's a\n\t\t\t\tbrief delay while Amazon Route 53 creates the resource record sets that are\n\t\t\t\tspecified in the traffic policy definition. \n\t\t\t\tUse GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the CreateTrafficPolicyInstance\n\t\t\t\trequest completed successfully. For more information, see the\n\t\t\t\tState response element.

    \n     ", + "smithy.api#documentation": "

    Creates resource record sets in a specified hosted zone based on the settings in a\n\t\t\tspecified traffic policy version. In addition, CreateTrafficPolicyInstance\n\t\t\tassociates the resource record sets with a specified domain name (such as example.com)\n\t\t\tor subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for\n\t\t\tthe domain or subdomain name by using the resource record sets that\n\t\t\t\tCreateTrafficPolicyInstance created.

    ", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/trafficpolicyinstance", @@ -5980,7 +5986,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Gets information about a specified traffic policy instance.

    \n \n

    \n\t\t\t\tUse GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the \n\t\t\t\tCreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request completed successfully. \n\t\t\t\tFor more information, see the State response\n\t\t\t\telement.

    \n     \n \n

    In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.

    \n     ", + "smithy.api#documentation": "

    Gets information about a specified traffic policy instance.

    \n \n

    After you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.

    \n     \n \n

    In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.

    \n     ", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/trafficpolicyinstance/{Id}", @@ -9950,6 +9956,12 @@ "traits": { "smithy.api#enumValue": "ap-southeast-4" } + }, + "il_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "il-central-1" + } } }, "traits": { @@ -11231,7 +11243,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

    After you submit a UpdateTrafficPolicyInstance request, there's a brief delay while Route 53 creates the resource record sets \n\t\t\tthat are specified in the traffic policy definition. Use GetTrafficPolicyInstance with the id of updated traffic policy instance confirm \n\t\t\tthat the \n\t\t\tUpdateTrafficPolicyInstance request completed successfully. For more information, see the State response element.

    \n     \n

    Updates the resource record sets in a specified hosted zone that were created based on\n\t\t\tthe settings in a specified traffic policy version.

    \n

    When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS\n\t\t\tqueries for the root resource record set name (such as example.com) while it replaces\n\t\t\tone group of resource record sets with another. Route 53 performs the following\n\t\t\toperations:

    \n
      \n
    1. \n

      Route 53 creates a new group of resource record sets based on the specified\n\t\t\t\t\ttraffic policy. This is true regardless of how significant the differences are\n\t\t\t\t\tbetween the existing resource record sets and the new resource record sets.\n\t\t\t\t

      \n
      2. \n
    2. \n

      When all of the new resource record sets have been created, Route 53 starts to\n\t\t\t\t\trespond to DNS queries for the root resource record set name (such as\n\t\t\t\t\texample.com) by using the new resource record sets.

      \n
      3. \n
    3. \n

      Route 53 deletes the old group of resource record sets that are associated\n\t\t\t\t\twith the root resource record set name.

      \n
      4. \n
    ", + "smithy.api#documentation": "

    Updates the resource record sets in a specified hosted zone that were created based on\n\t\t\tthe settings in a specified traffic policy version.

    \n

    When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS\n\t\t\tqueries for the root resource record set name (such as example.com) while it replaces\n\t\t\tone group of resource record sets with another. Route 53 performs the following\n\t\t\toperations:

    \n
      \n
    1. \n

      Route 53 creates a new group of resource record sets based on the specified\n\t\t\t\t\ttraffic policy. This is true regardless of how significant the differences are\n\t\t\t\t\tbetween the existing resource record sets and the new resource record sets.\n\t\t\t\t

      \n
      2. \n
    2. \n

      When all of the new resource record sets have been created, Route 53 starts to\n\t\t\t\t\trespond to DNS queries for the root resource record set name (such as\n\t\t\t\t\texample.com) by using the new resource record sets.

      \n
      3. \n
    3. \n

      Route 53 deletes the old group of resource record sets that are associated\n\t\t\t\t\twith the root resource record set name.

      \n
      4. \n
    ", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/trafficpolicyinstance/{Id}", @@ -11561,6 +11573,12 @@ "traits": { "smithy.api#enumValue": "ap-southeast-4" } + }, + "il_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "il-central-1" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/sagemaker.json b/codegen/sdk/aws-models/sagemaker.json index dab8e74076ca..2060c184b58e 100644 --- a/codegen/sdk/aws-models/sagemaker.json +++ b/codegen/sdk/aws-models/sagemaker.json @@ -3867,7 +3867,7 @@ "EndTimeOffset": { "target": "com.amazonaws.sagemaker#MonitoringTimeOffsetString", "traits": { - "smithy.api#documentation": "

    If specified, monitoring jobs substract this time from the end time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.

    " + "smithy.api#documentation": "

    If specified, monitoring jobs subtract this time from the end time. For information\n about using offsets for scheduling monitoring jobs, see Schedule Model\n Quality Monitoring Jobs.

    " } } }, @@ -9077,9 +9077,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 export.

    ", + "smithy.api#documentation": "

    The name or Amazon Resource Name (ARN) of the model card to export.

    ", "smithy.api#required": {} } }, @@ -11296,6 +11296,32 @@ "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,256}$" } }, + "com.amazonaws.sagemaker#CustomizedMetricSpecification": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

    The name of the customized metric.

    " + } + }, + "Namespace": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

    The namespace of the customized metric.

    " + } + }, + "Statistic": { + "target": "com.amazonaws.sagemaker#Statistic", + "traits": { + "smithy.api#documentation": "

    The statistic of the customized metric.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A customized metric.

    " + } + }, "com.amazonaws.sagemaker#DataCaptureConfig": { "type": "structure", "members": { @@ -15926,7 +15952,7 @@ "EndpointStatus": { "target": "com.amazonaws.sagemaker#EndpointStatus", "traits": { - "smithy.api#documentation": "

    The status of the endpoint.

    \n
      \n
    • \n

      \n OutOfService: Endpoint is not available to take incoming\n requests.

      \n
      • \n
    • \n

      \n Creating: CreateEndpoint is executing.

      \n
      • \n
    • \n

      \n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

      \n
      • \n
    • \n

      \n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.

      \n
      • \n
    • \n

      \n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.

      \n
      • \n
    • \n

      \n InService: Endpoint is available to process incoming\n requests.

      \n
      • \n
    • \n

      \n Deleting: DeleteEndpoint is executing.

      \n
      • \n
    • \n

      \n Failed: Endpoint could not be created, updated, or re-scaled. Use\n the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a\n failed endpoint.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The status of the endpoint.

    \n
      \n
    • \n

      \n OutOfService: Endpoint is not available to take incoming\n requests.

      \n
      • \n
    • \n

      \n Creating: CreateEndpoint is executing.

      \n
      • \n
    • \n

      \n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

      \n
      • \n
    • \n

      \n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.

      \n
      • \n
    • \n

      \n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.

      \n
      • \n
    • \n

      \n InService: Endpoint is available to process incoming\n requests.

      \n
      • \n
    • \n

      \n Deleting: DeleteEndpoint is executing.

      \n
      • \n
    • \n

      \n Failed: Endpoint could not be created, updated, or re-scaled. Use\n the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a\n failed endpoint.

      \n
      • \n
    • \n

      \n UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint\n is in service with a mix of the old and new endpoint configurations. For information about how to remedy\n this issue and restore the endpoint's status to InService, see\n Rolling Deployments.

      \n
      • \n
    ", "smithy.api#required": {} } }, @@ -18050,7 +18076,7 @@ "ModelCardName": { "target": "com.amazonaws.sagemaker#EntityName", "traits": { - "smithy.api#documentation": "

    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": {} } }, @@ -18104,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": {} } }, @@ -21879,6 +21905,12 @@ } } }, + "com.amazonaws.sagemaker#Double": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, "com.amazonaws.sagemaker#DoubleParameterValue": { "type": "double" }, @@ -22000,6 +22032,48 @@ "smithy.api#documentation": "

    Represents the drift check model quality baselines that can be used when the model monitor is set using \n the model package.

    " } }, + "com.amazonaws.sagemaker#DynamicScalingConfiguration": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

    The recommended minimum capacity to specify for your autoscaling policy.

    " + } + }, + "MaxCapacity": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

    The recommended maximum capacity to specify for your autoscaling policy.

    " + } + }, + "ScaleInCooldown": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

    The recommended scale in cooldown time for your autoscaling policy.

    " + } + }, + "ScaleOutCooldown": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

    The recommended scale out cooldown time for your autoscaling policy.

    " + } + }, + "ScalingPolicies": { + "target": "com.amazonaws.sagemaker#ScalingPolicies", + "traits": { + "smithy.api#documentation": "

    An object of the scaling policies for each metric.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    An object with the recommended values for you to specify when creating an autoscaling policy.

    " + } + }, "com.amazonaws.sagemaker#EMRStepMetadata": { "type": "structure", "members": { @@ -24548,6 +24622,23 @@ } } }, + "com.amazonaws.sagemaker#FlatInvocations": { + "type": "enum", + "members": { + "CONTINUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Continue" + } + }, + "STOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stop" + } + } + } + }, "com.amazonaws.sagemaker#Float": { "type": "float", "traits": { @@ -25068,6 +25159,112 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#GetScalingConfigurationRecommendation": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#GetScalingConfigurationRecommendationRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#GetScalingConfigurationRecommendationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

    Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies\n that you can apply to your SageMaker endpoint.

    " + } + }, + "com.amazonaws.sagemaker#GetScalingConfigurationRecommendationRequest": { + "type": "structure", + "members": { + "InferenceRecommendationsJobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#documentation": "

    The name of a previously completed Inference Recommender job.

    ", + "smithy.api#required": {} + } + }, + "RecommendationId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

    The recommendation ID of a previously completed inference recommendation. This ID should come from one of the\n recommendations returned by the job specified in the InferenceRecommendationsJobName field.

    \n

    Specify either this field or the EndpointName field.

    " + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

    The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the\n recommendations returned by the job specified in the InferenceRecommendationsJobName field.

    \n

    Specify either this field or the RecommendationId field.

    " + } + }, + "TargetCpuUtilizationPerCore": { + "target": "com.amazonaws.sagemaker#UtilizationPercentagePerCore", + "traits": { + "smithy.api#documentation": "

    The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.

    " + } + }, + "ScalingPolicyObjective": { + "target": "com.amazonaws.sagemaker#ScalingPolicyObjective", + "traits": { + "smithy.api#documentation": "

    An object where you specify the anticipated traffic pattern for an endpoint.

    " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#GetScalingConfigurationRecommendationResponse": { + "type": "structure", + "members": { + "InferenceRecommendationsJobName": { + "target": "com.amazonaws.sagemaker#RecommendationJobName", + "traits": { + "smithy.api#documentation": "

    The name of a previously completed Inference Recommender job.

    " + } + }, + "RecommendationId": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

    The recommendation ID of a previously completed inference recommendation.

    " + } + }, + "EndpointName": { + "target": "com.amazonaws.sagemaker#EndpointName", + "traits": { + "smithy.api#documentation": "

    The name of an endpoint benchmarked during a previously completed Inference Recommender job.

    " + } + }, + "TargetCpuUtilizationPerCore": { + "target": "com.amazonaws.sagemaker#UtilizationPercentagePerCore", + "traits": { + "smithy.api#documentation": "

    The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%.

    " + } + }, + "ScalingPolicyObjective": { + "target": "com.amazonaws.sagemaker#ScalingPolicyObjective", + "traits": { + "smithy.api#documentation": "

    An object representing the anticipated traffic pattern for an endpoint that you specified in the request.

    " + } + }, + "Metric": { + "target": "com.amazonaws.sagemaker#ScalingPolicyMetric", + "traits": { + "smithy.api#documentation": "

    An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.

    " + } + }, + "DynamicScalingConfiguration": { + "target": "com.amazonaws.sagemaker#DynamicScalingConfiguration", + "traits": { + "smithy.api#documentation": "

    An object with the recommended values for you to specify when creating an autoscaling policy.

    " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#GetSearchSuggestions": { "type": "operation", "input": { @@ -33815,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": {} } }, @@ -37398,6 +37595,26 @@ } } }, + "com.amazonaws.sagemaker#MetricSpecification": { + "type": "union", + "members": { + "Predefined": { + "target": "com.amazonaws.sagemaker#PredefinedMetricSpecification", + "traits": { + "smithy.api#documentation": "

    Information about a predefined metric.

    " + } + }, + "Customized": { + "target": "com.amazonaws.sagemaker#CustomizedMetricSpecification", + "traits": { + "smithy.api#documentation": "

    Information about a customized metric.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    An object containing information about a metric.

    " + } + }, "com.amazonaws.sagemaker#MetricValue": { "type": "float", "traits": { @@ -37920,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": { @@ -38672,7 +38899,7 @@ "Percentile": { "target": "com.amazonaws.sagemaker#String64", "traits": { - "smithy.api#documentation": "

    The model latency percentile threshold.

    " + "smithy.api#documentation": "

    The model latency percentile threshold. For custom load tests, specify the value as P95.

    " } }, "ValueInMilliseconds": { @@ -41702,6 +41929,14 @@ } } }, + "com.amazonaws.sagemaker#NumberOfSteps": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.sagemaker#ObjectiveStatus": { "type": "enum", "members": { @@ -42177,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
      \n
    • \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:

      \n
        \n
      • \n

        float32: Use either \"float\" or \"float32\".

        \n
        • \n
      • \n

        int64: Use either \"int64\" or \"long\".

        \n
        • \n
      \n

      For example, {\"dtype\" : \"float32\"}.

      \n
      • \n
    • \n

      \n CPU: Compilation for CPU supports the following compiler\n options.

      \n
        \n
      • \n

        \n mcpu: CPU micro-architecture. For example, {'mcpu':\n 'skylake-avx512'}\n

        \n
        • \n
      • \n

        \n mattr: CPU flags. For example, {'mattr': ['+neon',\n '+vfpv4']}\n

        \n
        • \n
      \n
      • \n
    • \n

      \n ARM: Details of ARM CPU compilations.

      \n
        \n
      • \n

        \n NEON: NEON is an implementation of the Advanced SIMD\n extension used in ARMv7 processors.

        \n

        For example, add {'mattr': ['+neon']} to the compiler\n options if compiling for ARM 32-bit platform with the NEON\n support.

        \n
        • \n
      \n
      • \n
    • \n

      \n NVIDIA: Compilation for NVIDIA GPU supports the following\n compiler options.

      \n
        \n
      • \n

        \n gpu_code: Specifies the targeted architecture.

        \n
        • \n
      • \n

        \n trt-ver: Specifies the TensorRT versions in x.y.z.\n format.

        \n
        • \n
      • \n

        \n cuda-ver: Specifies the CUDA version in x.y\n format.

        \n
        • \n
      \n

      For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver':\n '10.1'}\n

      \n
      • \n
    • \n

      \n ANDROID: Compilation for the Android OS supports the following\n compiler options:

      \n
        \n
      • \n

        \n ANDROID_PLATFORM: Specifies the Android API levels.\n Available levels range from 21 to 29. For example,\n {'ANDROID_PLATFORM': 28}.

        \n
        • \n
      • \n

        \n mattr: Add {'mattr': ['+neon']} to compiler\n options if compiling for ARM 32-bit platform with NEON support.

        \n
        • \n
      \n
      • \n
    • \n

      \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

      \n

      For information about supported compiler options, see\n \n Neuron Compiler CLI.\n

      \n
      • \n
    • \n

      \n CoreML: Compilation for the CoreML OutputConfig\n TargetDevice supports the following compiler options:

      \n
        \n
      • \n

        \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
        • \n
      \n
      • \n
    • \n

      \n EIA: Compilation for the Elastic Inference Accelerator supports the following \n compiler options:

      \n
        \n
      • \n

        \n precision_mode: Specifies the precision of compiled artifacts. Supported values\n are \"FP16\" and \"FP32\". Default is\n \"FP32\".

        \n
        • \n
      • \n

        \n signature_def_key: Specifies the signature to use for models in SavedModel\n format. Defaults is TensorFlow's default signature def key.

        \n
        • \n
      • \n

        \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.

        \n
        • \n
      \n

      For example: \n {\"precision_mode\": \"FP32\", \"output_names\": [\"output:0\"]}\n

      \n
      • \n
    " + "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
      \n
    • \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:

      \n
        \n
      • \n

        float32: Use either \"float\" or \"float32\".

        \n
        • \n
      • \n

        int64: Use either \"int64\" or \"long\".

        \n
        • \n
      \n

      For example, {\"dtype\" : \"float32\"}.

      \n
      • \n
    • \n

      \n CPU: Compilation for CPU supports the following compiler\n options.

      \n
        \n
      • \n

        \n mcpu: CPU micro-architecture. For example, {'mcpu':\n 'skylake-avx512'}\n

        \n
        • \n
      • \n

        \n mattr: CPU flags. For example, {'mattr': ['+neon',\n '+vfpv4']}\n

        \n
        • \n
      \n
      • \n
    • \n

      \n ARM: Details of ARM CPU compilations.

      \n
        \n
      • \n

        \n NEON: NEON is an implementation of the Advanced SIMD\n extension used in ARMv7 processors.

        \n

        For example, add {'mattr': ['+neon']} to the compiler\n options if compiling for ARM 32-bit platform with the NEON\n support.

        \n
        • \n
      \n
      • \n
    • \n

      \n NVIDIA: Compilation for NVIDIA GPU supports the following\n compiler options.

      \n
        \n
      • \n

        \n gpu_code: Specifies the targeted architecture.

        \n
        • \n
      • \n

        \n trt-ver: Specifies the TensorRT versions in x.y.z.\n format.

        \n
        • \n
      • \n

        \n cuda-ver: Specifies the CUDA version in x.y\n format.

        \n
        • \n
      \n

      For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver':\n '10.1'}\n

      \n
      • \n
    • \n

      \n ANDROID: Compilation for the Android OS supports the following\n compiler options:

      \n
        \n
      • \n

        \n ANDROID_PLATFORM: Specifies the Android API levels.\n Available levels range from 21 to 29. For example,\n {'ANDROID_PLATFORM': 28}.

        \n
        • \n
      • \n

        \n mattr: Add {'mattr': ['+neon']} to compiler\n options if compiling for ARM 32-bit platform with NEON support.

        \n
        • \n
      \n
      • \n
    • \n

      \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

      \n

      For information about supported compiler options, see\n \n Neuron Compiler CLI Reference Guide.\n

      \n
      • \n
    • \n

      \n CoreML: Compilation for the CoreML OutputConfig\n TargetDevice supports the following compiler options:

      \n
        \n
      • \n

        \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
        • \n
      \n
      • \n
    • \n

      \n EIA: Compilation for the Elastic Inference Accelerator supports the following \n compiler options:

      \n
        \n
      • \n

        \n precision_mode: Specifies the precision of compiled artifacts. Supported values\n are \"FP16\" and \"FP32\". Default is\n \"FP32\".

        \n
        • \n
      • \n

        \n signature_def_key: Specifies the signature to use for models in SavedModel\n format. Defaults is TensorFlow's default signature def key.

        \n
        • \n
      • \n

        \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.

        \n
        • \n
      \n

      For example: \n {\"precision_mode\": \"FP32\", \"output_names\": [\"output:0\"]}\n

      \n
      • \n
    " } }, "KmsKeyId": { @@ -42627,7 +42862,7 @@ "InitialNumberOfUsers": { "target": "com.amazonaws.sagemaker#InitialNumberOfUsers", "traits": { - "smithy.api#documentation": "

    Specifies how many concurrent users to start with.

    " + "smithy.api#documentation": "

    Specifies how many concurrent users to start with. The value should be between 1 and 3.

    " } }, "SpawnRate": { @@ -42639,7 +42874,7 @@ "DurationInSeconds": { "target": "com.amazonaws.sagemaker#TrafficDurationInSeconds", "traits": { - "smithy.api#documentation": "

    Specifies how long traffic phase should be.

    " + "smithy.api#documentation": "

    Specifies how long a traffic phase should be. For custom load tests, the value should be between 120 and 3600.\n This value should not exceed JobDurationInSeconds.

    " } } }, @@ -43338,6 +43573,20 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.sagemaker#PredefinedMetricSpecification": { + "type": "structure", + "members": { + "PredefinedMetricType": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

    The metric type. You can only apply SageMaker metric types to SageMaker endpoints.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A specification for a predefined metric.

    " + } + }, "com.amazonaws.sagemaker#PresignedDomainUrl": { "type": "string" }, @@ -46892,7 +47141,7 @@ "JobDurationInSeconds": { "target": "com.amazonaws.sagemaker#JobDurationInSeconds", "traits": { - "smithy.api#documentation": "

    Specifies the maximum duration of the job, in seconds.>

    " + "smithy.api#documentation": "

    Specifies the maximum duration of the job, in seconds. The maximum value is 7200.

    " } }, "TrafficPattern": { @@ -47074,6 +47323,12 @@ "traits": { "smithy.api#documentation": "

    The interval of time taken by a model to respond as viewed from SageMaker. \n The interval includes the local communication time taken to send the request \n and to fetch the response from the container of a model and the time taken to \n complete the inference in the container.

    " } + }, + "FlatInvocations": { + "target": "com.amazonaws.sagemaker#FlatInvocations", + "traits": { + "smithy.api#documentation": "

    Stops a load test when the number of invocations (TPS) peaks and flattens,\n which means that the instance has reached capacity. The default value is Stop.\n If you want the load test to continue after invocations have flattened, set the value to Continue.

    " + } } }, "traits": { @@ -49075,6 +49330,9 @@ { "target": "com.amazonaws.sagemaker#GetSagemakerServicecatalogPortfolioStatus" }, + { + "target": "com.amazonaws.sagemaker#GetScalingConfigurationRecommendation" + }, { "target": "com.amazonaws.sagemaker#GetSearchSuggestions" }, @@ -49555,52 +49813,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", @@ -49608,13 +49870,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -49624,92 +49895,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://api.sagemaker-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.sagemaker-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" + ] + } ] } ], @@ -49718,180 +49980,140 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, + "aws", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] } ] } ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://api-fips.sagemaker.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws-us-gov", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://api-fips.sagemaker.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://api.sagemaker-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] + "endpoint": { + "url": "https://api-fips.sagemaker.{Region}.amazonaws.com", + "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-us-gov", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsDualStack" + "name" ] } ] } ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://api.sagemaker.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] + "endpoint": { + "url": "https://api-fips.sagemaker.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, { "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" + "endpoint": { + "url": "https://api.sagemaker-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, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://api.sagemaker.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://api.sagemaker.{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.sagemaker.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -50601,6 +50823,70 @@ } } }, + "com.amazonaws.sagemaker#ScalingPolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ScalingPolicy" + } + }, + "com.amazonaws.sagemaker#ScalingPolicy": { + "type": "union", + "members": { + "TargetTracking": { + "target": "com.amazonaws.sagemaker#TargetTrackingScalingPolicyConfiguration", + "traits": { + "smithy.api#documentation": "

    A target tracking scaling policy. Includes support for predefined or customized metrics.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    An object containing a recommended scaling policy.

    " + } + }, + "com.amazonaws.sagemaker#ScalingPolicyMetric": { + "type": "structure", + "members": { + "InvocationsPerInstance": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

    The number of invocations sent to a model, normalized by InstanceCount\n in each ProductionVariant. 1/numberOfInstances is sent as the value on each\n request, where numberOfInstances is the number of active instances for the\n ProductionVariant behind the endpoint at the time of the request.

    " + } + }, + "ModelLatency": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

    The interval of time taken by a model to respond as viewed from SageMaker.\n This interval includes the local communication times taken to send the request\n and to fetch the response from the container of a model and the time taken to\n complete the inference in the container.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The metric for a scaling policy.

    " + } + }, + "com.amazonaws.sagemaker#ScalingPolicyObjective": { + "type": "structure", + "members": { + "MinInvocationsPerMinute": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

    The minimum number of expected requests to your endpoint per minute.

    " + } + }, + "MaxInvocationsPerMinute": { + "target": "com.amazonaws.sagemaker#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

    The maximum number of expected requests to your endpoint per minute.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    An object where you specify the anticipated traffic pattern for an endpoint.

    " + } + }, "com.amazonaws.sagemaker#ScheduleConfig": { "type": "structure", "members": { @@ -52046,6 +52332,32 @@ } } }, + "com.amazonaws.sagemaker#Stairs": { + "type": "structure", + "members": { + "DurationInSeconds": { + "target": "com.amazonaws.sagemaker#TrafficDurationInSeconds", + "traits": { + "smithy.api#documentation": "

    Defines how long each traffic step should be.

    " + } + }, + "NumberOfSteps": { + "target": "com.amazonaws.sagemaker#NumberOfSteps", + "traits": { + "smithy.api#documentation": "

    Specifies how many steps to perform during traffic.

    " + } + }, + "UsersPerStep": { + "target": "com.amazonaws.sagemaker#UsersPerStep", + "traits": { + "smithy.api#documentation": "

    Specifies how many new users to spawn in each step.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Defines the stairs traffic pattern for an Inference Recommender load test. This pattern\n type consists of multiple steps where the number of users increases at each step.

    \n

    Specify either the stairs or phases traffic pattern.

    " + } + }, "com.amazonaws.sagemaker#StartEdgeDeploymentStage": { "type": "operation", "input": { @@ -52281,6 +52593,41 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#Statistic": { + "type": "enum", + "members": { + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Average" + } + }, + "MINIMUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minimum" + } + }, + "MAXIMUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maximum" + } + }, + "SAMPLE_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SampleCount" + } + }, + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Sum" + } + } + } + }, "com.amazonaws.sagemaker#StatusDetails": { "type": "string", "traits": { @@ -53697,6 +54044,27 @@ } } }, + "com.amazonaws.sagemaker#TargetTrackingScalingPolicyConfiguration": { + "type": "structure", + "members": { + "MetricSpecification": { + "target": "com.amazonaws.sagemaker#MetricSpecification", + "traits": { + "smithy.api#documentation": "

    An object containing information about a metric.

    " + } + }, + "TargetValue": { + "target": "com.amazonaws.sagemaker#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

    The recommended target value to specify for the metric when creating a scaling policy.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A target tracking scaling policy. Includes support for predefined or customized metrics.

    \n

    When using the PutScalingPolicy API,\n this parameter is required when you are creating a policy with the policy type TargetTrackingScaling.

    " + } + }, "com.amazonaws.sagemaker#TaskAvailabilityLifetimeInSeconds": { "type": "integer", "traits": { @@ -54044,7 +54412,7 @@ "TrafficType": { "target": "com.amazonaws.sagemaker#TrafficType", "traits": { - "smithy.api#documentation": "

    Defines the traffic patterns.

    " + "smithy.api#documentation": "

    Defines the traffic patterns. Choose either PHASES or STAIRS.

    " } }, "Phases": { @@ -54052,6 +54420,12 @@ "traits": { "smithy.api#documentation": "

    Defines the phases traffic specification.

    " } + }, + "Stairs": { + "target": "com.amazonaws.sagemaker#Stairs", + "traits": { + "smithy.api#documentation": "

    Defines the stairs traffic pattern.

    " + } } }, "traits": { @@ -54123,6 +54497,12 @@ "traits": { "smithy.api#enumValue": "PHASES" } + }, + "STAIRS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STAIRS" + } } } }, @@ -54563,6 +54943,12 @@ "traits": { "smithy.api#enumValue": "ml.trn1n.32xlarge" } + }, + "ML_P5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.48xlarge" + } } } }, @@ -54770,6 +55156,9 @@ "smithy.api#documentation": "

    Information about the evaluation status of the rules for the training job.

    " } }, + "ProfilerConfig": { + "target": "com.amazonaws.sagemaker#ProfilerConfig" + }, "Environment": { "target": "com.amazonaws.sagemaker#TrainingEnvironmentMap", "traits": { @@ -55587,6 +55976,9 @@ "traits": { "smithy.api#documentation": "

    A list of tags associated with the transform job.

    " } + }, + "DataCaptureConfig": { + "target": "com.amazonaws.sagemaker#BatchDataCaptureConfig" } }, "traits": { @@ -57912,9 +58304,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": {} } }, @@ -59255,6 +59647,15 @@ "smithy.api#documentation": "

    A collection of settings that apply to users of Amazon SageMaker Studio. These settings are\n specified when the CreateUserProfile API is called, and as DefaultUserSettings\n when the CreateDomain API is called.

    \n

    \n SecurityGroups is aggregated when specified in both calls. For all other\n settings in UserSettings, the values specified in CreateUserProfile\n take precedence over those specified in CreateDomain.

    " } }, + "com.amazonaws.sagemaker#UsersPerStep": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 3 + } + } + }, "com.amazonaws.sagemaker#UtilizationMetric": { "type": "float", "traits": { @@ -59263,6 +59664,15 @@ } } }, + "com.amazonaws.sagemaker#UtilizationPercentagePerCore": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.sagemaker#ValidationFraction": { "type": "float", "traits": { diff --git a/codegen/sdk/aws-models/scheduler.json b/codegen/sdk/aws-models/scheduler.json index 29d194576673..3c3775ed731e 100644 --- a/codegen/sdk/aws-models/scheduler.json +++ b/codegen/sdk/aws-models/scheduler.json @@ -395,8 +395,8 @@ } }, "params": { - "UseDualStack": true, "Region": "us-gov-east-1", + "UseDualStack": true, "UseFIPS": true } }, @@ -408,8 +408,8 @@ } }, "params": { - "UseDualStack": false, "Region": "us-gov-east-1", + "UseDualStack": false, "UseFIPS": true } }, @@ -421,8 +421,8 @@ } }, "params": { - "UseDualStack": true, "Region": "us-gov-east-1", + "UseDualStack": true, "UseFIPS": false } }, @@ -434,8 +434,8 @@ } }, "params": { - "UseDualStack": false, "Region": "us-gov-east-1", + "UseDualStack": false, "UseFIPS": false } }, @@ -447,8 +447,8 @@ } }, "params": { - "UseDualStack": true, "Region": "cn-north-1", + "UseDualStack": true, "UseFIPS": true } }, @@ -460,8 +460,8 @@ } }, "params": { - "UseDualStack": false, "Region": "cn-north-1", + "UseDualStack": false, "UseFIPS": true } }, @@ -473,8 +473,8 @@ } }, "params": { - "UseDualStack": true, "Region": "cn-north-1", + "UseDualStack": true, "UseFIPS": false } }, @@ -486,8 +486,8 @@ } }, "params": { - "UseDualStack": false, "Region": "cn-north-1", + "UseDualStack": false, "UseFIPS": false } }, @@ -497,8 +497,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "Region": "us-iso-east-1", + "UseDualStack": true, "UseFIPS": true } }, @@ -510,8 +510,8 @@ } }, "params": { - "UseDualStack": false, "Region": "us-iso-east-1", + "UseDualStack": false, "UseFIPS": true } }, @@ -521,8 +521,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "Region": "us-iso-east-1", + "UseDualStack": true, "UseFIPS": false } }, @@ -534,8 +534,8 @@ } }, "params": { - "UseDualStack": false, "Region": "us-iso-east-1", + "UseDualStack": false, "UseFIPS": false } }, @@ -547,8 +547,8 @@ } }, "params": { - "UseDualStack": true, "Region": "us-east-1", + "UseDualStack": true, "UseFIPS": true } }, @@ -560,8 +560,8 @@ } }, "params": { - "UseDualStack": false, "Region": "us-east-1", + "UseDualStack": false, "UseFIPS": true } }, @@ -573,8 +573,8 @@ } }, "params": { - "UseDualStack": true, "Region": "us-east-1", + "UseDualStack": true, "UseFIPS": false } }, @@ -586,8 +586,8 @@ } }, "params": { - "UseDualStack": false, "Region": "us-east-1", + "UseDualStack": false, "UseFIPS": false } }, @@ -597,8 +597,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "Region": "us-isob-east-1", + "UseDualStack": true, "UseFIPS": true } }, @@ -610,8 +610,8 @@ } }, "params": { - "UseDualStack": false, "Region": "us-isob-east-1", + "UseDualStack": false, "UseFIPS": true } }, @@ -621,8 +621,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "Region": "us-isob-east-1", + "UseDualStack": true, "UseFIPS": false } }, @@ -634,8 +634,8 @@ } }, "params": { - "UseDualStack": false, "Region": "us-isob-east-1", + "UseDualStack": false, "UseFIPS": false } }, @@ -647,8 +647,8 @@ } }, "params": { - "UseDualStack": false, "Region": "us-east-1", + "UseDualStack": false, "UseFIPS": false, "Endpoint": "https://example.com" } @@ -659,8 +659,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "Region": "us-east-1", + "UseDualStack": false, "UseFIPS": true, "Endpoint": "https://example.com" } @@ -671,8 +671,8 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "Region": "us-east-1", + "UseDualStack": true, "UseFIPS": false, "Endpoint": "https://example.com" } @@ -682,6 +682,21 @@ } } }, + "com.amazonaws.scheduler#ActionAfterCompletion": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "DELETE", + "name": "DELETE" + } + ] + } + }, "com.amazonaws.scheduler#AssignPublicIp": { "type": "string", "traits": { @@ -950,7 +965,7 @@ "ScheduleExpression": { "target": "com.amazonaws.scheduler#ScheduleExpression", "traits": { - "smithy.api#documentation": "

    \n The expression that defines when the schedule runs. The following formats are supported.\n

    \n
      \n
    • \n

      \n at expression - at(yyyy-mm-ddThh:mm:ss)\n

      \n
      • \n
    • \n

      \n rate expression - rate(unit value)\n

      \n
      • \n
    • \n

      \n cron expression - cron(fields)\n

      \n
      • \n
    \n

    \n You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify.\n You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target\n at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time,\n such as at 8:00 am (UTC+0) every 1st day of the month.\n

    \n

    \n A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).\n

    \n

    \n A rate expression consists of a value as a positive integer, and a unit with the following options:\n minute | minutes | hour | hours | day | days\n

    \n

    \n For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.\n

    ", + "smithy.api#documentation": "

    \n The expression that defines when the schedule runs. The following formats are supported.\n

    \n
      \n
    • \n

      \n at expression - at(yyyy-mm-ddThh:mm:ss)\n

      \n
      • \n
    • \n

      \n rate expression - rate(value unit)\n

      \n
      • \n
    • \n

      \n cron expression - cron(fields)\n

      \n
      • \n
    \n

    \n You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify.\n You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target\n at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time,\n such as at 8:00 am (UTC+0) every 1st day of the month.\n

    \n

    \n A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).\n

    \n

    \n A rate expression consists of a value as a positive integer, and a unit with the following options:\n minute | minutes | hour | hours | day | days\n

    \n

    \n For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.\n

    ", "smithy.api#required": {} } }, @@ -1010,6 +1025,12 @@ "smithy.api#documentation": "

    \n Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,\n EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency. \n

    ", "smithy.api#idempotencyToken": {} } + }, + "ActionAfterCompletion": { + "target": "com.amazonaws.scheduler#ActionAfterCompletion", + "traits": { + "smithy.api#documentation": "

    Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

    " + } } } }, @@ -1505,7 +1526,7 @@ "ScheduleExpression": { "target": "com.amazonaws.scheduler#ScheduleExpression", "traits": { - "smithy.api#documentation": "

    \n The expression that defines when the schedule runs. The following formats are supported.\n

    \n
      \n
    • \n

      \n at expression - at(yyyy-mm-ddThh:mm:ss)\n

      \n
      • \n
    • \n

      \n rate expression - rate(unit value)\n

      \n
      • \n
    • \n

      \n cron expression - cron(fields)\n

      \n
      • \n
    \n

    \n You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify.\n You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target\n at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time,\n such as at 8:00 am (UTC+0) every 1st day of the month.\n

    \n

    \n A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).\n

    \n

    \n A rate expression consists of a value as a positive integer, and a unit with the following options:\n minute | minutes | hour | hours | day | days\n

    \n

    \n For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.\n

    " + "smithy.api#documentation": "

    \n The expression that defines when the schedule runs. The following formats are supported.\n

    \n
      \n
    • \n

      \n at expression - at(yyyy-mm-ddThh:mm:ss)\n

      \n
      • \n
    • \n

      \n rate expression - rate(value unit)\n

      \n
      • \n
    • \n

      \n cron expression - cron(fields)\n

      \n
      • \n
    \n

    \n You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify.\n You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target\n at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time,\n such as at 8:00 am (UTC+0) every 1st day of the month.\n

    \n

    \n A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).\n

    \n

    \n A rate expression consists of a value as a positive integer, and a unit with the following options:\n minute | minutes | hour | hours | day | days\n

    \n

    \n For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.\n

    " } }, "StartDate": { @@ -1575,6 +1596,12 @@ "traits": { "smithy.api#documentation": "

    Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

    " } + }, + "ActionAfterCompletion": { + "target": "com.amazonaws.scheduler#ActionAfterCompletion", + "traits": { + "smithy.api#documentation": "

    Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

    " + } } } }, @@ -2978,7 +3005,7 @@ "ScheduleExpression": { "target": "com.amazonaws.scheduler#ScheduleExpression", "traits": { - "smithy.api#documentation": "

    \n The expression that defines when the schedule runs. The following formats are supported.\n

    \n
      \n
    • \n

      \n at expression - at(yyyy-mm-ddThh:mm:ss)\n

      \n
      • \n
    • \n

      \n rate expression - rate(unit value)\n

      \n
      • \n
    • \n

      \n cron expression - cron(fields)\n

      \n
      • \n
    \n

    \n You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify.\n You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target\n at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time,\n such as at 8:00 am (UTC+0) every 1st day of the month.\n

    \n

    \n A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).\n

    \n

    \n A rate expression consists of a value as a positive integer, and a unit with the following options:\n minute | minutes | hour | hours | day | days\n

    \n

    \n For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.\n

    ", + "smithy.api#documentation": "

    \n The expression that defines when the schedule runs. The following formats are supported.\n

    \n
      \n
    • \n

      \n at expression - at(yyyy-mm-ddThh:mm:ss)\n

      \n
      • \n
    • \n

      \n rate expression - rate(value unit)\n

      \n
      • \n
    • \n

      \n cron expression - cron(fields)\n

      \n
      • \n
    \n

    \n You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify.\n You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target\n at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time,\n such as at 8:00 am (UTC+0) every 1st day of the month.\n

    \n

    \n A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).\n

    \n

    \n A rate expression consists of a value as a positive integer, and a unit with the following options:\n minute | minutes | hour | hours | day | days\n

    \n

    \n For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.\n

    ", "smithy.api#required": {} } }, @@ -3038,6 +3065,12 @@ "smithy.api#documentation": "

    \n Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token,\n EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency. \n

    ", "smithy.api#idempotencyToken": {} } + }, + "ActionAfterCompletion": { + "target": "com.amazonaws.scheduler#ActionAfterCompletion", + "traits": { + "smithy.api#documentation": "

    Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

    " + } } } }, @@ -3070,4 +3103,4 @@ } } } -} +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/secrets-manager.json b/codegen/sdk/aws-models/secrets-manager.json index 49425f8230f8..724bc1b2dbe9 100644 --- a/codegen/sdk/aws-models/secrets-manager.json +++ b/codegen/sdk/aws-models/secrets-manager.json @@ -1237,6 +1237,9 @@ }, { "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" } ], "traits": { diff --git a/codegen/sdk/aws-models/service-catalog.json b/codegen/sdk/aws-models/service-catalog.json index 679cd0b60174..b8a67f2a1a60 100644 --- a/codegen/sdk/aws-models/service-catalog.json +++ b/codegen/sdk/aws-models/service-catalog.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.

    " + "smithy.api#documentation": "

    The user to which the access level applies. The only supported value is self.

    " } } }, @@ -5673,7 +5637,7 @@ } ], "traits": { - "smithy.api#documentation": "

    \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

    \n Import \n of the resource requires \n that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact.\n

    \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     \n

    \n The user or role \n that performs this operation \n must have the cloudformation:GetTemplate and cloudformation:DescribeStacks IAM policy permissions.\n

    " + "smithy.api#documentation": "

    \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

    \n Import of the resource requires that the CloudFormation stack template matches \n the associated Service Catalog product provisioning artifact.\n

    \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     \n

    \n The user or role that performs this operation must have the cloudformation:GetTemplate \n and cloudformation:DescribeStacks IAM policy permissions.\n

    \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.

    " } }, "com.amazonaws.servicecatalog#ImportAsProvisionedProductInput": { @@ -5702,7 +5666,7 @@ "ProvisionedProductName": { "target": "com.amazonaws.servicecatalog#ProvisionedProductName", "traits": { - "smithy.api#documentation": "

    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
    • \n

      \n ProvisionedProduct\n

      \n
      • \n
    • \n

      \n UpdateProvisionedProduct\n

      \n
      • \n
    • \n

      \n ExecuteProvisionedProductPlan\n

      \n
      • \n
    • \n

      \n TerminateProvisionedProduct\n

      \n
      • \n
    " + "smithy.api#documentation": "

    The record identifier of the last request performed on this provisioned product of the following types:

    \n
      \n
    • \n

      \n ProvisionProduct\n

      \n
      • \n
    • \n

      \n UpdateProvisionedProduct\n

      \n
      • \n
    • \n

      \n ExecuteProvisionedProductPlan\n

      \n
      • \n
    • \n

      \n TerminateProvisionedProduct\n

      \n
      • \n
    " } }, "LastSuccessfulProvisioningRecordId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The record identifier of the last successful request performed on this provisioned product of the following types:

    \n
      \n
    • \n

      \n ProvisionedProduct\n

      \n
      • \n
    • \n

      \n UpdateProvisionedProduct\n

      \n
      • \n
    • \n

      \n ExecuteProvisionedProductPlan\n

      \n
      • \n
    • \n

      \n TerminateProvisionedProduct\n

      \n
      • \n
    " + "smithy.api#documentation": "

    The record identifier of the last successful request performed on this provisioned product of the following types:

    \n
      \n
    • \n

      \n ProvisionProduct\n

      \n
      • \n
    • \n

      \n UpdateProvisionedProduct\n

      \n
      • \n
    • \n

      \n ExecuteProvisionedProductPlan\n

      \n
      • \n
    • \n

      \n TerminateProvisionedProduct\n

      \n
      • \n
    " } }, "Tags": { @@ -8709,13 +8679,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
    • \n

      \n ProvisionedProduct\n

      \n
      • \n
    • \n

      \n UpdateProvisionedProduct\n

      \n
      • \n
    • \n

      \n ExecuteProvisionedProductPlan\n

      \n
      • \n
    • \n

      \n TerminateProvisionedProduct\n

      \n
      • \n
    " + "smithy.api#documentation": "

    The record identifier of the last request performed on this provisioned product of the following types:

    \n
      \n
    • \n

      \n ProvisionProduct\n

      \n
      • \n
    • \n

      \n UpdateProvisionedProduct\n

      \n
      • \n
    • \n

      \n ExecuteProvisionedProductPlan\n

      \n
      • \n
    • \n

      \n TerminateProvisionedProduct\n

      \n
      • \n
    " } }, "LastSuccessfulProvisioningRecordId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "

    The record identifier of the last successful request performed on this provisioned product of the following types:

    \n
      \n
    • \n

      \n ProvisionedProduct\n

      \n
      • \n
    • \n

      \n UpdateProvisionedProduct\n

      \n
      • \n
    • \n

      \n ExecuteProvisionedProductPlan\n

      \n
      • \n
    • \n

      \n TerminateProvisionedProduct\n

      \n
      • \n
    " + "smithy.api#documentation": "

    The record identifier of the last successful request performed on this provisioned product of the following types:

    \n
      \n
    • \n

      \n ProvisionProduct\n

      \n
      • \n
    • \n

      \n UpdateProvisionedProduct\n

      \n
      • \n
    • \n

      \n ExecuteProvisionedProductPlan\n

      \n
      • \n
    • \n

      \n TerminateProvisionedProduct\n

      \n
      • \n
    " } }, "ProductId": { @@ -9135,7 +9105,7 @@ "Type": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactType", "traits": { - "smithy.api#documentation": "

    The type of provisioning artifact.

    \n
      \n
    • \n

      \n CLOUD_FORMATION_TEMPLATE - CloudFormation template

      \n
      • \n
    • \n

      \n MARKETPLACE_AMI - Amazon Web Services Marketplace AMI

      \n
      • \n
    • \n

      \n MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services Resources

      \n
      • \n
    " + "smithy.api#documentation": "

    The type of provisioning artifact.

    \n

    \n CLOUD_FORMATION_TEMPLATE - CloudFormation template

    " } }, "CreatedTime": { @@ -9357,14 +9327,14 @@ "Type": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactType", "traits": { - "smithy.api#documentation": "

    The type of provisioning artifact.

    \n
      \n
    • \n

      \n CLOUD_FORMATION_TEMPLATE - CloudFormation template

      \n
      • \n
    • \n

      \n MARKETPLACE_AMI - Amazon Web Services Marketplace AMI

      \n
      • \n
    • \n

      \n MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services Resources

      \n
      • \n
    • \n

      \n TERRAFORM_OPEN_SOURCE - Terraform open source configuration file

      \n
      • \n
    " + "smithy.api#documentation": "

    The type of provisioning artifact.

    \n
      \n
    • \n

      \n CLOUD_FORMATION_TEMPLATE - CloudFormation template

      \n
      • \n
    • \n

      \n TERRAFORM_OPEN_SOURCE - Terraform open source configuration file

      \n
      • \n
    " } }, "DisableTemplateValidation": { "target": "com.amazonaws.servicecatalog#DisableTemplateValidation", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

    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.

    \n

    Service Catalog does not support template validation for the TERRAFORM_OS product type.

    " } } }, @@ -9456,6 +9426,12 @@ "traits": { "smithy.api#enumValue": "TERRAFORM_OPEN_SOURCE" } + }, + "TERRAFORM_CLOUD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERRAFORM_CLOUD" + } } } }, @@ -9597,7 +9573,7 @@ "ProvisionedProductType": { "target": "com.amazonaws.servicecatalog#ProvisionedProductType", "traits": { - "smithy.api#documentation": "

    The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

    " + "smithy.api#documentation": "

    The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, \n TERRAFORM_OPEN_SOURCE, and TERRAFORM_CLOUD.

    " } }, "RecordType": { @@ -10520,7 +10496,7 @@ "Filters": { "target": "com.amazonaws.servicecatalog#ProvisionedProductFilters", "traits": { - "smithy.api#documentation": "

    The search filters.

    \n

    When 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.

    \n

    Example: \"SearchQuery\":[\"status:AVAILABLE\"]\n

    " + "smithy.api#documentation": "

    The search filters.

    \n

    When 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.

    \n

    Example: \"SearchQuery\":[\"status:AVAILABLE\"]\n

    " } }, "SortBy": { @@ -11721,7 +11697,7 @@ } ], "traits": { - "smithy.api#documentation": "

    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.

    \n

    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.

    \n

    You must provide the accountId or organization node in the input, but not both.

    \n

    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.

    \n

    This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare API for that action.

    \n \n

    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.

    \n     " + "smithy.api#documentation": "

    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.

    \n

    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.

    \n

    You must provide the accountId or organization node in the input, but not both.

    \n

    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.

    \n

    This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare API for that action.

    \n \n

    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.

    \n     " } }, "com.amazonaws.servicecatalog#UpdatePortfolioShareInput": { diff --git a/codegen/sdk/aws-models/sqs.json b/codegen/sdk/aws-models/sqs.json index 364285b06e3b..233b0853b67c 100644 --- a/codegen/sdk/aws-models/sqs.json +++ b/codegen/sdk/aws-models/sqs.json @@ -1344,7 +1344,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Cancels a specified message movement task.

    \n \n
      \n
    • \n

      A message movement can only be cancelled when the current status is\n RUNNING.

      \n
      • \n
    • \n

      Cancelling a message movement task does not revert the messages that have\n already been moved. It can only stop the messages that have not been moved\n yet.

      \n
      • \n
    \n     " + "smithy.api#documentation": "

    Cancels a specified message movement task. A message movement can only be cancelled\n when the current status is RUNNING. Cancelling a message movement task does not revert\n the messages that have already been moved. It can only stop the messages that have not\n been moved yet.

    \n \n
      \n
    • \n

      This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue.

      \n
      • \n
    • \n

      Currently, only standard queues are supported.

      \n
      • \n
    • \n

      Only one active message movement task is supported per queue at any given\n time.

      \n
      • \n
    \n     " } }, "com.amazonaws.sqs#CancelMessageMoveTaskRequest": { @@ -2086,7 +2086,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Gets the most recent message movement tasks (up to 10) under a specific source\n queue.

    " + "smithy.api#documentation": "

    Gets the most recent message movement tasks (up to 10) under a specific source\n queue.

    \n \n
      \n
    • \n

      This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue.

      \n
      • \n
    • \n

      Currently, only standard queues are supported.

      \n
      • \n
    • \n

      Only one active message movement task is supported per queue at any given\n time.

      \n
      • \n
    \n     " } }, "com.amazonaws.sqs#ListMessageMoveTasksRequest": { @@ -2299,7 +2299,7 @@ "QueueUrls": { "target": "com.amazonaws.sqs#QueueUrlList", "traits": { - "smithy.api#documentation": "

    A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in\n the request.

    ", + "smithy.api#documentation": "

    A list of queue URLs, up to 1,000 entries, or the value of MaxResults\n that you sent in the request.

    ", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "QueueUrl" } @@ -2629,7 +2629,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes the messages in a queue specified by the QueueURL\n parameter.

    \n \n

    When you use the PurgeQueue action, you can't retrieve any messages\n deleted from a queue.

    \n

    The message deletion process takes up to 60 seconds. We recommend waiting for 60\n seconds regardless of your queue's size.

    \n     \n

    Messages sent to the queue before you call\n PurgeQueue might be received but are deleted within the next\n minute.

    \n

    Messages sent to the queue after you call PurgeQueue\n might be deleted while the queue is being purged.

    " + "smithy.api#documentation": "

    Deletes available messages in a queue (including in-flight messages) specified by the\n QueueURL parameter.

    \n \n

    When you use the PurgeQueue action, you can't retrieve any messages\n deleted from a queue.

    \n

    The message deletion process takes up to 60 seconds. We recommend waiting for 60\n seconds regardless of your queue's size.

    \n     \n

    Messages sent to the queue before you call\n PurgeQueue might be received but are deleted within the next\n minute.

    \n

    Messages sent to the queue after you call PurgeQueue\n might be deleted while the queue is being purged.

    " } }, "com.amazonaws.sqs#PurgeQueueInProgress": { @@ -3383,7 +3383,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Starts an asynchronous task to move messages from a specified source queue to a\n specified destination queue.

    \n \n
      \n
    • \n

      This action is currently limited to supporting message redrive from\n dead-letter queues (DLQs) only. In this context, the source queue is the\n dead-letter queue (DLQ), while the destination queue can be the original\n source queue (from which the messages were driven to the dead-letter-queue),\n or a custom destination queue.

      \n
      • \n
    • \n

      Currently, only standard queues are supported.

      \n
      • \n
    • \n

      Only one active message movement task is supported per queue at any given\n time.

      \n
      • \n
    \n     " + "smithy.api#documentation": "

    Starts an asynchronous task to move messages from a specified source queue to a\n specified destination queue.

    \n \n
      \n
    • \n

      This action is currently limited to supporting message redrive from queues\n that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS\n queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are\n currently not supported.

      \n
      • \n
    • \n

      In dead-letter queues redrive context, the\n StartMessageMoveTask the source queue is the DLQ, while the\n destination queue can be the original source queue (from which the messages\n were driven to the dead-letter-queue), or a custom destination queue.

      \n
      • \n
    • \n

      Currently, only standard queues support redrive. FIFO queues don't support\n redrive.

      \n
      • \n
    • \n

      Only one active message movement task is supported per queue at any given\n time.

      \n
      • \n
    \n     " } }, "com.amazonaws.sqs#StartMessageMoveTaskRequest": { @@ -3392,7 +3392,7 @@ "SourceArn": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

    The ARN of the queue that contains the messages to be moved to another queue.\n Currently, only dead-letter queue (DLQ) ARNs are accepted.

    ", + "smithy.api#documentation": "

    The ARN of the queue that contains the messages to be moved to another queue.\n Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues\n are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are\n not currently supported.

    ", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/transfer.json b/codegen/sdk/aws-models/transfer.json index 1ae42f12bb57..781f18389382 100644 --- a/codegen/sdk/aws-models/transfer.json +++ b/codegen/sdk/aws-models/transfer.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.

    \n

    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.

    ", + "smithy.api#documentation": "

    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

    \n

    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.

    \n

    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

    \n For SFTP connectors\n

    \n

    Make 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.

    ", "smithy.api#required": {} } }, @@ -642,7 +642,7 @@ } ], "traits": { - "smithy.api#documentation": "

    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.

    \n \n

    You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).

    \n     " + "smithy.api#documentation": "

    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.

    \n \n

    You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).

    \n     " } }, "com.amazonaws.transfer#CreateConnectorRequest": { @@ -664,7 +664,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.

    \n

    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.

    ", + "smithy.api#documentation": "

    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

    \n

    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.

    \n

    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

    \n For SFTP connectors\n

    \n

    Make 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.

    ", "smithy.api#required": {} } }, @@ -2561,7 +2561,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.

    \n

    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.

    " + "smithy.api#documentation": "

    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

    \n

    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.

    \n

    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

    \n For SFTP connectors\n

    \n

    Make 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.

    " } }, "Tags": { @@ -2699,7 +2699,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.

    \n

    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.

    " + "smithy.api#documentation": "

    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

    \n

    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.

    \n

    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

    \n For SFTP connectors\n

    \n

    Make 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.

    " } }, "LoggingRole": { @@ -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.

    \n
      \n
    • \n

      For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files\n you want to transfer.

      \n
      • \n
    • \n

      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:

      \n
        \n
      • \n

        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.

        \n
        • \n
      • \n

        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.

        \n
        • \n
      \n
      • \n
    " + "smithy.api#documentation": "

    Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.

    \n
      \n
    • \n

      For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files\n you want to transfer.

      \n
      • \n
    • \n

      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:

      \n
        \n
      • \n

        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.

        \n
        • \n
      • \n

        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.

        \n
        • \n
      \n
      • \n
    " } }, "com.amazonaws.transfer#StartFileTransferRequest": { @@ -6574,7 +6574,7 @@ "SendFilePaths": { "target": "com.amazonaws.transfer#FilePaths", "traits": { - "smithy.api#documentation": "

    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 .

    " + "smithy.api#documentation": "

    One or more source paths for the Transfer Family server. Each string represents a source\n file path for one outbound file transfer. For example,\n \n DOC-EXAMPLE-BUCKET/myfile.txt\n .

    \n \n

    Replace \n DOC-EXAMPLE-BUCKET\n with one of your actual buckets.

    \n     " } }, "RetrieveFilePaths": { @@ -7397,52 +7397,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", @@ -7450,13 +7454,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -7466,224 +7479,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://transfer-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://transfer-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://transfer-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://transfer-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://transfer.{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://transfer.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://transfer.{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://transfer.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -8593,7 +8557,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.

    \n

    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.

    " + "smithy.api#documentation": "

    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

    \n

    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.

    \n

    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

    \n For SFTP connectors\n

    \n

    Make 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.

    " } } }, @@ -8750,7 +8714,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.

    \n

    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.

    " + "smithy.api#documentation": "

    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

    \n

    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.

    \n

    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

    \n For SFTP connectors\n

    \n

    Make 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.

    " } }, "LoggingRole": { diff --git a/gradle.properties b/gradle.properties index a7216c1fd366..10867f76a1a3 100644 --- a/gradle.properties +++ b/gradle.properties @@ -12,7 +12,7 @@ sdkVersion=0.30.0-SNAPSHOT smithyVersion=1.29.0 smithyGradleVersion=0.6.0 # smithy-kotlin codegen and runtime are versioned together -smithyKotlinVersion=0.25.0-SNAPSHOT +smithyKotlinVersion=0.25.0 # kotlin kotlinVersion=1.8.22