diff --git a/.changes/d3a9b18c-7f36-4718-a855-91e3ac6f6531.json b/.changes/d3a9b18c-7f36-4718-a855-91e3ac6f6531.json new file mode 100644 index 00000000000..550326d26cf --- /dev/null +++ b/.changes/d3a9b18c-7f36-4718-a855-91e3ac6f6531.json @@ -0,0 +1,8 @@ +{ + "id": "d3a9b18c-7f36-4718-a855-91e3ac6f6531", + "type": "bugfix", + "description": "Only enable aws-chunked content encoding for S3", + "issues": [ + "https://github.com/awslabs/aws-sdk-kotlin/issues/1217" + ] +} \ No newline at end of file diff --git a/.github/scripts/run-codebuild-batch-job.sh b/.github/scripts/run-codebuild-batch-job.sh index 5cdb5de41d0..357427a6a4a 100755 --- a/.github/scripts/run-codebuild-batch-job.sh +++ b/.github/scripts/run-codebuild-batch-job.sh @@ -5,11 +5,52 @@ error_exit() { exit 1 } -PROJECT_NAME=$1 +PROJECT_NAME=gh-aws-sdk-kotlin-svc-check-batch # get the source version to be built (defaults to main branch if not specified) -SOURCE_VERSION=${2:-main} -SDK_PR=$3 -SMITHY_PR=$4 +SOURCE_VERSION=main +SDK_PR="" +SMITHY_PR="" + +while [[ $# -gt 0 ]]; do + case "$1" in + --project) + if [[ "$2" == --* ]]; then + shift 1 + else + PROJECT_NAME="$2" + shift 2 + fi + ;; + --source) + if [[ "$2" == --* ]]; then + shift 1 + else + SOURCE_VERSION="$2" + shift 2 + fi + ;; + --sdk-pr) + if [[ "$2" == --* ]]; then + shift 1 + else + SDK_PR="$2" + shift 2 + fi + ;; + --smithy-pr) + if [[ "$2" == --* || -z "$2" ]]; then + shift 1 + else + SMITHY_PR="$2" + shift 2 + fi + ;; + *) + echo "Unknown option: $1" + exit 1 + ;; + esac +done export SDK_PR export SMITHY_PR diff --git a/.github/workflows/codebuild-ci.yml b/.github/workflows/codebuild-ci.yml index b1bee2e63a9..201399c6568 100644 --- a/.github/workflows/codebuild-ci.yml +++ b/.github/workflows/codebuild-ci.yml @@ -82,8 +82,10 @@ jobs: id: svc-check-batch run: | .github/scripts/run-codebuild-batch-job.sh \ - gh-aws-sdk-kotlin-svc-check-batch \ - ${{ github.event.pull_request.head.sha }} ${{ inputs.aws-sdk-kotlin-pr }} ${{ inputs.smithy-kotlin-pr }} + --project gh-aws-sdk-kotlin-svc-check-batch \ + --source ${{ github.event.pull_request.head.sha }} \ + --sdk-pr ${{ inputs.aws-sdk-kotlin-pr }} \ + --smithy-pr ${{ inputs.smithy-kotlin-pr }} - name: Cancel build if: ${{ cancelled() }} env: diff --git a/CHANGELOG.md b/CHANGELOG.md index a86d730c67b..9a420eac155 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,26 @@ # Changelog +## [1.0.61] - 02/20/2024 + +### Features +* (**firehose**) This release updates a few Firehose related APIs. +* (**lambda**) Add .NET 8 (dotnet8) Runtime support to AWS Lambda. + +### Documentation +* (**dynamodb**) Publishing quick fix for doc only update. + +## [1.0.60] - 02/19/2024 + +### Features +* (**amplify**) This release contains API changes that enable users to configure their Amplify domains with their own custom SSL/TLS certificate. +* (**chatbot**) This release adds support for AWS Chatbot. You can now monitor, operate, and troubleshoot your AWS resources with interactive ChatOps using the AWS SDK. +* (**mediatailor**) MediaTailor: marking #AdBreak.OffsetMillis as required. + +### Documentation +* (**configservice**) Documentation updates for the AWS Config CLI +* (**ivs**) Changed description for latencyMode in Create/UpdateChannel and Channel/ChannelSummary. +* (**keyspaces**) Documentation updates for Amazon Keyspaces + ## [1.0.59] - 02/16/2024 ### Features diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/s3/ClientConfigIntegration.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/s3/ClientConfigIntegration.kt index d5a99cd9c54..cb2f8edb9ba 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/s3/ClientConfigIntegration.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/s3/ClientConfigIntegration.kt @@ -63,6 +63,12 @@ class ClientConfigIntegration : KotlinIntegration { """.trimIndent() } + val EnableAwsChunked: ConfigProperty = ConfigProperty { + name = "enableAwsChunked" + useSymbolWithNullableBuilder(KotlinTypes.Boolean, "true") + documentation = "Flag to enable [aws-chunked](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-streaming.html) content encoding." + } + val DisableExpressSessionAuth: ConfigProperty = ConfigProperty { name = "disableS3ExpressSessionAuth" useSymbolWithNullableBuilder(KotlinTypes.Boolean, "false") @@ -117,6 +123,7 @@ class ClientConfigIntegration : KotlinIntegration { ForcePathStyleProp, UseArnRegionProp, DisableMrapProp, + EnableAwsChunked, DisableExpressSessionAuth, ExpressCredentialsProvider, ) diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/s3/S3SigningConfig.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/s3/S3SigningConfig.kt index 982aff4a85c..e3fb4b45e08 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/s3/S3SigningConfig.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/s3/S3SigningConfig.kt @@ -20,7 +20,6 @@ import software.amazon.smithy.model.shapes.ServiceShape * Set default signing attributes in the execution context (which ultimately becomes the signing context) for S3. */ class S3SigningConfig : KotlinIntegration { - // auth schemes are de-duped by taking the last one registered override val order: Byte get() = 127 @@ -40,5 +39,6 @@ class S3SigningConfig : KotlinIntegration { writer.putIfAbsent(signingAttrs, "NormalizeUriPath", "false") writer.putIfAbsent(signingAttrs, "UseDoubleUriEncode", "false") writer.putIfAbsent(signingAttrs, "SignedBodyHeader", writer.format("#T.X_AMZ_CONTENT_SHA256", RuntimeTypes.Auth.Signing.AwsSigningCommon.AwsSignedBodyHeader)) + writer.putIfAbsent(signingAttrs, "EnableAwsChunked", "config.enableAwsChunked") } } diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/s3control/ClientConfigIntegration.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/s3control/ClientConfigIntegration.kt index 26c5c4151cd..3796f877672 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/s3control/ClientConfigIntegration.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/s3control/ClientConfigIntegration.kt @@ -8,6 +8,7 @@ import aws.sdk.kotlin.codegen.customization.s3.isS3Control import software.amazon.smithy.kotlin.codegen.KotlinSettings import software.amazon.smithy.kotlin.codegen.core.CodegenContext import software.amazon.smithy.kotlin.codegen.integration.KotlinIntegration +import software.amazon.smithy.kotlin.codegen.lang.KotlinTypes import software.amazon.smithy.kotlin.codegen.model.expectShape import software.amazon.smithy.kotlin.codegen.rendering.util.ConfigProperty import software.amazon.smithy.model.Model @@ -32,6 +33,12 @@ class ClientConfigIntegration : KotlinIntegration { [S3 access points](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html). """.trimIndent(), ) + + val EnableAwsChunked: ConfigProperty = ConfigProperty { + name = "enableAwsChunked" + useSymbolWithNullableBuilder(KotlinTypes.Boolean, "true") + documentation = "Flag to enable [aws-chunked](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-streaming.html) content encoding." + } } override fun preprocessModel(model: Model, settings: KotlinSettings): Model { @@ -51,5 +58,6 @@ class ClientConfigIntegration : KotlinIntegration { override fun additionalServiceConfigProps(ctx: CodegenContext): List = listOf( UseArnRegionProp, + EnableAwsChunked, ) } diff --git a/codegen/sdk/aws-models/amplify.json b/codegen/sdk/aws-models/amplify.json index e55f1081af1..77c531f7d60 100644 --- a/codegen/sdk/aws-models/amplify.json +++ b/codegen/sdk/aws-models/amplify.json @@ -177,7 +177,7 @@ "name": "amplify" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amplify enables developers to develop and deploy cloud-powered mobile and web apps.\n The Amplify Console provides a continuous delivery and hosting service for web\n applications. For more information, see the Amplify Console User Guide. The\n Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation\n for client app development. For more information, see the Amplify Framework.\n

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

Amplify enables developers to develop and deploy cloud-powered mobile and web apps.\n Amplify Hosting provides a continuous delivery and hosting service for web applications.\n For more information, see the Amplify Hosting User Guide. The\n Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation\n for client app development. For more information, see the Amplify Framework.\n

", "smithy.api#title": "AWS Amplify", "smithy.api#xmlNamespace": { "uri": "http://amplify.amazonaws.com" @@ -1052,127 +1052,127 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID of the Amplify app.

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

The unique ID of the Amplify app.

", "smithy.api#required": {} } }, "appArn": { "target": "com.amazonaws.amplify#AppArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amplify app.

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

The Amazon Resource Name (ARN) of the Amplify app.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.amplify#Name", "traits": { - "smithy.api#documentation": "

The name for the Amplify app.

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

The name for the Amplify app.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amplify#TagMap", "traits": { - "smithy.api#documentation": "

The tag for the Amplify app.

" + "smithy.api#documentation": "

The tag for the Amplify app.

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

The description for the Amplify app.

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

The description for the Amplify app.

", "smithy.api#required": {} } }, "repository": { "target": "com.amazonaws.amplify#Repository", "traits": { - "smithy.api#documentation": "

The Git repository for the Amplify app.

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

The Git repository for the Amplify app.

", "smithy.api#required": {} } }, "platform": { "target": "com.amazonaws.amplify#Platform", "traits": { - "smithy.api#documentation": "

The platform for the Amplify app. For a static app, set the platform type to WEB.\n For a dynamic server-side rendered (SSR) app, set the platform type to\n WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to\n WEB_DYNAMIC.

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

The platform for the Amplify app. For a static app, set the platform type to\n WEB. For a dynamic server-side rendered (SSR) app, set the platform\n type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR\n support only, set the platform type to WEB_DYNAMIC.

", "smithy.api#required": {} } }, "createTime": { "target": "com.amazonaws.amplify#CreateTime", "traits": { - "smithy.api#documentation": "

Creates a date and time for the Amplify app.

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

Creates a date and time for the Amplify app.

", "smithy.api#required": {} } }, "updateTime": { "target": "com.amazonaws.amplify#UpdateTime", "traits": { - "smithy.api#documentation": "

Updates the date and time for the Amplify app.

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

Updates the date and time for the Amplify app.

", "smithy.api#required": {} } }, "iamServiceRoleArn": { "target": "com.amazonaws.amplify#ServiceRoleArn", "traits": { - "smithy.api#documentation": "

The AWS Identity and Access Management (IAM) service role for the Amazon Resource\n Name (ARN) of the Amplify app.

" + "smithy.api#documentation": "

The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name\n (ARN) of the Amplify app.

" } }, "environmentVariables": { "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { - "smithy.api#documentation": "

The environment variables for the Amplify app.

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

The environment variables for the Amplify app.

\n

For a list of the environment variables that are accessible to Amplify by default, see\n Amplify\n Environment variables in the Amplify Hosting User\n Guide.

", "smithy.api#required": {} } }, "defaultDomain": { "target": "com.amazonaws.amplify#DefaultDomain", "traits": { - "smithy.api#documentation": "

The default domain for the Amplify app.

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

The default domain for the Amplify app.

", "smithy.api#required": {} } }, "enableBranchAutoBuild": { "target": "com.amazonaws.amplify#EnableBranchAutoBuild", "traits": { - "smithy.api#documentation": "

Enables the auto-building of branches for the Amplify app.

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

Enables the auto-building of branches for the Amplify app.

", "smithy.api#required": {} } }, "enableBranchAutoDeletion": { "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", "traits": { - "smithy.api#documentation": "

Automatically disconnect a branch in the Amplify Console when you delete a branch\n from your Git repository.

" + "smithy.api#documentation": "

Automatically disconnect a branch in the Amplify console when you delete a branch from\n your Git repository.

" } }, "enableBasicAuth": { "target": "com.amazonaws.amplify#EnableBasicAuth", "traits": { - "smithy.api#documentation": "

Enables basic authorization for the Amplify app's branches.

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

Enables basic authorization for the Amplify app's branches.

", "smithy.api#required": {} } }, "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

The basic authorization credentials for branches for the Amplify app. You must\n base64-encode the authorization credentials and provide them in the format\n user:password.

" + "smithy.api#documentation": "

The basic authorization credentials for branches for the Amplify app. You must\n base64-encode the authorization credentials and provide them in the format\n user:password.

" } }, "customRules": { "target": "com.amazonaws.amplify#CustomRules", "traits": { - "smithy.api#documentation": "

Describes the custom redirect and rewrite rules for the Amplify app.

" + "smithy.api#documentation": "

Describes the custom redirect and rewrite rules for the Amplify app.

" } }, "productionBranch": { "target": "com.amazonaws.amplify#ProductionBranch", "traits": { - "smithy.api#documentation": "

Describes the information about a production branch of the Amplify app.

" + "smithy.api#documentation": "

Describes the information about a production branch of the Amplify app.

" } }, "buildSpec": { "target": "com.amazonaws.amplify#BuildSpec", "traits": { - "smithy.api#documentation": "

Describes the content of the build specification (build spec) for the Amplify app.\n

" + "smithy.api#documentation": "

Describes the content of the build specification (build spec) for the Amplify app.\n

" } }, "customHeaders": { @@ -1184,30 +1184,30 @@ "enableAutoBranchCreation": { "target": "com.amazonaws.amplify#EnableAutoBranchCreation", "traits": { - "smithy.api#documentation": "

Enables automated branch creation for the Amplify app.

" + "smithy.api#documentation": "

Enables automated branch creation for the Amplify app.

" } }, "autoBranchCreationPatterns": { "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", "traits": { - "smithy.api#documentation": "

Describes the automated branch creation glob patterns for the Amplify app.

" + "smithy.api#documentation": "

Describes the automated branch creation glob patterns for the Amplify app.

" } }, "autoBranchCreationConfig": { "target": "com.amazonaws.amplify#AutoBranchCreationConfig", "traits": { - "smithy.api#documentation": "

Describes the automated branch creation configuration for the Amplify app.

" + "smithy.api#documentation": "

Describes the automated branch creation configuration for the Amplify app.

" } }, "repositoryCloneMethod": { "target": "com.amazonaws.amplify#RepositoryCloneMethod", "traits": { - "smithy.api#documentation": "\n

This is for internal use.

\n \n

The Amplify service uses this parameter to specify the authentication protocol to use to access\n the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub\n repository, SIGV4 for an Amazon Web Services CodeCommit repository, and\n SSH for GitLab and Bitbucket repositories.

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

This is for internal use.

\n \n

The Amplify service uses this parameter to specify the authentication protocol to use\n to access the Git repository for an Amplify app. Amplify specifies TOKEN\n for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit\n repository, and SSH for GitLab and Bitbucket repositories.

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

Represents the different branches of a repository for building, deploying, and\n hosting an Amplify app.

" + "smithy.api#documentation": "

Represents the different branches of a repository for building, deploying, and hosting\n an Amplify app.

" } }, "com.amazonaws.amplify#AppArn": { @@ -1241,20 +1241,20 @@ "artifactFileName": { "target": "com.amazonaws.amplify#ArtifactFileName", "traits": { - "smithy.api#documentation": "

The file name for the artifact.

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

The file name for the artifact.

", "smithy.api#required": {} } }, "artifactId": { "target": "com.amazonaws.amplify#ArtifactId", "traits": { - "smithy.api#documentation": "

The unique ID for the artifact.

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

The unique ID for the artifact.

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

Describes an artifact.

" + "smithy.api#documentation": "

Describes an artifact.

" } }, "com.amazonaws.amplify#ArtifactFileName": { @@ -1321,37 +1321,37 @@ "stage": { "target": "com.amazonaws.amplify#Stage", "traits": { - "smithy.api#documentation": "

Describes the current stage for the autocreated branch.

" + "smithy.api#documentation": "

Describes the current stage for the autocreated branch.

" } }, "framework": { "target": "com.amazonaws.amplify#Framework", "traits": { - "smithy.api#documentation": "

The framework for the autocreated branch.

" + "smithy.api#documentation": "

The framework for the autocreated branch.

" } }, "enableAutoBuild": { "target": "com.amazonaws.amplify#EnableAutoBuild", "traits": { - "smithy.api#documentation": "

Enables auto building for the autocreated branch.

" + "smithy.api#documentation": "

Enables auto building for the autocreated branch.

" } }, "environmentVariables": { "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { - "smithy.api#documentation": "

The environment variables for the autocreated branch.

" + "smithy.api#documentation": "

The environment variables for the autocreated branch.

" } }, "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

The basic authorization credentials for the autocreated branch. You must\n base64-encode the authorization credentials and provide them in the format\n user:password.

" + "smithy.api#documentation": "

The basic authorization credentials for the autocreated branch. You must base64-encode\n the authorization credentials and provide them in the format\n user:password.

" } }, "enableBasicAuth": { "target": "com.amazonaws.amplify#EnableBasicAuth", "traits": { - "smithy.api#documentation": "

Enables basic authorization for the autocreated branch.

" + "smithy.api#documentation": "

Enables basic authorization for the autocreated branch.

" } }, "enablePerformanceMode": { @@ -1363,24 +1363,24 @@ "buildSpec": { "target": "com.amazonaws.amplify#BuildSpec", "traits": { - "smithy.api#documentation": "

The build specification (build spec) for the autocreated branch.

" + "smithy.api#documentation": "

The build specification (build spec) for the autocreated branch.

" } }, "enablePullRequestPreview": { "target": "com.amazonaws.amplify#EnablePullRequestPreview", "traits": { - "smithy.api#documentation": "

Enables pull request previews for the autocreated branch.

" + "smithy.api#documentation": "

Enables pull request previews for the autocreated branch.

" } }, "pullRequestEnvironmentName": { "target": "com.amazonaws.amplify#PullRequestEnvironmentName", "traits": { - "smithy.api#documentation": "

The Amplify environment name for the pull request.

" + "smithy.api#documentation": "

The Amplify environment name for the pull request.

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

Describes the automated branch creation configuration.

" + "smithy.api#documentation": "

Describes the automated branch creation configuration.

" } }, "com.amazonaws.amplify#AutoBranchCreationPattern": { @@ -1425,52 +1425,66 @@ "smithy.api#pattern": "^$|^arn:aws:iam::\\d{12}:role.+$" } }, + "com.amazonaws.amplify#Backend": { + "type": "structure", + "members": { + "stackArn": { + "target": "com.amazonaws.amplify#StackArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the CloudFormation stack.

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

Describes the backend properties associated with an Amplify\n Branch.

" + } + }, "com.amazonaws.amplify#BackendEnvironment": { "type": "structure", "members": { "backendEnvironmentArn": { "target": "com.amazonaws.amplify#BackendEnvironmentArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

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

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

", "smithy.api#required": {} } }, "environmentName": { "target": "com.amazonaws.amplify#EnvironmentName", "traits": { - "smithy.api#documentation": "

The name for a backend environment that is part of an Amplify app.

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

The name for a backend environment that is part of an Amplify app.

", "smithy.api#required": {} } }, "stackName": { "target": "com.amazonaws.amplify#StackName", "traits": { - "smithy.api#documentation": "

The AWS CloudFormation stack name of a backend environment.

" + "smithy.api#documentation": "

The AWS CloudFormation stack name of a backend environment.

" } }, "deploymentArtifacts": { "target": "com.amazonaws.amplify#DeploymentArtifacts", "traits": { - "smithy.api#documentation": "

The name of deployment artifacts.

" + "smithy.api#documentation": "

The name of deployment artifacts.

" } }, "createTime": { "target": "com.amazonaws.amplify#CreateTime", "traits": { - "smithy.api#documentation": "

The creation date and time for a backend environment that is part of an Amplify app.\n

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

The creation date and time for a backend environment that is part of an Amplify app.\n

", "smithy.api#required": {} } }, "updateTime": { "target": "com.amazonaws.amplify#UpdateTime", "traits": { - "smithy.api#documentation": "

The last updated date and time for a backend environment that is part of an Amplify\n app.

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

The last updated date and time for a backend environment that is part of an Amplify\n app.

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

Describes the backend environment for an Amplify app.

" + "smithy.api#documentation": "

Describes the backend environment for an Amplify app.

" } }, "com.amazonaws.amplify#BackendEnvironmentArn": { @@ -1497,7 +1511,7 @@ } }, "traits": { - "smithy.api#documentation": "

A request contains unexpected data.

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

A request contains unexpected data.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1694,6 +1708,9 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

" } + }, + "backend": { + "target": "com.amazonaws.amplify#Backend" } }, "traits": { @@ -1735,7 +1752,7 @@ "com.amazonaws.amplify#BuildSpec": { "type": "string", "traits": { - "smithy.api#documentation": "

The build specification (build spec) file for an Amplify app build.

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

The build specification (build spec) file for an Amplify app build.

", "smithy.api#length": { "min": 1, "max": 25000 @@ -1744,6 +1761,81 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.amplify#Certificate": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.amplify#CertificateType", + "traits": { + "smithy.api#documentation": "

The type of SSL/TLS certificate that you want to use.

\n

Specify AMPLIFY_MANAGED to use the default certificate that Amplify\n provisions for you.

\n

Specify CUSTOM to use your own certificate that you have already added to\n Certificate Manager in your Amazon Web Services account. Make sure you request (or\n import) the certificate in the US East (N. Virginia) Region (us-east-1). For more\n information about using ACM, see Importing certificates into\n Certificate Manager in the ACM User\n guide .

", + "smithy.api#required": {} + } + }, + "customCertificateArn": { + "target": "com.amazonaws.amplify#CertificateArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) for a custom certificate that you have already added to\n Certificate Manager in your Amazon Web Services account.

\n

This field is required only when the certificate type is CUSTOM.

" + } + }, + "certificateVerificationDNSRecord": { + "target": "com.amazonaws.amplify#CertificateVerificationDNSRecord", + "traits": { + "smithy.api#documentation": "

The DNS record for certificate verification.

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

Describes the current SSL/TLS certificate that is in use for the domain. If you are\n using CreateDomainAssociation to create a new domain association,\n Certificate describes the new certificate that you are creating.

" + } + }, + "com.amazonaws.amplify#CertificateArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "^arn:aws:acm:[a-z0-9-]+:\\d{12}:certificate\\/.+$" + } + }, + "com.amazonaws.amplify#CertificateSettings": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.amplify#CertificateType", + "traits": { + "smithy.api#documentation": "

The certificate type.

\n

Specify AMPLIFY_MANAGED to use the default certificate that Amplify\n provisions for you.

\n

Specify CUSTOM to use your own certificate that you have already added to\n Certificate Manager in your Amazon Web Services account. Make sure you request (or\n import) the certificate in the US East (N. Virginia) Region (us-east-1). For more\n information about using ACM, see Importing certificates into\n Certificate Manager in the ACM User\n guide.

", + "smithy.api#required": {} + } + }, + "customCertificateArn": { + "target": "com.amazonaws.amplify#CertificateArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) for the custom certificate that you have already added\n to Certificate Manager in your Amazon Web Services account.

\n

This field is required only when the certificate type is CUSTOM.

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

The type of SSL/TLS certificate to use for your custom domain. If a certificate type\n isn't specified, Amplify uses the default AMPLIFY_MANAGED\n certificate.

" + } + }, + "com.amazonaws.amplify#CertificateType": { + "type": "enum", + "members": { + "AMPLIFY_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMPLIFY_MANAGED" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, "com.amazonaws.amplify#CertificateVerificationDNSRecord": { "type": "string", "traits": { @@ -1818,7 +1910,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amplify app.

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

Creates a new Amplify app.

", "smithy.api#http": { "method": "POST", "uri": "/apps", @@ -1832,92 +1924,92 @@ "name": { "target": "com.amazonaws.amplify#Name", "traits": { - "smithy.api#documentation": "

The name for an Amplify app.

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

The name of the Amplify app.

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

The description for an Amplify app.

" + "smithy.api#documentation": "

The description of the Amplify app.

" } }, "repository": { "target": "com.amazonaws.amplify#Repository", "traits": { - "smithy.api#documentation": "

The repository for an Amplify app.

" + "smithy.api#documentation": "

The Git repository for the Amplify app.

" } }, "platform": { "target": "com.amazonaws.amplify#Platform", "traits": { - "smithy.api#documentation": "

The platform for the Amplify app. For a static app, set the platform type to WEB.\n For a dynamic server-side rendered (SSR) app, set the platform type to\n WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to\n WEB_DYNAMIC.

" + "smithy.api#documentation": "

The platform for the Amplify app. For a static app, set the platform type to\n WEB. For a dynamic server-side rendered (SSR) app, set the platform\n type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR\n support only, set the platform type to WEB_DYNAMIC.

" } }, "iamServiceRoleArn": { "target": "com.amazonaws.amplify#ServiceRoleArn", "traits": { - "smithy.api#documentation": "

The AWS Identity and Access Management (IAM) service role for an Amplify app.

" + "smithy.api#documentation": "

The AWS Identity and Access Management (IAM) service role for an Amplify app.

" } }, "oauthToken": { "target": "com.amazonaws.amplify#OauthToken", "traits": { - "smithy.api#documentation": "

The OAuth token for a third-party source control system for an Amplify app. The OAuth\n token is used to create a webhook and a read-only deploy key using SSH cloning. The\n OAuth token is not stored.

\n

Use oauthToken for repository providers other than GitHub, such as\n Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use\n accessToken.

\n

You must specify either oauthToken or accessToken when you\n create a new app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

" + "smithy.api#documentation": "

The OAuth token for a third-party source control system for an Amplify app. The OAuth\n token is used to create a webhook and a read-only deploy key using SSH cloning. The\n OAuth token is not stored.

\n

Use oauthToken for repository providers other than GitHub, such as\n Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use\n accessToken.

\n

You must specify either oauthToken or accessToken when you\n create a new app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

" } }, "accessToken": { "target": "com.amazonaws.amplify#AccessToken", "traits": { - "smithy.api#documentation": "

The personal access token for a GitHub repository for an Amplify app. The personal\n access token is used to authorize access to a GitHub repository using the Amplify GitHub\n App. The token is not stored.

\n

Use accessToken for GitHub repositories only. To authorize access to a\n repository provider such as Bitbucket or CodeCommit, use oauthToken.

\n

You must specify either accessToken or oauthToken when you\n create a new app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

" + "smithy.api#documentation": "

The personal access token for a GitHub repository for an Amplify app. The personal\n access token is used to authorize access to a GitHub repository using the Amplify GitHub\n App. The token is not stored.

\n

Use accessToken for GitHub repositories only. To authorize access to a\n repository provider such as Bitbucket or CodeCommit, use oauthToken.

\n

You must specify either accessToken or oauthToken when you\n create a new app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

" } }, "environmentVariables": { "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { - "smithy.api#documentation": "

The environment variables map for an Amplify app.

" + "smithy.api#documentation": "

The environment variables map for an Amplify app.

\n

For a list of the environment variables that are accessible to Amplify by default, see\n Amplify\n Environment variables in the Amplify Hosting User\n Guide.

" } }, "enableBranchAutoBuild": { "target": "com.amazonaws.amplify#EnableBranchAutoBuild", "traits": { - "smithy.api#documentation": "

Enables the auto building of branches for an Amplify app.

" + "smithy.api#documentation": "

Enables the auto building of branches for an Amplify app.

" } }, "enableBranchAutoDeletion": { "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", "traits": { - "smithy.api#documentation": "

Automatically disconnects a branch in the Amplify Console when you delete a branch\n from your Git repository.

" + "smithy.api#documentation": "

Automatically disconnects a branch in the Amplify console when you delete a branch\n from your Git repository.

" } }, "enableBasicAuth": { "target": "com.amazonaws.amplify#EnableBasicAuth", "traits": { - "smithy.api#documentation": "

Enables basic authorization for an Amplify app. This will apply to all branches that\n are part of this app.

" + "smithy.api#documentation": "

Enables basic authorization for an Amplify app. This will apply to all branches that\n are part of this app.

" } }, "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

The credentials for basic authorization for an Amplify app. You must base64-encode\n the authorization credentials and provide them in the format\n user:password.

" + "smithy.api#documentation": "

The credentials for basic authorization for an Amplify app. You must base64-encode the\n authorization credentials and provide them in the format\n user:password.

" } }, "customRules": { "target": "com.amazonaws.amplify#CustomRules", "traits": { - "smithy.api#documentation": "

The custom rewrite and redirect rules for an Amplify app.

" + "smithy.api#documentation": "

The custom rewrite and redirect rules for an Amplify app.

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

The tag for an Amplify app.

" + "smithy.api#documentation": "

The tag for an Amplify app.

" } }, "buildSpec": { "target": "com.amazonaws.amplify#BuildSpec", "traits": { - "smithy.api#documentation": "

The build specification (build spec) for an Amplify app.

" + "smithy.api#documentation": "

The build specification (build spec) for an Amplify app.

" } }, "customHeaders": { @@ -1929,24 +2021,24 @@ "enableAutoBranchCreation": { "target": "com.amazonaws.amplify#EnableAutoBranchCreation", "traits": { - "smithy.api#documentation": "

Enables automated branch creation for an Amplify app.

" + "smithy.api#documentation": "

Enables automated branch creation for an Amplify app.

" } }, "autoBranchCreationPatterns": { "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", "traits": { - "smithy.api#documentation": "

The automated branch creation glob patterns for an Amplify app.

" + "smithy.api#documentation": "

The automated branch creation glob patterns for an Amplify app.

" } }, "autoBranchCreationConfig": { "target": "com.amazonaws.amplify#AutoBranchCreationConfig", "traits": { - "smithy.api#documentation": "

The automated branch creation configuration for an Amplify app.

" + "smithy.api#documentation": "

The automated branch creation configuration for an Amplify app.

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

The request structure used to create apps in Amplify.

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

The request structure used to create apps in Amplify.

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

Creates a new backend environment for an Amplify app.

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

Creates a new backend environment for an Amplify app.

", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/backendenvironments", @@ -2004,7 +2096,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2012,25 +2104,25 @@ "environmentName": { "target": "com.amazonaws.amplify#EnvironmentName", "traits": { - "smithy.api#documentation": "

The name for the backend environment.

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

The name for the backend environment.

", "smithy.api#required": {} } }, "stackName": { "target": "com.amazonaws.amplify#StackName", "traits": { - "smithy.api#documentation": "

The AWS CloudFormation stack name of a backend environment.

" + "smithy.api#documentation": "

The AWS CloudFormation stack name of a backend environment.

" } }, "deploymentArtifacts": { "target": "com.amazonaws.amplify#DeploymentArtifacts", "traits": { - "smithy.api#documentation": "

The name of deployment artifacts.

" + "smithy.api#documentation": "

The name of deployment artifacts.

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

The request structure for the backend environment create request.

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

The request structure for the backend environment create request.

", "smithy.api#input": {} } }, @@ -2040,13 +2132,13 @@ "backendEnvironment": { "target": "com.amazonaws.amplify#BackendEnvironment", "traits": { - "smithy.api#documentation": "

Describes the backend environment for an Amplify app.

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

Describes the backend environment for an Amplify app.

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

The result structure for the create backend environment request.

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

The result structure for the create backend environment request.

", "smithy.api#output": {} } }, @@ -2101,20 +2193,20 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for the branch.

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

The name for the branch.

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

The description for the branch.

" + "smithy.api#documentation": "

The description for the branch.

" } }, "stage": { "target": "com.amazonaws.amplify#Stage", "traits": { - "smithy.api#documentation": "

Describes the current stage for the branch.

" + "smithy.api#documentation": "

Describes the current stage for the branch.

" } }, "framework": { @@ -2198,7 +2290,13 @@ "backendEnvironmentArn": { "target": "com.amazonaws.amplify#BackendEnvironmentArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

" + } + }, + "backend": { + "target": "com.amazonaws.amplify#Backend", + "traits": { + "smithy.api#documentation": "

The backend for a Branch of an Amplify app. Use for a\n backend created from an CloudFormation stack.

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

Creates a deployment for a manually deployed Amplify app. Manually deployed apps are\n not connected to a repository.

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

Creates a deployment for a manually deployed Amplify app. Manually deployed apps are\n not connected to a repository.

\n

The maximum duration between the CreateDeployment call and the\n StartDeployment call cannot exceed 8 hours. If the duration exceeds 8\n hours, the StartDeployment call and the associated Job will\n fail.

", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/branches/{branchName}/deployments", @@ -2268,7 +2366,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for the branch, for the job.

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

The name of the branch to use for the job.

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

Creates a new domain association for an Amplify app. This action associates a custom\n domain with the Amplify app

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

Creates a new domain association for an Amplify app. This action associates a custom\n domain with the Amplify app

", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/domains", @@ -2393,6 +2491,12 @@ "traits": { "smithy.api#documentation": "

The required AWS Identity and Access Management (IAM) service role for the Amazon\n Resource Name (ARN) for automatically creating subdomains.

" } + }, + "certificateSettings": { + "target": "com.amazonaws.amplify#CertificateSettings", + "traits": { + "smithy.api#documentation": "

The type of SSL/TLS certificate to use for your custom domain. If you don't specify a\n certificate type, Amplify uses the default certificate that it provisions and manages\n for you.

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

Creates a new webhook on an Amplify app.

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

Creates a new webhook on an Amplify app.

", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/webhooks", @@ -2462,7 +2566,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2470,19 +2574,19 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for a branch that is part of an Amplify app.

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

The name for a branch that is part of an Amplify app.

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

The description for a webhook.

" + "smithy.api#documentation": "

The description for a webhook.

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

The request structure for the create webhook request.

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

The request structure for the create webhook request.

", "smithy.api#input": {} } }, @@ -2492,13 +2596,13 @@ "webhook": { "target": "com.amazonaws.amplify#Webhook", "traits": { - "smithy.api#documentation": "

Describes a webhook that connects repository events to an Amplify app.

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

Describes a webhook that connects repository events to an Amplify app.

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

The result structure for the create webhook request.

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

The result structure for the create webhook request.

", "smithy.api#output": {} } }, @@ -2539,32 +2643,32 @@ "source": { "target": "com.amazonaws.amplify#Source", "traits": { - "smithy.api#documentation": "

The source pattern for a URL rewrite or redirect rule.

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

The source pattern for a URL rewrite or redirect rule.

", "smithy.api#required": {} } }, "target": { "target": "com.amazonaws.amplify#Target", "traits": { - "smithy.api#documentation": "

The target pattern for a URL rewrite or redirect rule.

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

The target pattern for a URL rewrite or redirect rule.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amplify#Status", "traits": { - "smithy.api#documentation": "

The status code for a URL rewrite or redirect rule.

\n
\n
200
\n
\n

Represents a 200 rewrite rule.

\n
\n
301
\n
\n

Represents a 301 (moved pemanently) redirect rule. This and all future\n requests should be directed to the target URL.

\n
\n
302
\n
\n

Represents a 302 temporary redirect rule.

\n
\n
404
\n
\n

Represents a 404 redirect rule.

\n
\n
404-200
\n
\n

Represents a 404 rewrite rule.

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

The status code for a URL rewrite or redirect rule.

\n
\n
200
\n
\n

Represents a 200 rewrite rule.

\n
\n
301
\n
\n

Represents a 301 (moved permanently) redirect rule. This and all future\n requests should be directed to the target URL.

\n
\n
302
\n
\n

Represents a 302 temporary redirect rule.

\n
\n
404
\n
\n

Represents a 404 redirect rule.

\n
\n
404-200
\n
\n

Represents a 404 rewrite rule.

\n
\n
" } }, "condition": { "target": "com.amazonaws.amplify#Condition", "traits": { - "smithy.api#documentation": "

The condition for a URL rewrite or redirect rule, such as a country code.

" + "smithy.api#documentation": "

The condition for a URL rewrite or redirect rule, such as a country code.

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

Describes a custom rewrite or redirect rule.

" + "smithy.api#documentation": "

Describes a custom rewrite or redirect rule.

" } }, "com.amazonaws.amplify#CustomRules": { @@ -2617,7 +2721,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an existing Amplify app specified by an app ID.

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

Deletes an existing Amplify app specified by an app ID.

", "smithy.api#http": { "method": "DELETE", "uri": "/apps/{appId}", @@ -2631,14 +2735,14 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

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

Describes the request structure for the delete app request.

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

Describes the request structure for the delete app request.

", "smithy.api#input": {} } }, @@ -2653,7 +2757,7 @@ } }, "traits": { - "smithy.api#documentation": "

The result structure for the delete app request.

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

The result structure for the delete app request.

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

Deletes a backend environment for an Amplify app.

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

Deletes a backend environment for an Amplify app.

", "smithy.api#http": { "method": "DELETE", "uri": "/apps/{appId}/backendenvironments/{environmentName}", @@ -2697,7 +2801,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID of an Amplify app.

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

The unique ID of an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2705,14 +2809,14 @@ "environmentName": { "target": "com.amazonaws.amplify#EnvironmentName", "traits": { - "smithy.api#documentation": "

The name of a backend environment of an Amplify app.

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

The name of a backend environment of an Amplify app.

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

The request structure for the delete backend environment request.

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

The request structure for the delete backend environment request.

", "smithy.api#input": {} } }, @@ -2722,13 +2826,13 @@ "backendEnvironment": { "target": "com.amazonaws.amplify#BackendEnvironment", "traits": { - "smithy.api#documentation": "

Describes the backend environment for an Amplify app.

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

Describes the backend environment for an Amplify app.

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

The result structure of the delete backend environment result.

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

The result structure of the delete backend environment result.

", "smithy.api#output": {} } }, @@ -2780,7 +2884,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for the branch.

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

The name of the branch.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2797,13 +2901,13 @@ "branch": { "target": "com.amazonaws.amplify#Branch", "traits": { - "smithy.api#documentation": "

The branch for an Amplify app, which maps to a third-party repository branch.

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

The branch for an Amplify app, which maps to a third-party repository branch.

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

The result structure for the delete branch request.

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

The result structure for the delete branch request.

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

Deletes a domain association for an Amplify app.

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

Deletes a domain association for an Amplify app.

", "smithy.api#http": { "method": "DELETE", "uri": "/apps/{appId}/domains/{domainName}", @@ -2928,7 +3032,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for the branch, for the job.

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

The name of the branch to use for the job.

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

Deletes a webhook.

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

Deletes a webhook.

", "smithy.api#http": { "method": "DELETE", "uri": "/webhooks/{webhookId}", @@ -3002,14 +3106,14 @@ "webhookId": { "target": "com.amazonaws.amplify#WebhookId", "traits": { - "smithy.api#documentation": "

The unique ID for a webhook.

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

The unique ID for a webhook.

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

The request structure for the delete webhook request.

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

The request structure for the delete webhook request.

", "smithy.api#input": {} } }, @@ -3019,13 +3123,13 @@ "webhook": { "target": "com.amazonaws.amplify#Webhook", "traits": { - "smithy.api#documentation": "

Describes a webhook that connects repository events to an Amplify app.

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

Describes a webhook that connects repository events to an Amplify app.

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

The result structure for the delete webhook request.

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

The result structure for the delete webhook request.

", "smithy.api#output": {} } }, @@ -3037,7 +3141,7 @@ } }, "traits": { - "smithy.api#documentation": "

An operation failed because a dependent service threw an exception.

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

An operation failed because a dependent service threw an exception.

", "smithy.api#error": "server", "smithy.api#httpError": 503 } @@ -3115,10 +3219,16 @@ "smithy.api#required": {} } }, + "updateStatus": { + "target": "com.amazonaws.amplify#UpdateStatus", + "traits": { + "smithy.api#documentation": "

The status of the domain update operation that is currently in progress. The following\n list describes the valid update states.

\n
\n
REQUESTING_CERTIFICATE
\n
\n

The certificate is in the process of being updated.

\n
\n
PENDING_VERIFICATION
\n
\n

Indicates that an Amplify managed certificate is in the\n process of being verified. This occurs during the creation of a custom\n domain or when a custom domain is updated to use a managed\n certificate.

\n
\n
IMPORTING_CUSTOM_CERTIFICATE
\n
\n

Indicates that an Amplify custom certificate is in the\n process of being imported. This occurs during the creation of a custom\n domain or when a custom domain is updated to use a custom\n certificate.

\n
\n
PENDING_DEPLOYMENT
\n
\n

Indicates that the subdomain or certificate changes are being\n propagated.

\n
\n
AWAITING_APP_CNAME
\n
\n

Amplify is waiting for CNAME records corresponding to\n subdomains to be propagated. If your custom domain is on Route 53,\n Amplify handles this for you automatically. For more\n information about custom domains, see Setting up custom\n domains in the Amplify Hosting User\n Guide.

\n
\n
UPDATE_COMPLETE
\n
\n

The certificate has been associated with a domain.

\n
\n
UPDATE_FAILED
\n
\n

The certificate has failed to be provisioned or associated, and there is\n no existing active certificate to roll back to.

\n
\n
" + } + }, "statusReason": { "target": "com.amazonaws.amplify#StatusReason", "traits": { - "smithy.api#documentation": "

The reason for the current status of the domain association.

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

Additional information that describes why the domain association is in the current\n state.

", "smithy.api#required": {} } }, @@ -3134,10 +3244,16 @@ "smithy.api#documentation": "

The subdomains for the domain association.

", "smithy.api#required": {} } + }, + "certificate": { + "target": "com.amazonaws.amplify#Certificate", + "traits": { + "smithy.api#documentation": "

Describes the SSL/TLS certificate for the domain association. This can be your own\n custom certificate or the default certificate that Amplify provisions for\n you.

\n

If you are updating your domain to use a different certificate,\n certificate points to the new certificate that is being created instead\n of the current active certificate. Otherwise, certificate points to the\n current active certificate.

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

Describes a domain association that associates a custom domain with an Amplify app.\n

" + "smithy.api#documentation": "

Describes the association between a custom domain and an Amplify app.

" } }, "com.amazonaws.amplify#DomainAssociationArn": { @@ -3202,12 +3318,24 @@ "smithy.api#enumValue": "AVAILABLE" } }, + "IMPORTING_CUSTOM_CERTIFICATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORTING_CUSTOM_CERTIFICATE" + } + }, "PENDING_DEPLOYMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_DEPLOYMENT" } }, + "AWAITING_APP_CNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWAITING_APP_CNAME" + } + }, "FAILED": { "target": "smithy.api#Unit", "traits": { @@ -3373,7 +3501,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the website access logs for a specific time range using a presigned URL.\n

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

Returns the website access logs for a specific time range using a presigned URL.\n

", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/accesslogs", @@ -3387,33 +3515,33 @@ "startTime": { "target": "com.amazonaws.amplify#StartTime", "traits": { - "smithy.api#documentation": "

The time at which the logs should start. The time range specified is inclusive of the\n start time.

" + "smithy.api#documentation": "

The time at which the logs should start. The time range specified is inclusive of the\n start time.

" } }, "endTime": { "target": "com.amazonaws.amplify#EndTime", "traits": { - "smithy.api#documentation": "

The time at which the logs should end. The time range specified is inclusive of the\n end time.

" + "smithy.api#documentation": "

The time at which the logs should end. The time range specified is inclusive of the\n end time.

" } }, "domainName": { "target": "com.amazonaws.amplify#DomainName", "traits": { - "smithy.api#documentation": "

The name of the domain.

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

The name of the domain.

", "smithy.api#required": {} } }, "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

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

The request structure for the generate access logs request.

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

The request structure for the generate access logs request.

", "smithy.api#input": {} } }, @@ -3423,12 +3551,12 @@ "logUrl": { "target": "com.amazonaws.amplify#LogUrl", "traits": { - "smithy.api#documentation": "

The pre-signed URL for the requested access logs.

" + "smithy.api#documentation": "

The pre-signed URL for the requested access logs.

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

The result structure for the generate access logs request.

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

The result structure for the generate access logs request.

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

Returns an existing Amplify app by appID.

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

Returns an existing Amplify app specified by an app ID.

", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}", @@ -3469,14 +3597,14 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

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

The request structure for the get app request.

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

The request structure for the get app request.

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

Returns the artifact info that corresponds to an artifact id.

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

Returns the artifact info that corresponds to an artifact id.

", "smithy.api#http": { "method": "GET", "uri": "/artifacts/{artifactId}", @@ -3534,14 +3662,14 @@ "artifactId": { "target": "com.amazonaws.amplify#ArtifactId", "traits": { - "smithy.api#documentation": "

The unique ID for an artifact.

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

The unique ID for an artifact.

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

Returns the request structure for the get artifact request.

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

Returns the request structure for the get artifact request.

", "smithy.api#input": {} } }, @@ -3551,20 +3679,20 @@ "artifactId": { "target": "com.amazonaws.amplify#ArtifactId", "traits": { - "smithy.api#documentation": "

The unique ID for an artifact.

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

The unique ID for an artifact.

", "smithy.api#required": {} } }, "artifactUrl": { "target": "com.amazonaws.amplify#ArtifactUrl", "traits": { - "smithy.api#documentation": "

The presigned URL for the artifact.

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

The presigned URL for the artifact.

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

Returns the result structure for the get artifact request.

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

Returns the result structure for the get artifact request.

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

Returns a backend environment for an Amplify app.

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

Returns a backend environment for an Amplify app.

", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/backendenvironments/{environmentName}", @@ -3605,7 +3733,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique id for an Amplify app.

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

The unique id for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3613,14 +3741,14 @@ "environmentName": { "target": "com.amazonaws.amplify#EnvironmentName", "traits": { - "smithy.api#documentation": "

The name for the backend environment.

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

The name for the backend environment.

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

The request structure for the get backend environment request.

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

The request structure for the get backend environment request.

", "smithy.api#input": {} } }, @@ -3630,13 +3758,13 @@ "backendEnvironment": { "target": "com.amazonaws.amplify#BackendEnvironment", "traits": { - "smithy.api#documentation": "

Describes the backend environment for an Amplify app.

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

Describes the backend environment for an Amplify app.

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

The result structure for the get backend environment result.

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

The result structure for the get backend environment result.

", "smithy.api#output": {} } }, @@ -3685,7 +3813,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for the branch.

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

The name of the branch.

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

Returns the domain information for an Amplify app.

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

Returns the domain information for an Amplify app.

", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/domains/{domainName}", @@ -3822,7 +3950,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3830,7 +3958,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The branch name for the job.

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

The name of the branch to use for the job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3838,14 +3966,14 @@ "jobId": { "target": "com.amazonaws.amplify#JobId", "traits": { - "smithy.api#documentation": "

The unique ID for the job.

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

The unique ID for the job.

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

The request structure for the get job request.

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

The request structure for the get job request.

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

Returns the webhook information that corresponds to a specified webhook ID.

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

Returns the webhook information that corresponds to a specified webhook ID.

", "smithy.api#http": { "method": "GET", "uri": "/webhooks/{webhookId}", @@ -3903,14 +4031,14 @@ "webhookId": { "target": "com.amazonaws.amplify#WebhookId", "traits": { - "smithy.api#documentation": "

The unique ID for a webhook.

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

The unique ID for a webhook.

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

The request structure for the get webhook request.

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

The request structure for the get webhook request.

", "smithy.api#input": {} } }, @@ -3920,13 +4048,13 @@ "webhook": { "target": "com.amazonaws.amplify#Webhook", "traits": { - "smithy.api#documentation": "

Describes the structure of a webhook.

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

Describes the structure of a webhook.

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

The result structure for the get webhook request.

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

The result structure for the get webhook request.

", "smithy.api#output": {} } }, @@ -3938,7 +4066,7 @@ } }, "traits": { - "smithy.api#documentation": "

The service failed to perform an operation due to an internal issue.

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

The service failed to perform an operation due to an internal issue.

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

A resource could not be created because service quotas were exceeded.

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

A resource could not be created because service quotas were exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -4188,11 +4316,17 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of the existing Amplify apps.

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

Returns a list of the existing Amplify apps.

", "smithy.api#http": { "method": "GET", "uri": "/apps", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "apps", + "pageSize": "maxResults" } } }, @@ -4202,7 +4336,7 @@ "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. If non-null, the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries.

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

A pagination token. If non-null, the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4210,13 +4344,13 @@ "target": "com.amazonaws.amplify#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of records to list in a single response.

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

The maximum number of records to list in a single response.

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

The request structure for the list apps request.

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

The request structure for the list apps request.

", "smithy.api#input": {} } }, @@ -4226,19 +4360,19 @@ "apps": { "target": "com.amazonaws.amplify#Apps", "traits": { - "smithy.api#documentation": "

A list of Amplify apps.

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

A list of Amplify apps.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. Set to null to start listing apps from start. If non-null, the\n pagination token is returned in a result. Pass its value in here to list more projects.\n

" + "smithy.api#documentation": "

A pagination token. Set to null to start listing apps from start. If non-null, the\n pagination token is returned in a result. Pass its value in here to list more projects.\n

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

The result structure for an Amplify app list request.

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

The result structure for an Amplify app list request.

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

Returns a list of artifacts for a specified app, branch, and job.

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

Returns a list of artifacts for a specified app, branch, and job.

", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/branches/{branchName}/jobs/{jobId}/artifacts", @@ -4279,7 +4413,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4287,7 +4421,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name of a branch that is part of an Amplify app.

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

The name of a branch that is part of an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4295,7 +4429,7 @@ "jobId": { "target": "com.amazonaws.amplify#JobId", "traits": { - "smithy.api#documentation": "

The unique ID for a job.

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

The unique ID for a job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4303,7 +4437,7 @@ "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. Set to null to start listing artifacts from start. If a non-null\n pagination token is returned in a result, pass its value in here to list more artifacts.\n

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

A pagination token. Set to null to start listing artifacts from start. If a non-null\n pagination token is returned in a result, pass its value in here to list more artifacts.\n

", "smithy.api#httpQuery": "nextToken" } }, @@ -4311,13 +4445,13 @@ "target": "com.amazonaws.amplify#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of records to list in a single response.

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

The maximum number of records to list in a single response.

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

Describes the request structure for the list artifacts request.

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

Describes the request structure for the list artifacts request.

", "smithy.api#input": {} } }, @@ -4327,19 +4461,19 @@ "artifacts": { "target": "com.amazonaws.amplify#Artifacts", "traits": { - "smithy.api#documentation": "

A list of artifacts.

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

A list of artifacts.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. If a non-null pagination token is returned in a result, pass its\n value in another request to retrieve more entries.

" + "smithy.api#documentation": "

A pagination token. If a non-null pagination token is returned in a result, pass its\n value in another request to retrieve more entries.

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

The result structure for the list artifacts request.

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

The result structure for the list artifacts request.

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

Lists the backend environments for an Amplify app.

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

Lists the backend environments for an Amplify app.

", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/backendenvironments", @@ -4377,7 +4511,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4385,14 +4519,14 @@ "environmentName": { "target": "com.amazonaws.amplify#EnvironmentName", "traits": { - "smithy.api#documentation": "

The name of the backend environment

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

The name of the backend environment

", "smithy.api#httpQuery": "environmentName" } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. Set to null to start listing backend environments from the start.\n If a non-null pagination token is returned in a result, pass its value in here to list\n more backend environments.

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

A pagination token. Set to null to start listing backend environments from the start.\n If a non-null pagination token is returned in a result, pass its value in here to list\n more backend environments.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4400,13 +4534,13 @@ "target": "com.amazonaws.amplify#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of records to list in a single response.

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

The maximum number of records to list in a single response.

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

The request structure for the list backend environments request.

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

The request structure for the list backend environments request.

", "smithy.api#input": {} } }, @@ -4416,19 +4550,19 @@ "backendEnvironments": { "target": "com.amazonaws.amplify#BackendEnvironments", "traits": { - "smithy.api#documentation": "

The list of backend environments for an Amplify app.

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

The list of backend environments for an Amplify app.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. If a non-null pagination token is returned in a result, pass its\n value in another request to retrieve more entries.

" + "smithy.api#documentation": "

A pagination token. If a non-null pagination token is returned in a result, pass its\n value in another request to retrieve more entries.

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

The result structure for the list backend environments result.

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

The result structure for the list backend environments result.

", "smithy.api#output": {} } }, @@ -4457,6 +4591,12 @@ "method": "GET", "uri": "/apps/{appId}/branches", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "branches", + "pageSize": "maxResults" } } }, @@ -4466,7 +4606,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4474,7 +4614,7 @@ "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. Set to null to start listing branches from the start. If a\n non-null pagination token is returned in a result, pass its value in here to list more\n branches.

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

A pagination token. Set to null to start listing branches from the start. If a\n non-null pagination token is returned in a result, pass its value in here to list more\n branches.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4488,7 +4628,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request structure for the list branches request.

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

The request structure for the list branches request.

", "smithy.api#input": {} } }, @@ -4534,11 +4674,17 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the domain associations for an Amplify app.

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

Returns the domain associations for an Amplify app.

", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/domains", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "domainAssociations", + "pageSize": "maxResults" } } }, @@ -4624,6 +4770,12 @@ "method": "GET", "uri": "/apps/{appId}/branches/{branchName}/jobs", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "jobSummaries", + "pageSize": "maxResults" } } }, @@ -4641,7 +4793,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for a branch.

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

The name of the branch to use for the request.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4649,7 +4801,7 @@ "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. Set to null to start listing steps from the start. If a non-null\n pagination token is returned in a result, pass its value in here to list more steps.\n

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

A pagination token. Set to null to start listing steps from the start. If a non-null\n pagination token is returned in a result, pass its value in here to list more steps.\n

", "smithy.api#httpQuery": "nextToken" } }, @@ -4657,7 +4809,7 @@ "target": "com.amazonaws.amplify#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of records to list in a single response.

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

The maximum number of records to list in a single response.

", "smithy.api#httpQuery": "maxResults" } } @@ -4673,19 +4825,19 @@ "jobSummaries": { "target": "com.amazonaws.amplify#JobSummaries", "traits": { - "smithy.api#documentation": "

The result structure for the list job result request.

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

The result structure for the list job result request.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. If non-null the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries.

" + "smithy.api#documentation": "

A pagination token. If non-null the pagination token is returned in a result. Pass its\n value in another request to retrieve more entries.

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

The maximum number of records to list in a single response.

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

The maximum number of records to list in a single response.

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

Returns a list of tags for a specified Amazon Resource Name (ARN).

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

Returns a list of tags for a specified Amazon Resource Name (ARN).

", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}", @@ -4723,14 +4875,14 @@ "resourceArn": { "target": "com.amazonaws.amplify#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) to use to list tags.

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

The Amazon Resource Name (ARN) to use to list tags.

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

The request structure to use to list tags for a resource.

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

The request structure to use to list tags for a resource.

", "smithy.api#input": {} } }, @@ -4740,12 +4892,12 @@ "tags": { "target": "com.amazonaws.amplify#TagMap", "traits": { - "smithy.api#documentation": "

A list of tags for the specified The Amazon Resource Name (ARN).

" + "smithy.api#documentation": "

A list of tags for the specified The Amazon Resource Name (ARN).

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

The response for the list tags for resource request.

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

The response for the list tags for resource request.

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

Returns a list of webhooks for an Amplify app.

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

Returns a list of webhooks for an Amplify app.

", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/webhooks", @@ -4786,7 +4938,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4794,7 +4946,7 @@ "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. Set to null to start listing webhooks from the start. If\n non-null,the pagination token is returned in a result. Pass its value in here to list\n more webhooks.

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

A pagination token. Set to null to start listing webhooks from the start. If\n non-null,the pagination token is returned in a result. Pass its value in here to list\n more webhooks.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4802,13 +4954,13 @@ "target": "com.amazonaws.amplify#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of records to list in a single response.

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

The maximum number of records to list in a single response.

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

The request structure for the list webhooks request.

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

The request structure for the list webhooks request.

", "smithy.api#input": {} } }, @@ -4818,19 +4970,19 @@ "webhooks": { "target": "com.amazonaws.amplify#Webhooks", "traits": { - "smithy.api#documentation": "

A list of webhooks.

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

A list of webhooks.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. If non-null, the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries.

" + "smithy.api#documentation": "

A pagination token. If non-null, the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries.

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

The result structure for the list webhooks request.

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

The result structure for the list webhooks request.

", "smithy.api#output": {} } }, @@ -4891,7 +5043,7 @@ } }, "traits": { - "smithy.api#documentation": "

An entity was not found during an operation.

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

An entity was not found during an operation.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -4936,30 +5088,30 @@ "lastDeployTime": { "target": "com.amazonaws.amplify#LastDeployTime", "traits": { - "smithy.api#documentation": "

The last deploy time of the production branch.

" + "smithy.api#documentation": "

The last deploy time of the production branch.

" } }, "status": { "target": "com.amazonaws.amplify#Status", "traits": { - "smithy.api#documentation": "

The status of the production branch.

" + "smithy.api#documentation": "

The status of the production branch.

" } }, "thumbnailUrl": { "target": "com.amazonaws.amplify#ThumbnailUrl", "traits": { - "smithy.api#documentation": "

The thumbnail URL for the production branch.

" + "smithy.api#documentation": "

The thumbnail URL for the production branch.

" } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The branch name for the production branch.

" + "smithy.api#documentation": "

The branch name for the production branch.

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

Describes the information about a production branch for an Amplify app.

" + "smithy.api#documentation": "

Describes the information about a production branch for an Amplify app.

" } }, "com.amazonaws.amplify#PullRequestEnvironmentName": { @@ -5032,7 +5184,7 @@ } }, "traits": { - "smithy.api#documentation": "

An operation failed due to a non-existent resource.

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

An operation failed due to a non-existent resource.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -5076,6 +5228,16 @@ "smithy.api#pattern": "^(?s)" } }, + "com.amazonaws.amplify#StackArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:cloudformation:[a-z0-9-]+:\\d{12}:stack/.+/.+$" + } + }, "com.amazonaws.amplify#StackName": { "type": "string", "traits": { @@ -5147,7 +5309,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a deployment for a manually deployed app. Manually deployed apps are not\n connected to a repository.

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

Starts a deployment for a manually deployed app. Manually deployed apps are not\n connected to a repository.

\n

The maximum duration between the CreateDeployment call and the\n StartDeployment call cannot exceed 8 hours. If the duration exceeds 8\n hours, the StartDeployment call and the associated Job will\n fail.

", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/branches/{branchName}/deployments/start", @@ -5161,7 +5323,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5169,7 +5331,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for the branch, for the job.

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

The name of the branch to use for the job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5177,18 +5339,18 @@ "jobId": { "target": "com.amazonaws.amplify#JobId", "traits": { - "smithy.api#documentation": "

The job ID for this deployment, generated by the create deployment request.

" + "smithy.api#documentation": "

The job ID for this deployment, generated by the create deployment request.

" } }, "sourceUrl": { "target": "com.amazonaws.amplify#SourceUrl", "traits": { - "smithy.api#documentation": "

The source URL for this deployment, used when calling start deployment without create\n deployment. The source URL can be any HTTP GET URL that is publicly accessible and\n downloads a single .zip file.

" + "smithy.api#documentation": "

The source URL for this deployment, used when calling start deployment without create\n deployment. The source URL can be any HTTP GET URL that is publicly accessible and\n downloads a single .zip file.

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

The request structure for the start a deployment request.

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

The request structure for the start a deployment request.

", "smithy.api#input": {} } }, @@ -5198,13 +5360,13 @@ "jobSummary": { "target": "com.amazonaws.amplify#JobSummary", "traits": { - "smithy.api#documentation": "

The summary for the job.

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

The summary for the job.

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

The result structure for the start a deployment request.

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

The result structure for the start a deployment request.

", "smithy.api#output": {} } }, @@ -5248,7 +5410,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5256,7 +5418,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The branch name for the job.

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

The name of the branch to use for the job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5264,20 +5426,20 @@ "jobId": { "target": "com.amazonaws.amplify#JobId", "traits": { - "smithy.api#documentation": "

The unique ID for an existing job. This is required if the value of\n jobType is RETRY.

" + "smithy.api#documentation": "

The unique ID for an existing job. This is required if the value of\n jobType is RETRY.

" } }, "jobType": { "target": "com.amazonaws.amplify#JobType", "traits": { - "smithy.api#documentation": "

Describes the type for the job. The job type RELEASE starts a new job\n with the latest change from the specified branch. This value is available only for apps\n that are connected to a repository. The job type RETRY retries an existing\n job. If the job type value is RETRY, the jobId is also\n required.

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

Describes the type for the job. The job type RELEASE starts a new job\n with the latest change from the specified branch. This value is available only for apps\n that are connected to a repository.

\n

The job type RETRY retries an existing job. If the job type value is\n RETRY, the jobId is also required.

", "smithy.api#required": {} } }, "jobReason": { "target": "com.amazonaws.amplify#JobReason", "traits": { - "smithy.api#documentation": "

A descriptive reason for starting this job.

" + "smithy.api#documentation": "

A descriptive reason for starting the job.

" } }, "commitId": { @@ -5300,7 +5462,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request structure for the start job request.

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

The request structure for the start job request.

", "smithy.api#input": {} } }, @@ -5483,7 +5645,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for the branch, for the job.

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

The name of the branch to use for the stop job request.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5596,7 +5758,7 @@ "com.amazonaws.amplify#TTL": { "type": "string", "traits": { - "smithy.api#documentation": "

The content Time to Live (TTL) for the website in seconds.

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

The content Time to Live (TTL) for the website in seconds.

", "smithy.api#length": { "min": 0, "max": 32 @@ -5661,7 +5823,7 @@ } ], "traits": { - "smithy.api#documentation": "

Tags the resource with a tag key and value.

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

Tags the resource with a tag key and value.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -5683,13 +5845,13 @@ "tags": { "target": "com.amazonaws.amplify#TagMap", "traits": { - "smithy.api#documentation": "

The tags used to tag the resource.

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

The tags used to tag the resource.

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

The request structure to tag a resource with a tag key and value.

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

The request structure to tag a resource with a tag key and value.

", "smithy.api#input": {} } }, @@ -5697,7 +5859,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

The response for the tag resource request.

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

The response for the tag resource request.

", "smithy.api#output": {} } }, @@ -5774,7 +5936,7 @@ } }, "traits": { - "smithy.api#documentation": "

An operation failed due to a lack of access.

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

An operation failed due to a lack of access.

", "smithy.api#error": "client", "smithy.api#httpError": 401 } @@ -5799,7 +5961,7 @@ } ], "traits": { - "smithy.api#documentation": "

Untags a resource with a specified Amazon Resource Name (ARN).

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

Untags a resource with a specified Amazon Resource Name (ARN).

", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}", @@ -5813,7 +5975,7 @@ "resourceArn": { "target": "com.amazonaws.amplify#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) to use to untag a resource.

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

The Amazon Resource Name (ARN) to use to untag a resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5821,14 +5983,14 @@ "tagKeys": { "target": "com.amazonaws.amplify#TagKeyList", "traits": { - "smithy.api#documentation": "

The tag keys to use to untag a resource.

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

The tag keys to use to untag a resource.

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

The request structure for the untag resource request.

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

The request structure for the untag resource request.

", "smithy.api#input": {} } }, @@ -5836,7 +5998,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

The response for the untag resource request.

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

The response for the untag resource request.

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

Updates an existing Amplify app.

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

Updates an existing Amplify app.

", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}", @@ -5877,7 +6039,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5885,67 +6047,67 @@ "name": { "target": "com.amazonaws.amplify#Name", "traits": { - "smithy.api#documentation": "

The name for an Amplify app.

" + "smithy.api#documentation": "

The name for an Amplify app.

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

The description for an Amplify app.

" + "smithy.api#documentation": "

The description for an Amplify app.

" } }, "platform": { "target": "com.amazonaws.amplify#Platform", "traits": { - "smithy.api#documentation": "

The platform for the Amplify app. For a static app, set the platform type to WEB.\n For a dynamic server-side rendered (SSR) app, set the platform type to\n WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to\n WEB_DYNAMIC.

" + "smithy.api#documentation": "

The platform for the Amplify app. For a static app, set the platform type to\n WEB. For a dynamic server-side rendered (SSR) app, set the platform\n type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR\n support only, set the platform type to WEB_DYNAMIC.

" } }, "iamServiceRoleArn": { "target": "com.amazonaws.amplify#ServiceRoleArn", "traits": { - "smithy.api#documentation": "

The AWS Identity and Access Management (IAM) service role for an Amplify app.

" + "smithy.api#documentation": "

The AWS Identity and Access Management (IAM) service role for an Amplify app.

" } }, "environmentVariables": { "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { - "smithy.api#documentation": "

The environment variables for an Amplify app.

" + "smithy.api#documentation": "

The environment variables for an Amplify app.

" } }, "enableBranchAutoBuild": { "target": "com.amazonaws.amplify#EnableAutoBuild", "traits": { - "smithy.api#documentation": "

Enables branch auto-building for an Amplify app.

" + "smithy.api#documentation": "

Enables branch auto-building for an Amplify app.

" } }, "enableBranchAutoDeletion": { "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", "traits": { - "smithy.api#documentation": "

Automatically disconnects a branch in the Amplify Console when you delete a branch\n from your Git repository.

" + "smithy.api#documentation": "

Automatically disconnects a branch in the Amplify console when you delete a branch\n from your Git repository.

" } }, "enableBasicAuth": { "target": "com.amazonaws.amplify#EnableBasicAuth", "traits": { - "smithy.api#documentation": "

Enables basic authorization for an Amplify app.

" + "smithy.api#documentation": "

Enables basic authorization for an Amplify app.

" } }, "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

The basic authorization credentials for an Amplify app. You must base64-encode the\n authorization credentials and provide them in the format\n user:password.

" + "smithy.api#documentation": "

The basic authorization credentials for an Amplify app. You must base64-encode the\n authorization credentials and provide them in the format\n user:password.

" } }, "customRules": { "target": "com.amazonaws.amplify#CustomRules", "traits": { - "smithy.api#documentation": "

The custom redirect and rewrite rules for an Amplify app.

" + "smithy.api#documentation": "

The custom redirect and rewrite rules for an Amplify app.

" } }, "buildSpec": { "target": "com.amazonaws.amplify#BuildSpec", "traits": { - "smithy.api#documentation": "

The build specification (build spec) for an Amplify app.

" + "smithy.api#documentation": "

The build specification (build spec) for an Amplify app.

" } }, "customHeaders": { @@ -5957,42 +6119,42 @@ "enableAutoBranchCreation": { "target": "com.amazonaws.amplify#EnableAutoBranchCreation", "traits": { - "smithy.api#documentation": "

Enables automated branch creation for an Amplify app.

" + "smithy.api#documentation": "

Enables automated branch creation for an Amplify app.

" } }, "autoBranchCreationPatterns": { "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", "traits": { - "smithy.api#documentation": "

Describes the automated branch creation glob patterns for an Amplify app.

" + "smithy.api#documentation": "

Describes the automated branch creation glob patterns for an Amplify app.

" } }, "autoBranchCreationConfig": { "target": "com.amazonaws.amplify#AutoBranchCreationConfig", "traits": { - "smithy.api#documentation": "

The automated branch creation configuration for an Amplify app.

" + "smithy.api#documentation": "

The automated branch creation configuration for an Amplify app.

" } }, "repository": { "target": "com.amazonaws.amplify#Repository", "traits": { - "smithy.api#documentation": "

The name of the repository for an Amplify app

" + "smithy.api#documentation": "

The name of the Git repository for an Amplify app.

" } }, "oauthToken": { "target": "com.amazonaws.amplify#OauthToken", "traits": { - "smithy.api#documentation": "

The OAuth token for a third-party source control system for an Amplify app. The OAuth\n token is used to create a webhook and a read-only deploy key using SSH cloning. The\n OAuth token is not stored.

\n

Use oauthToken for repository providers other than GitHub, such as\n Bitbucket or CodeCommit.

\n

To authorize access to GitHub as your repository provider, use\n accessToken.

\n

You must specify either oauthToken or accessToken when you\n update an app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

" + "smithy.api#documentation": "

The OAuth token for a third-party source control system for an Amplify app. The OAuth\n token is used to create a webhook and a read-only deploy key using SSH cloning. The\n OAuth token is not stored.

\n

Use oauthToken for repository providers other than GitHub, such as\n Bitbucket or CodeCommit.

\n

To authorize access to GitHub as your repository provider, use\n accessToken.

\n

You must specify either oauthToken or accessToken when you\n update an app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

" } }, "accessToken": { "target": "com.amazonaws.amplify#AccessToken", "traits": { - "smithy.api#documentation": "

The personal access token for a GitHub repository for an Amplify app. The personal\n access token is used to authorize access to a GitHub repository using the Amplify GitHub\n App. The token is not stored.

\n

Use accessToken for GitHub repositories only. To authorize access to a\n repository provider such as Bitbucket or CodeCommit, use oauthToken.

\n

You must specify either accessToken or oauthToken when you\n update an app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

" + "smithy.api#documentation": "

The personal access token for a GitHub repository for an Amplify app. The personal\n access token is used to authorize access to a GitHub repository using the Amplify GitHub\n App. The token is not stored.

\n

Use accessToken for GitHub repositories only. To authorize access to a\n repository provider such as Bitbucket or CodeCommit, use oauthToken.

\n

You must specify either accessToken or oauthToken when you\n update an app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

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

The request structure for the update app request.

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

The request structure for the update app request.

", "smithy.api#input": {} } }, @@ -6002,13 +6164,13 @@ "app": { "target": "com.amazonaws.amplify#App", "traits": { - "smithy.api#documentation": "

Represents the updated Amplify app.

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

Represents the updated Amplify app.

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

The result structure for an Amplify app update request.

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

The result structure for an Amplify app update request.

", "smithy.api#output": {} } }, @@ -6060,7 +6222,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for the branch.

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

The name of the branch.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6152,12 +6314,18 @@ "backendEnvironmentArn": { "target": "com.amazonaws.amplify#BackendEnvironmentArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

" + } + }, + "backend": { + "target": "com.amazonaws.amplify#Backend", + "traits": { + "smithy.api#documentation": "

The backend for a Branch of an Amplify app. Use for a\n backend created from an CloudFormation stack.

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

The request structure for the update branch request.

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

The request structure for the update branch request.

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

Creates a new domain association for an Amplify app.

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

Creates a new domain association for an Amplify app.

", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/domains/{domainName}", @@ -6253,6 +6421,12 @@ "traits": { "smithy.api#documentation": "

The required AWS Identity and Access Management (IAM) service role for the Amazon\n Resource Name (ARN) for automatically creating subdomains.

" } + }, + "certificateSettings": { + "target": "com.amazonaws.amplify#CertificateSettings", + "traits": { + "smithy.api#documentation": "

The type of SSL/TLS certificate to use for your custom domain.

" + } } }, "traits": { @@ -6276,6 +6450,53 @@ "smithy.api#output": {} } }, + "com.amazonaws.amplify#UpdateStatus": { + "type": "enum", + "members": { + "REQUESTING_CERTIFICATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUESTING_CERTIFICATE" + } + }, + "PENDING_VERIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VERIFICATION" + } + }, + "IMPORTING_CUSTOM_CERTIFICATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORTING_CUSTOM_CERTIFICATE" + } + }, + "PENDING_DEPLOYMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_DEPLOYMENT" + } + }, + "AWAITING_APP_CNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWAITING_APP_CNAME" + } + }, + "UPDATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_COMPLETE" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + } + } + }, "com.amazonaws.amplify#UpdateTime": { "type": "timestamp" }, @@ -6305,7 +6526,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a webhook.

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

Updates a webhook.

", "smithy.api#http": { "method": "POST", "uri": "/webhooks/{webhookId}", @@ -6319,7 +6540,7 @@ "webhookId": { "target": "com.amazonaws.amplify#WebhookId", "traits": { - "smithy.api#documentation": "

The unique ID for a webhook.

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

The unique ID for a webhook.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6327,18 +6548,18 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for a branch that is part of an Amplify app.

" + "smithy.api#documentation": "

The name for a branch that is part of an Amplify app.

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

The description for a webhook.

" + "smithy.api#documentation": "

The description for a webhook.

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

The request structure for the update webhook request.

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

The request structure for the update webhook request.

", "smithy.api#input": {} } }, @@ -6348,13 +6569,13 @@ "webhook": { "target": "com.amazonaws.amplify#Webhook", "traits": { - "smithy.api#documentation": "

Describes a webhook that connects repository events to an Amplify app.

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

Describes a webhook that connects repository events to an Amplify app.

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

The result structure for the update webhook request.

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

The result structure for the update webhook request.

", "smithy.api#output": {} } }, @@ -6376,55 +6597,55 @@ "webhookArn": { "target": "com.amazonaws.amplify#WebhookArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the webhook.

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

The Amazon Resource Name (ARN) for the webhook.

", "smithy.api#required": {} } }, "webhookId": { "target": "com.amazonaws.amplify#WebhookId", "traits": { - "smithy.api#documentation": "

The ID of the webhook.

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

The ID of the webhook.

", "smithy.api#required": {} } }, "webhookUrl": { "target": "com.amazonaws.amplify#WebhookUrl", "traits": { - "smithy.api#documentation": "

The URL of the webhook.

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

The URL of the webhook.

", "smithy.api#required": {} } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for a branch that is part of an Amplify app.

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

The name for a branch that is part of an Amplify app.

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

The description for a webhook.

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

The description for a webhook.

", "smithy.api#required": {} } }, "createTime": { "target": "com.amazonaws.amplify#CreateTime", "traits": { - "smithy.api#documentation": "

The create date and time for a webhook.

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

The create date and time for a webhook.

", "smithy.api#required": {} } }, "updateTime": { "target": "com.amazonaws.amplify#UpdateTime", "traits": { - "smithy.api#documentation": "

Updates the date and time for a webhook.

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

Updates the date and time for a webhook.

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

Describes a webhook that connects repository events to an Amplify app.

" + "smithy.api#documentation": "

Describes a webhook that connects repository events to an Amplify app.

" } }, "com.amazonaws.amplify#WebhookArn": { diff --git a/codegen/sdk/aws-models/chatbot.json b/codegen/sdk/aws-models/chatbot.json new file mode 100644 index 00000000000..4926bdd15b5 --- /dev/null +++ b/codegen/sdk/aws-models/chatbot.json @@ -0,0 +1,3497 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.chatbot#AccountPreferences": { + "type": "structure", + "members": { + "UserAuthorizationRequired": { + "target": "com.amazonaws.chatbot#BooleanAccountPreference", + "traits": { + "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + } + }, + "TrainingDataCollectionEnabled": { + "target": "com.amazonaws.chatbot#BooleanAccountPreference", + "traits": { + "smithy.api#documentation": "Turns on training data collection. This helps improve the AWS Chatbot experience by allowing AWS Chatbot to store and use your customer information, such as AWS Chatbot configurations, notifications, user inputs, AWS Chatbot generated responses, and interaction data. This data helps us to continuously improve and develop Artificial Intelligence (AI) technologies. Your data is not shared with any third parties and is protected using sophisticated controls to prevent unauthorized access and misuse. AWS Chatbot does not store or use interactions in chat channels with Amazon Q for training AWS Chatbot’s AI technologies." + } + } + }, + "traits": { + "smithy.api#documentation": "Preferences which apply for AWS Chatbot usage in the calling AWS account." + } + }, + "com.amazonaws.chatbot#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 1224 + }, + "smithy.api#pattern": "^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$" + } + }, + "com.amazonaws.chatbot#AwsUserIdentity": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 15, + "max": 1101 + }, + "smithy.api#pattern": "^arn:aws:(iam|sts)::[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$" + } + }, + "com.amazonaws.chatbot#BooleanAccountPreference": { + "type": "boolean" + }, + "com.amazonaws.chatbot#ChatConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 19, + "max": 1169 + }, + "smithy.api#pattern": "^arn:aws:(wheatley|chatbot):[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$" + } + }, + "com.amazonaws.chatbot#ChimeWebhookConfiguration": { + "type": "structure", + "members": { + "WebhookDescription": { + "target": "com.amazonaws.chatbot#ChimeWebhookDescription", + "traits": { + "smithy.api#documentation": "Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.", + "smithy.api#required": {} + } + }, + "ChatConfigurationArn": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN of the ChimeWebhookConfiguration.", + "smithy.api#required": {} + } + }, + "IamRoleArn": { + "target": "com.amazonaws.chatbot#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#required": {} + } + }, + "SnsTopicArns": { + "target": "com.amazonaws.chatbot#SnsTopicArnList", + "traits": { + "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot.", + "smithy.api#required": {} + } + }, + "ConfigurationName": { + "target": "com.amazonaws.chatbot#ConfigurationName", + "traits": { + "smithy.api#documentation": "The name of the configuration." + } + }, + "LoggingLevel": { + "target": "com.amazonaws.chatbot#CustomerCwLogLevel", + "traits": { + "smithy.api#documentation": "Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.Logging levels include ERROR, INFO, or NONE." + } + } + }, + "traits": { + "smithy.api#documentation": "An AWS Chatbot configuration for Amazon Chime." + } + }, + "com.amazonaws.chatbot#ChimeWebhookConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.chatbot#ChimeWebhookConfiguration" + } + }, + "com.amazonaws.chatbot#ChimeWebhookDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.chatbot#ChimeWebhookUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^https://hooks\\.chime\\.aws/incomingwebhooks/[A-Za-z0-9\\-]+?\\?token=[A-Za-z0-9\\-]+$" + } + }, + "com.amazonaws.chatbot#ConfigurationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_]+$" + } + }, + "com.amazonaws.chatbot#ConfiguredTeam": { + "type": "structure", + "members": { + "TenantId": { + "target": "com.amazonaws.chatbot#UUID", + "traits": { + "smithy.api#documentation": "The ID of the Microsoft Teams tenant.", + "smithy.api#required": {} + } + }, + "TeamId": { + "target": "com.amazonaws.chatbot#UUID", + "traits": { + "smithy.api#documentation": "The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.", + "smithy.api#required": {} + } + }, + "TeamName": { + "target": "com.amazonaws.chatbot#UUID", + "traits": { + "smithy.api#documentation": "The name of the Microsoft Teams Team." + } + } + }, + "traits": { + "smithy.api#documentation": "A Microsoft Teams team that has been authorized with AWS Chatbot." + } + }, + "com.amazonaws.chatbot#ConfiguredTeamsList": { + "type": "list", + "member": { + "target": "com.amazonaws.chatbot#ConfiguredTeam" + } + }, + "com.amazonaws.chatbot#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "There was an issue processing your request.", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.chatbot#CreateChimeWebhookConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#CreateChimeWebhookConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#CreateChimeWebhookConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#ConflictException" + }, + { + "target": "com.amazonaws.chatbot#CreateChimeWebhookConfigurationException" + }, + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "Creates Chime Webhook Configuration", + "smithy.api#http": { + "method": "POST", + "uri": "/create-chime-webhook-configuration", + "code": 201 + } + } + }, + "com.amazonaws.chatbot#CreateChimeWebhookConfigurationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#CreateChimeWebhookConfigurationRequest": { + "type": "structure", + "members": { + "WebhookDescription": { + "target": "com.amazonaws.chatbot#ChimeWebhookDescription", + "traits": { + "smithy.api#documentation": "Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.", + "smithy.api#required": {} + } + }, + "WebhookUrl": { + "target": "com.amazonaws.chatbot#ChimeWebhookUrl", + "traits": { + "smithy.api#documentation": "URL for the Chime webhook.", + "smithy.api#required": {} + } + }, + "SnsTopicArns": { + "target": "com.amazonaws.chatbot#SnsTopicArnList", + "traits": { + "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot.", + "smithy.api#required": {} + } + }, + "IamRoleArn": { + "target": "com.amazonaws.chatbot#Arn", + "traits": { + "smithy.api#documentation": "This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#required": {} + } + }, + "ConfigurationName": { + "target": "com.amazonaws.chatbot#ConfigurationName", + "traits": { + "smithy.api#documentation": "The name of the configuration.", + "smithy.api#required": {} + } + }, + "LoggingLevel": { + "target": "com.amazonaws.chatbot#CustomerCwLogLevel", + "traits": { + "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#CreateChimeWebhookConfigurationResult": { + "type": "structure", + "members": { + "WebhookConfiguration": { + "target": "com.amazonaws.chatbot#ChimeWebhookConfiguration", + "traits": { + "smithy.api#documentation": "Chime webhook configuration." + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#CreateMicrosoftTeamsChannelConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#CreateTeamsChannelConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#CreateTeamsChannelConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#ConflictException" + }, + { + "target": "com.amazonaws.chatbot#CreateTeamsChannelConfigurationException" + }, + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "Creates MS Teams Channel Configuration", + "smithy.api#http": { + "method": "POST", + "uri": "/create-ms-teams-channel-configuration", + "code": 201 + } + } + }, + "com.amazonaws.chatbot#CreateSlackChannelConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#CreateSlackChannelConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#CreateSlackChannelConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#ConflictException" + }, + { + "target": "com.amazonaws.chatbot#CreateSlackChannelConfigurationException" + }, + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "Creates Slack Channel Configuration", + "smithy.api#http": { + "method": "POST", + "uri": "/create-slack-channel-configuration", + "code": 201 + } + } + }, + "com.amazonaws.chatbot#CreateSlackChannelConfigurationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#CreateSlackChannelConfigurationRequest": { + "type": "structure", + "members": { + "SlackTeamId": { + "target": "com.amazonaws.chatbot#SlackTeamId", + "traits": { + "smithy.api#documentation": "The ID of the Slack workspace authorized with AWS Chatbot.", + "smithy.api#required": {} + } + }, + "SlackChannelId": { + "target": "com.amazonaws.chatbot#SlackChannelId", + "traits": { + "smithy.api#documentation": "The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.", + "smithy.api#required": {} + } + }, + "SlackChannelName": { + "target": "com.amazonaws.chatbot#SlackChannelDisplayName", + "traits": { + "smithy.api#documentation": "The name of the Slack Channel." + } + }, + "SnsTopicArns": { + "target": "com.amazonaws.chatbot#SnsTopicArnList", + "traits": { + "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot." + } + }, + "IamRoleArn": { + "target": "com.amazonaws.chatbot#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#required": {} + } + }, + "ConfigurationName": { + "target": "com.amazonaws.chatbot#ConfigurationName", + "traits": { + "smithy.api#documentation": "The name of the configuration.", + "smithy.api#required": {} + } + }, + "LoggingLevel": { + "target": "com.amazonaws.chatbot#CustomerCwLogLevel", + "traits": { + "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + } + }, + "GuardrailPolicyArns": { + "target": "com.amazonaws.chatbot#GuardrailPolicyArnList", + "traits": { + "smithy.api#documentation": "The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set." + } + }, + "UserAuthorizationRequired": { + "target": "com.amazonaws.chatbot#BooleanAccountPreference", + "traits": { + "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#CreateSlackChannelConfigurationResult": { + "type": "structure", + "members": { + "ChannelConfiguration": { + "target": "com.amazonaws.chatbot#SlackChannelConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for a Slack channel configured with AWS Chatbot." + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#CreateTeamsChannelConfigurationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#CreateTeamsChannelConfigurationRequest": { + "type": "structure", + "members": { + "ChannelId": { + "target": "com.amazonaws.chatbot#TeamsChannelId", + "traits": { + "smithy.api#documentation": "The ID of the Microsoft Teams channel.", + "smithy.api#required": {} + } + }, + "ChannelName": { + "target": "com.amazonaws.chatbot#TeamsChannelName", + "traits": { + "smithy.api#documentation": "The name of the Microsoft Teams channel." + } + }, + "TeamId": { + "target": "com.amazonaws.chatbot#UUID", + "traits": { + "smithy.api#documentation": "The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.", + "smithy.api#required": {} + } + }, + "TeamName": { + "target": "com.amazonaws.chatbot#TeamName", + "traits": { + "smithy.api#documentation": "The name of the Microsoft Teams Team." + } + }, + "TenantId": { + "target": "com.amazonaws.chatbot#UUID", + "traits": { + "smithy.api#documentation": "The ID of the Microsoft Teams tenant.", + "smithy.api#required": {} + } + }, + "SnsTopicArns": { + "target": "com.amazonaws.chatbot#SnsTopicArnList", + "traits": { + "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot." + } + }, + "IamRoleArn": { + "target": "com.amazonaws.chatbot#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#required": {} + } + }, + "ConfigurationName": { + "target": "com.amazonaws.chatbot#ConfigurationName", + "traits": { + "smithy.api#documentation": "The name of the configuration.", + "smithy.api#required": {} + } + }, + "LoggingLevel": { + "target": "com.amazonaws.chatbot#CustomerCwLogLevel", + "traits": { + "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + } + }, + "GuardrailPolicyArns": { + "target": "com.amazonaws.chatbot#GuardrailPolicyArnList", + "traits": { + "smithy.api#documentation": "The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set." + } + }, + "UserAuthorizationRequired": { + "target": "com.amazonaws.chatbot#BooleanAccountPreference", + "traits": { + "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#CreateTeamsChannelConfigurationResult": { + "type": "structure", + "members": { + "ChannelConfiguration": { + "target": "com.amazonaws.chatbot#TeamsChannelConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for a Microsoft Teams channel configured with AWS Chatbot." + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#CustomerCwLogLevel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 5 + }, + "smithy.api#pattern": "^(ERROR|INFO|NONE)$" + } + }, + "com.amazonaws.chatbot#DeleteChimeWebhookConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#DeleteChimeWebhookConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#DeleteChimeWebhookConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#DeleteChimeWebhookConfigurationException" + }, + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a Chime Webhook Configuration", + "smithy.api#http": { + "method": "POST", + "uri": "/delete-chime-webhook-configuration", + "code": 204 + } + } + }, + "com.amazonaws.chatbot#DeleteChimeWebhookConfigurationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#DeleteChimeWebhookConfigurationRequest": { + "type": "structure", + "members": { + "ChatConfigurationArn": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN of the ChimeWebhookConfiguration to delete.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#DeleteChimeWebhookConfigurationResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#DeleteMicrosoftTeamsChannelConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#DeleteTeamsChannelConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#DeleteTeamsChannelConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#DeleteTeamsChannelConfigurationException" + }, + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes MS Teams Channel Configuration", + "smithy.api#http": { + "method": "POST", + "uri": "/delete-ms-teams-channel-configuration", + "code": 204 + } + } + }, + "com.amazonaws.chatbot#DeleteMicrosoftTeamsConfiguredTeam": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#DeleteTeamsConfiguredTeamRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#DeleteTeamsConfiguredTeamResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#DeleteTeamsConfiguredTeamException" + }, + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team. Note that the Microsoft Teams team must have no channels configured to remove it.", + "smithy.api#http": { + "method": "POST", + "uri": "/delete-ms-teams-configured-teams", + "code": 204 + } + } + }, + "com.amazonaws.chatbot#DeleteMicrosoftTeamsUserIdentity": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#DeleteMicrosoftTeamsUserIdentityRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#DeleteMicrosoftTeamsUserIdentityResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#DeleteMicrosoftTeamsUserIdentityException" + }, + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a Teams user identity", + "smithy.api#http": { + "method": "POST", + "uri": "/delete-ms-teams-user-identity", + "code": 204 + } + } + }, + "com.amazonaws.chatbot#DeleteMicrosoftTeamsUserIdentityException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#DeleteMicrosoftTeamsUserIdentityRequest": { + "type": "structure", + "members": { + "ChatConfigurationArn": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.chatbot#UUID", + "traits": { + "smithy.api#documentation": "Id from Microsoft Teams for user.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#DeleteMicrosoftTeamsUserIdentityResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#DeleteSlackChannelConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#DeleteSlackChannelConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#DeleteSlackChannelConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#DeleteSlackChannelConfigurationException" + }, + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes Slack Channel Configuration", + "smithy.api#http": { + "method": "POST", + "uri": "/delete-slack-channel-configuration", + "code": 204 + } + } + }, + "com.amazonaws.chatbot#DeleteSlackChannelConfigurationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#DeleteSlackChannelConfigurationRequest": { + "type": "structure", + "members": { + "ChatConfigurationArn": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN of the SlackChannelConfiguration to delete.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#DeleteSlackChannelConfigurationResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#DeleteSlackUserIdentity": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#DeleteSlackUserIdentityRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#DeleteSlackUserIdentityResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#DeleteSlackUserIdentityException" + }, + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a Slack user identity", + "smithy.api#http": { + "method": "POST", + "uri": "/delete-slack-user-identity", + "code": 204 + } + } + }, + "com.amazonaws.chatbot#DeleteSlackUserIdentityException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#DeleteSlackUserIdentityRequest": { + "type": "structure", + "members": { + "ChatConfigurationArn": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN of the SlackChannelConfiguration associated with the user identity to delete.", + "smithy.api#required": {} + } + }, + "SlackTeamId": { + "target": "com.amazonaws.chatbot#SlackTeamId", + "traits": { + "smithy.api#documentation": "The ID of the Slack workspace authorized with AWS Chatbot.", + "smithy.api#required": {} + } + }, + "SlackUserId": { + "target": "com.amazonaws.chatbot#SlackUserId", + "traits": { + "smithy.api#documentation": "The ID of the user in Slack.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#DeleteSlackUserIdentityResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#DeleteSlackWorkspaceAuthorization": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#DeleteSlackWorkspaceAuthorizationRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#DeleteSlackWorkspaceAuthorizationResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#DeleteSlackWorkspaceAuthorizationFault" + }, + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the Slack workspace authorization that allows channels to be configured in that workspace. This requires all configured channels in the workspace to be deleted.", + "smithy.api#http": { + "method": "POST", + "uri": "/delete-slack-workspace-authorization", + "code": 204 + } + } + }, + "com.amazonaws.chatbot#DeleteSlackWorkspaceAuthorizationFault": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "There was an issue deleting your Slack workspace.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#DeleteSlackWorkspaceAuthorizationRequest": { + "type": "structure", + "members": { + "SlackTeamId": { + "target": "com.amazonaws.chatbot#SlackTeamId", + "traits": { + "smithy.api#documentation": "The ID of the Slack workspace authorized with AWS Chatbot.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#DeleteSlackWorkspaceAuthorizationResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#DeleteTeamsChannelConfigurationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#DeleteTeamsChannelConfigurationRequest": { + "type": "structure", + "members": { + "ChatConfigurationArn": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration to delete.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#DeleteTeamsChannelConfigurationResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#DeleteTeamsConfiguredTeamException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#DeleteTeamsConfiguredTeamRequest": { + "type": "structure", + "members": { + "TeamId": { + "target": "com.amazonaws.chatbot#UUID", + "traits": { + "smithy.api#documentation": "The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#DeleteTeamsConfiguredTeamResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#DescribeChimeWebhookConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#DescribeChimeWebhookConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#DescribeChimeWebhookConfigurationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#DescribeChimeWebhookConfigurationsException" + }, + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Lists Chime Webhook Configurations optionally filtered by ChatConfigurationArn", + "smithy.api#http": { + "method": "POST", + "uri": "/describe-chime-webhook-configurations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chatbot#DescribeChimeWebhookConfigurationsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#DescribeChimeWebhookConfigurationsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.chatbot#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved." + } + }, + "NextToken": { + "target": "com.amazonaws.chatbot#PaginationToken", + "traits": { + "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + } + }, + "ChatConfigurationArn": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "An optional ARN of a ChimeWebhookConfiguration to describe." + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#DescribeChimeWebhookConfigurationsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.chatbot#PaginationToken", + "traits": { + "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + } + }, + "WebhookConfigurations": { + "target": "com.amazonaws.chatbot#ChimeWebhookConfigurationList", + "traits": { + "smithy.api#documentation": "A list of Chime webhooks associated with the account." + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#DescribeSlackChannelConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#DescribeSlackChannelConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#DescribeSlackChannelConfigurationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#DescribeSlackChannelConfigurationsException" + }, + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Lists Slack Channel Configurations optionally filtered by ChatConfigurationArn", + "smithy.api#http": { + "method": "POST", + "uri": "/describe-slack-channel-configurations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chatbot#DescribeSlackChannelConfigurationsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#DescribeSlackChannelConfigurationsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.chatbot#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved." + } + }, + "NextToken": { + "target": "com.amazonaws.chatbot#PaginationToken", + "traits": { + "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + } + }, + "ChatConfigurationArn": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "An optional ARN of a SlackChannelConfiguration to describe." + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#DescribeSlackChannelConfigurationsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.chatbot#PaginationToken", + "traits": { + "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + } + }, + "SlackChannelConfigurations": { + "target": "com.amazonaws.chatbot#SlackChannelConfigurationList", + "traits": { + "smithy.api#documentation": "A list of Slack channel configurations." + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#DescribeSlackUserIdentities": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#DescribeSlackUserIdentitiesRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#DescribeSlackUserIdentitiesResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#DescribeSlackUserIdentitiesException" + }, + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all Slack user identities with a mapped role.", + "smithy.api#http": { + "method": "POST", + "uri": "/describe-slack-user-identities", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chatbot#DescribeSlackUserIdentitiesException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#DescribeSlackUserIdentitiesRequest": { + "type": "structure", + "members": { + "ChatConfigurationArn": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN of the SlackChannelConfiguration associated with the user identities to describe." + } + }, + "NextToken": { + "target": "com.amazonaws.chatbot#PaginationToken", + "traits": { + "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + } + }, + "MaxResults": { + "target": "com.amazonaws.chatbot#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved." + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#DescribeSlackUserIdentitiesResult": { + "type": "structure", + "members": { + "SlackUserIdentities": { + "target": "com.amazonaws.chatbot#SlackUserIdentitiesList", + "traits": { + "smithy.api#documentation": "A list of Slack User Identities." + } + }, + "NextToken": { + "target": "com.amazonaws.chatbot#PaginationToken", + "traits": { + "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#DescribeSlackWorkspaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#DescribeSlackWorkspacesRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#DescribeSlackWorkspacesResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#DescribeSlackWorkspacesException" + }, + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all authorized Slack Workspaces for AWS Account", + "smithy.api#http": { + "method": "POST", + "uri": "/describe-slack-workspaces", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chatbot#DescribeSlackWorkspacesException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#DescribeSlackWorkspacesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.chatbot#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved." + } + }, + "NextToken": { + "target": "com.amazonaws.chatbot#PaginationToken", + "traits": { + "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#DescribeSlackWorkspacesResult": { + "type": "structure", + "members": { + "SlackWorkspaces": { + "target": "com.amazonaws.chatbot#SlackWorkspacesList", + "traits": { + "smithy.api#documentation": "A list of Slack Workspaces registered with AWS Chatbot." + } + }, + "NextToken": { + "target": "com.amazonaws.chatbot#PaginationToken", + "traits": { + "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.chatbot#GetAccountPreferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#GetAccountPreferencesRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#GetAccountPreferencesResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#GetAccountPreferencesException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Get Chatbot account level preferences", + "smithy.api#http": { + "method": "POST", + "uri": "/get-account-preferences", + "code": 200 + } + } + }, + "com.amazonaws.chatbot#GetAccountPreferencesException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#GetAccountPreferencesRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#GetAccountPreferencesResult": { + "type": "structure", + "members": { + "AccountPreferences": { + "target": "com.amazonaws.chatbot#AccountPreferences", + "traits": { + "smithy.api#documentation": "Preferences which apply for AWS Chatbot usage in the calling AWS account." + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#GetMicrosoftTeamsChannelConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#GetTeamsChannelConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#GetTeamsChannelConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#GetTeamsChannelConfigurationException" + }, + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Get a single MS Teams Channel Configurations", + "smithy.api#http": { + "method": "POST", + "uri": "/get-ms-teams-channel-configuration", + "code": 200 + } + } + }, + "com.amazonaws.chatbot#GetTeamsChannelConfigurationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#GetTeamsChannelConfigurationRequest": { + "type": "structure", + "members": { + "ChatConfigurationArn": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration to retrieve.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#GetTeamsChannelConfigurationResult": { + "type": "structure", + "members": { + "ChannelConfiguration": { + "target": "com.amazonaws.chatbot#TeamsChannelConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for a Microsoft Teams channel configured with AWS Chatbot." + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#GuardrailPolicyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 11, + "max": 1163 + }, + "smithy.api#pattern": "^(^$|(?!.*\\/aws-service-role\\/.*)arn:aws:iam:[A-Za-z0-9_\\/.-]{0,63}:[A-Za-z0-9_\\/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_\\/+=,@.-]{0,1023})$" + } + }, + "com.amazonaws.chatbot#GuardrailPolicyArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.chatbot#GuardrailPolicyArn" + } + }, + "com.amazonaws.chatbot#InvalidParameterException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "Your request input doesn't meet the constraints that AWS Chatbot requires.", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.chatbot#InvalidRequestException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "Your request input doesn't meet the constraints that AWS Chatbot requires.", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.chatbot#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "You have exceeded a service limit for AWS Chatbot.", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.chatbot#ListMicrosoftTeamsChannelConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#ListTeamsChannelConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#ListTeamsChannelConfigurationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#ListTeamsChannelConfigurationsException" + } + ], + "traits": { + "smithy.api#documentation": "Lists MS Teams Channel Configurations optionally filtered by TeamId", + "smithy.api#http": { + "method": "POST", + "uri": "/list-ms-teams-channel-configurations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeams": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeamsRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeamsResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeamsException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all authorized MS teams for AWS Account", + "smithy.api#http": { + "method": "POST", + "uri": "/list-ms-teams-configured-teams", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeamsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeamsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.chatbot#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved." + } + }, + "NextToken": { + "target": "com.amazonaws.chatbot#PaginationToken", + "traits": { + "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeamsResult": { + "type": "structure", + "members": { + "ConfiguredTeams": { + "target": "com.amazonaws.chatbot#ConfiguredTeamsList", + "traits": { + "smithy.api#documentation": "A list of teams in Microsoft Teams that have been configured with AWS Chatbot." + } + }, + "NextToken": { + "target": "com.amazonaws.chatbot#PaginationToken", + "traits": { + "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#ListMicrosoftTeamsUserIdentities": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#ListMicrosoftTeamsUserIdentitiesRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#ListMicrosoftTeamsUserIdentitiesResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#ListMicrosoftTeamsUserIdentitiesException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all Microsoft Teams user identities with a mapped role.", + "smithy.api#http": { + "method": "POST", + "uri": "/list-ms-teams-user-identities", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chatbot#ListMicrosoftTeamsUserIdentitiesException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#ListMicrosoftTeamsUserIdentitiesRequest": { + "type": "structure", + "members": { + "ChatConfigurationArn": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identities to list." + } + }, + "NextToken": { + "target": "com.amazonaws.chatbot#PaginationToken", + "traits": { + "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + } + }, + "MaxResults": { + "target": "com.amazonaws.chatbot#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved." + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#ListMicrosoftTeamsUserIdentitiesResult": { + "type": "structure", + "members": { + "TeamsUserIdentities": { + "target": "com.amazonaws.chatbot#TeamsUserIdentitiesList", + "traits": { + "smithy.api#documentation": "User level permissions associated to a channel configuration." + } + }, + "NextToken": { + "target": "com.amazonaws.chatbot#PaginationToken", + "traits": { + "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#ListTeamsChannelConfigurationsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#ListTeamsChannelConfigurationsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.chatbot#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved." + } + }, + "NextToken": { + "target": "com.amazonaws.chatbot#PaginationToken", + "traits": { + "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + } + }, + "TeamId": { + "target": "com.amazonaws.chatbot#UUID", + "traits": { + "smithy.api#documentation": "The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide." + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#ListTeamsChannelConfigurationsResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.chatbot#PaginationToken", + "traits": { + "smithy.api#documentation": "An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults." + } + }, + "TeamChannelConfigurations": { + "target": "com.amazonaws.chatbot#TeamChannelConfigurationsList", + "traits": { + "smithy.api#documentation": "A list of AWS Chatbot channel configurations for Microsoft Teams." + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.chatbot#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1276 + }, + "smithy.api#pattern": "^[a-zA-Z0-9=\\/+_.\\-,#:\\\\\"{}]{4,1276}$" + } + }, + "com.amazonaws.chatbot#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We were not able to find the resource for your request.", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.chatbot#SlackChannelConfiguration": { + "type": "structure", + "members": { + "SlackTeamName": { + "target": "com.amazonaws.chatbot#SlackTeamName", + "traits": { + "smithy.api#documentation": "Name of the Slack Workspace.", + "smithy.api#required": {} + } + }, + "SlackTeamId": { + "target": "com.amazonaws.chatbot#SlackTeamId", + "traits": { + "smithy.api#documentation": "The ID of the Slack workspace authorized with AWS Chatbot.", + "smithy.api#required": {} + } + }, + "SlackChannelId": { + "target": "com.amazonaws.chatbot#SlackChannelId", + "traits": { + "smithy.api#documentation": "The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.", + "smithy.api#required": {} + } + }, + "SlackChannelName": { + "target": "com.amazonaws.chatbot#SlackChannelDisplayName", + "traits": { + "smithy.api#documentation": "The name of the Slack Channel.", + "smithy.api#required": {} + } + }, + "ChatConfigurationArn": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN of the SlackChannelConfiguration.", + "smithy.api#required": {} + } + }, + "IamRoleArn": { + "target": "com.amazonaws.chatbot#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#required": {} + } + }, + "SnsTopicArns": { + "target": "com.amazonaws.chatbot#SnsTopicArnList", + "traits": { + "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot.", + "smithy.api#required": {} + } + }, + "ConfigurationName": { + "target": "com.amazonaws.chatbot#ConfigurationName", + "traits": { + "smithy.api#documentation": "The name of the configuration." + } + }, + "LoggingLevel": { + "target": "com.amazonaws.chatbot#CustomerCwLogLevel", + "traits": { + "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + } + }, + "GuardrailPolicyArns": { + "target": "com.amazonaws.chatbot#GuardrailPolicyArnList", + "traits": { + "smithy.api#documentation": "The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set." + } + }, + "UserAuthorizationRequired": { + "target": "com.amazonaws.chatbot#BooleanAccountPreference", + "traits": { + "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + } + } + }, + "traits": { + "smithy.api#documentation": "An AWS Chatbot configuration for Slack." + } + }, + "com.amazonaws.chatbot#SlackChannelConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.chatbot#SlackChannelConfiguration" + } + }, + "com.amazonaws.chatbot#SlackChannelDisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.chatbot#SlackChannelId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z0-9]+$" + } + }, + "com.amazonaws.chatbot#SlackTeamId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[0-9A-Z]{1,255}$" + } + }, + "com.amazonaws.chatbot#SlackTeamName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.chatbot#SlackUserId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^(.*)$" + } + }, + "com.amazonaws.chatbot#SlackUserIdentitiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.chatbot#SlackUserIdentity" + } + }, + "com.amazonaws.chatbot#SlackUserIdentity": { + "type": "structure", + "members": { + "IamRoleArn": { + "target": "com.amazonaws.chatbot#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#required": {} + } + }, + "ChatConfigurationArn": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN of the SlackChannelConfiguration associated with the user identity.", + "smithy.api#required": {} + } + }, + "SlackTeamId": { + "target": "com.amazonaws.chatbot#SlackTeamId", + "traits": { + "smithy.api#documentation": "The ID of the Slack workspace authorized with AWS Chatbot.", + "smithy.api#required": {} + } + }, + "SlackUserId": { + "target": "com.amazonaws.chatbot#SlackUserId", + "traits": { + "smithy.api#documentation": "The ID of the user in Slack.", + "smithy.api#required": {} + } + }, + "AwsUserIdentity": { + "target": "com.amazonaws.chatbot#AwsUserIdentity", + "traits": { + "smithy.api#documentation": "The AWS user identity ARN used to associate a Slack User Identity with an IAM Role." + } + } + }, + "traits": { + "smithy.api#documentation": "Identifes a User level permission for a channel configuration." + } + }, + "com.amazonaws.chatbot#SlackWorkspace": { + "type": "structure", + "members": { + "SlackTeamId": { + "target": "com.amazonaws.chatbot#SlackTeamId", + "traits": { + "smithy.api#documentation": "The ID of the Slack workspace authorized with AWS Chatbot.", + "smithy.api#required": {} + } + }, + "SlackTeamName": { + "target": "com.amazonaws.chatbot#SlackTeamName", + "traits": { + "smithy.api#documentation": "Name of the Slack Workspace.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A Slack Workspace." + } + }, + "com.amazonaws.chatbot#SlackWorkspacesList": { + "type": "list", + "member": { + "target": "com.amazonaws.chatbot#SlackWorkspace" + } + }, + "com.amazonaws.chatbot#SnsTopicArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.chatbot#Arn" + } + }, + "com.amazonaws.chatbot#String": { + "type": "string" + }, + "com.amazonaws.chatbot#TeamChannelConfigurationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.chatbot#TeamsChannelConfiguration" + } + }, + "com.amazonaws.chatbot#TeamName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^(.*)$" + } + }, + "com.amazonaws.chatbot#TeamsChannelConfiguration": { + "type": "structure", + "members": { + "ChannelId": { + "target": "com.amazonaws.chatbot#TeamsChannelId", + "traits": { + "smithy.api#documentation": "The ID of the Microsoft Teams channel.", + "smithy.api#required": {} + } + }, + "ChannelName": { + "target": "com.amazonaws.chatbot#TeamsChannelName", + "traits": { + "smithy.api#documentation": "The name of the Microsoft Teams channel." + } + }, + "TeamId": { + "target": "com.amazonaws.chatbot#UUID", + "traits": { + "smithy.api#documentation": "The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.", + "smithy.api#required": {} + } + }, + "TeamName": { + "target": "com.amazonaws.chatbot#String", + "traits": { + "smithy.api#documentation": "The name of the Microsoft Teams Team." + } + }, + "TenantId": { + "target": "com.amazonaws.chatbot#UUID", + "traits": { + "smithy.api#documentation": "The ID of the Microsoft Teams tenant.", + "smithy.api#required": {} + } + }, + "ChatConfigurationArn": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration.", + "smithy.api#required": {} + } + }, + "IamRoleArn": { + "target": "com.amazonaws.chatbot#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#required": {} + } + }, + "SnsTopicArns": { + "target": "com.amazonaws.chatbot#SnsTopicArnList", + "traits": { + "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot.", + "smithy.api#required": {} + } + }, + "ConfigurationName": { + "target": "com.amazonaws.chatbot#ConfigurationName", + "traits": { + "smithy.api#documentation": "The name of the configuration." + } + }, + "LoggingLevel": { + "target": "com.amazonaws.chatbot#CustomerCwLogLevel", + "traits": { + "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + } + }, + "GuardrailPolicyArns": { + "target": "com.amazonaws.chatbot#GuardrailPolicyArnList", + "traits": { + "smithy.api#documentation": "The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set." + } + }, + "UserAuthorizationRequired": { + "target": "com.amazonaws.chatbot#BooleanAccountPreference", + "traits": { + "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + } + } + }, + "traits": { + "smithy.api#documentation": "An AWS Chatbot configuration for Microsoft Teams." + } + }, + "com.amazonaws.chatbot#TeamsChannelId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^([a-zA-Z0-9-_=+\\/.,])*%3[aA]([a-zA-Z0-9-_=+\\/.,])*%40([a-zA-Z0-9-_=+\\/.,])*$" + } + }, + "com.amazonaws.chatbot#TeamsChannelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^(.*)$" + } + }, + "com.amazonaws.chatbot#TeamsUserIdentitiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.chatbot#TeamsUserIdentity" + } + }, + "com.amazonaws.chatbot#TeamsUserIdentity": { + "type": "structure", + "members": { + "IamRoleArn": { + "target": "com.amazonaws.chatbot#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.", + "smithy.api#required": {} + } + }, + "ChatConfigurationArn": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity.", + "smithy.api#required": {} + } + }, + "TeamId": { + "target": "com.amazonaws.chatbot#UUID", + "traits": { + "smithy.api#documentation": "The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.chatbot#UUID", + "traits": { + "smithy.api#documentation": "Id from Microsoft Teams for user." + } + }, + "AwsUserIdentity": { + "target": "com.amazonaws.chatbot#AwsUserIdentity", + "traits": { + "smithy.api#documentation": "The AWS user identity ARN used to associate a Microsoft Teams User Identity with an IAM Role." + } + }, + "TeamsChannelId": { + "target": "com.amazonaws.chatbot#TeamsChannelId", + "traits": { + "smithy.api#documentation": "The ID of the Microsoft Teams channel." + } + }, + "TeamsTenantId": { + "target": "com.amazonaws.chatbot#UUID", + "traits": { + "smithy.api#documentation": "The ID of the Microsoft Teams tenant." + } + } + }, + "traits": { + "smithy.api#documentation": "Identifes a user level permission for a channel configuration." + } + }, + "com.amazonaws.chatbot#UUID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$" + } + }, + "com.amazonaws.chatbot#UpdateAccountPreferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#UpdateAccountPreferencesRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#UpdateAccountPreferencesResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#UpdateAccountPreferencesException" + } + ], + "traits": { + "smithy.api#documentation": "Update Chatbot account level preferences", + "smithy.api#http": { + "method": "POST", + "uri": "/update-account-preferences", + "code": 200 + } + } + }, + "com.amazonaws.chatbot#UpdateAccountPreferencesException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#UpdateAccountPreferencesRequest": { + "type": "structure", + "members": { + "UserAuthorizationRequired": { + "target": "com.amazonaws.chatbot#BooleanAccountPreference", + "traits": { + "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + } + }, + "TrainingDataCollectionEnabled": { + "target": "com.amazonaws.chatbot#BooleanAccountPreference", + "traits": { + "smithy.api#documentation": "Turns on training data collection. This helps improve the AWS Chatbot experience by allowing AWS Chatbot to store and use your customer information, such as AWS Chatbot configurations, notifications, user inputs, AWS Chatbot generated responses, and interaction data. This data helps us to continuously improve and develop Artificial Intelligence (AI) technologies. Your data is not shared with any third parties and is protected using sophisticated controls to prevent unauthorized access and misuse. AWS Chatbot does not store or use interactions in chat channels with Amazon Q for training AWS Chatbot’s AI technologies." + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#UpdateAccountPreferencesResult": { + "type": "structure", + "members": { + "AccountPreferences": { + "target": "com.amazonaws.chatbot#AccountPreferences", + "traits": { + "smithy.api#documentation": "Preferences which apply for AWS Chatbot usage in the calling AWS account." + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#UpdateChimeWebhookConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#UpdateChimeWebhookConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#UpdateChimeWebhookConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.chatbot#UpdateChimeWebhookConfigurationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a Chime Webhook Configuration", + "smithy.api#http": { + "method": "POST", + "uri": "/update-chime-webhook-configuration", + "code": 200 + } + } + }, + "com.amazonaws.chatbot#UpdateChimeWebhookConfigurationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#UpdateChimeWebhookConfigurationRequest": { + "type": "structure", + "members": { + "ChatConfigurationArn": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN of the ChimeWebhookConfiguration to update.", + "smithy.api#required": {} + } + }, + "WebhookDescription": { + "target": "com.amazonaws.chatbot#ChimeWebhookDescription", + "traits": { + "smithy.api#documentation": "Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html." + } + }, + "WebhookUrl": { + "target": "com.amazonaws.chatbot#ChimeWebhookUrl", + "traits": { + "smithy.api#documentation": "URL for the Chime webhook." + } + }, + "SnsTopicArns": { + "target": "com.amazonaws.chatbot#SnsTopicArnList", + "traits": { + "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot." + } + }, + "IamRoleArn": { + "target": "com.amazonaws.chatbot#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot." + } + }, + "LoggingLevel": { + "target": "com.amazonaws.chatbot#CustomerCwLogLevel", + "traits": { + "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#UpdateChimeWebhookConfigurationResult": { + "type": "structure", + "members": { + "WebhookConfiguration": { + "target": "com.amazonaws.chatbot#ChimeWebhookConfiguration", + "traits": { + "smithy.api#documentation": "Chime webhook configuration." + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#UpdateMicrosoftTeamsChannelConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#UpdateTeamsChannelConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#UpdateTeamsChannelConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.chatbot#UpdateTeamsChannelConfigurationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates MS Teams Channel Configuration", + "smithy.api#http": { + "method": "POST", + "uri": "/update-ms-teams-channel-configuration", + "code": 200 + } + } + }, + "com.amazonaws.chatbot#UpdateSlackChannelConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.chatbot#UpdateSlackChannelConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.chatbot#UpdateSlackChannelConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.chatbot#InvalidParameterException" + }, + { + "target": "com.amazonaws.chatbot#InvalidRequestException" + }, + { + "target": "com.amazonaws.chatbot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.chatbot#UpdateSlackChannelConfigurationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates Slack Channel Configuration", + "smithy.api#http": { + "method": "POST", + "uri": "/update-slack-channel-configuration", + "code": 200 + } + } + }, + "com.amazonaws.chatbot#UpdateSlackChannelConfigurationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#UpdateSlackChannelConfigurationRequest": { + "type": "structure", + "members": { + "ChatConfigurationArn": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN of the SlackChannelConfiguration to update.", + "smithy.api#required": {} + } + }, + "SlackChannelId": { + "target": "com.amazonaws.chatbot#SlackChannelId", + "traits": { + "smithy.api#documentation": "The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.", + "smithy.api#required": {} + } + }, + "SlackChannelName": { + "target": "com.amazonaws.chatbot#SlackChannelDisplayName", + "traits": { + "smithy.api#documentation": "The name of the Slack Channel." + } + }, + "SnsTopicArns": { + "target": "com.amazonaws.chatbot#SnsTopicArnList", + "traits": { + "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot." + } + }, + "IamRoleArn": { + "target": "com.amazonaws.chatbot#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot." + } + }, + "LoggingLevel": { + "target": "com.amazonaws.chatbot#CustomerCwLogLevel", + "traits": { + "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + } + }, + "GuardrailPolicyArns": { + "target": "com.amazonaws.chatbot#GuardrailPolicyArnList", + "traits": { + "smithy.api#documentation": "The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set." + } + }, + "UserAuthorizationRequired": { + "target": "com.amazonaws.chatbot#BooleanAccountPreference", + "traits": { + "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#UpdateSlackChannelConfigurationResult": { + "type": "structure", + "members": { + "ChannelConfiguration": { + "target": "com.amazonaws.chatbot#SlackChannelConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for a Slack channel configured with AWS Chatbot." + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#UpdateTeamsChannelConfigurationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.chatbot#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "We can’t process your request right now because of a server issue. Try again later.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chatbot#UpdateTeamsChannelConfigurationRequest": { + "type": "structure", + "members": { + "ChatConfigurationArn": { + "target": "com.amazonaws.chatbot#ChatConfigurationArn", + "traits": { + "smithy.api#documentation": "The ARN of the MicrosoftTeamsChannelConfiguration to update.", + "smithy.api#required": {} + } + }, + "ChannelId": { + "target": "com.amazonaws.chatbot#TeamsChannelId", + "traits": { + "smithy.api#documentation": "The ID of the Microsoft Teams channel.", + "smithy.api#required": {} + } + }, + "ChannelName": { + "target": "com.amazonaws.chatbot#TeamsChannelName", + "traits": { + "smithy.api#documentation": "The name of the Microsoft Teams channel." + } + }, + "SnsTopicArns": { + "target": "com.amazonaws.chatbot#SnsTopicArnList", + "traits": { + "smithy.api#documentation": "The ARNs of the SNS topics that deliver notifications to AWS Chatbot." + } + }, + "IamRoleArn": { + "target": "com.amazonaws.chatbot#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot." + } + }, + "LoggingLevel": { + "target": "com.amazonaws.chatbot#CustomerCwLogLevel", + "traits": { + "smithy.api#documentation": "Logging levels include ERROR, INFO, or NONE." + } + }, + "GuardrailPolicyArns": { + "target": "com.amazonaws.chatbot#GuardrailPolicyArnList", + "traits": { + "smithy.api#documentation": "The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied by default if this is not set." + } + }, + "UserAuthorizationRequired": { + "target": "com.amazonaws.chatbot#BooleanAccountPreference", + "traits": { + "smithy.api#documentation": "Enables use of a user role requirement in your chat configuration." + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.chatbot#UpdateTeamsChannelConfigurationResult": { + "type": "structure", + "members": { + "ChannelConfiguration": { + "target": "com.amazonaws.chatbot#TeamsChannelConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for a Microsoft Teams channel configured with AWS Chatbot." + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.chatbot#WheatleyOrchestration_20171011": { + "type": "service", + "version": "2017-10-11", + "operations": [ + { + "target": "com.amazonaws.chatbot#CreateChimeWebhookConfiguration" + }, + { + "target": "com.amazonaws.chatbot#CreateMicrosoftTeamsChannelConfiguration" + }, + { + "target": "com.amazonaws.chatbot#CreateSlackChannelConfiguration" + }, + { + "target": "com.amazonaws.chatbot#DeleteChimeWebhookConfiguration" + }, + { + "target": "com.amazonaws.chatbot#DeleteMicrosoftTeamsChannelConfiguration" + }, + { + "target": "com.amazonaws.chatbot#DeleteMicrosoftTeamsConfiguredTeam" + }, + { + "target": "com.amazonaws.chatbot#DeleteMicrosoftTeamsUserIdentity" + }, + { + "target": "com.amazonaws.chatbot#DeleteSlackChannelConfiguration" + }, + { + "target": "com.amazonaws.chatbot#DeleteSlackUserIdentity" + }, + { + "target": "com.amazonaws.chatbot#DeleteSlackWorkspaceAuthorization" + }, + { + "target": "com.amazonaws.chatbot#DescribeChimeWebhookConfigurations" + }, + { + "target": "com.amazonaws.chatbot#DescribeSlackChannelConfigurations" + }, + { + "target": "com.amazonaws.chatbot#DescribeSlackUserIdentities" + }, + { + "target": "com.amazonaws.chatbot#DescribeSlackWorkspaces" + }, + { + "target": "com.amazonaws.chatbot#GetAccountPreferences" + }, + { + "target": "com.amazonaws.chatbot#GetMicrosoftTeamsChannelConfiguration" + }, + { + "target": "com.amazonaws.chatbot#ListMicrosoftTeamsChannelConfigurations" + }, + { + "target": "com.amazonaws.chatbot#ListMicrosoftTeamsConfiguredTeams" + }, + { + "target": "com.amazonaws.chatbot#ListMicrosoftTeamsUserIdentities" + }, + { + "target": "com.amazonaws.chatbot#UpdateAccountPreferences" + }, + { + "target": "com.amazonaws.chatbot#UpdateChimeWebhookConfiguration" + }, + { + "target": "com.amazonaws.chatbot#UpdateMicrosoftTeamsChannelConfiguration" + }, + { + "target": "com.amazonaws.chatbot#UpdateSlackChannelConfiguration" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "chatbot", + "arnNamespace": "chatbot", + "cloudFormationName": "Chatbot", + "cloudTrailEventSource": "chatbot.amazonaws.com", + "endpointPrefix": "chatbot" + }, + "aws.auth#sigv4": { + "name": "chatbot" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "AWS Chatbot API", + "smithy.api#title": "chatbot", + "smithy.api#xmlNamespace": { + "uri": "http://wheatley.amazonaws.com/orchestration/2017-10-11/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://chatbot-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://chatbot-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://chatbot.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://chatbot.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://chatbot-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chatbot-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://chatbot.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chatbot.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://chatbot-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chatbot-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://chatbot.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chatbot.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://chatbot-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chatbot-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://chatbot.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chatbot.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "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 + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chatbot-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chatbot.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "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 + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chatbot-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://chatbot.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "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" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + } + } +} diff --git a/codegen/sdk/aws-models/config-service.json b/codegen/sdk/aws-models/config-service.json index f926744760c..949ede5b361 100644 --- a/codegen/sdk/aws-models/config-service.json +++ b/codegen/sdk/aws-models/config-service.json @@ -4625,7 +4625,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of organization Config rules.

\n \n

When you specify the limit and the next token, you receive a paginated response.

\n

Limit and next token are not applicable if you specify organization Config rule names. \n\t\t\tIt is only applicable, when you request all the organization Config rules.

\n

\n For accounts within an organzation\n

\n

If you deploy an organizational rule or conformance pack in an organization\n\t\t\t\tadministrator account, and then establish a delegated administrator and deploy an\n\t\t\t\torganizational rule or conformance pack in the delegated administrator account, you\n\t\t\t\twon't be able to see the organizational rule or conformance pack in the organization\n\t\t\t\tadministrator account from the delegated administrator account or see the organizational\n\t\t\t\trule or conformance pack in the delegated administrator account from organization\n\t\t\t\tadministrator account. The DescribeOrganizationConfigRules and \n\t\t\t\tDescribeOrganizationConformancePacks APIs can only see and interact with\n\t\t\t\tthe organization-related resource that were deployed from within the account calling\n\t\t\t\tthose APIs.

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

Returns a list of organization Config rules.

\n \n

When you specify the limit and the next token, you receive a paginated response.

\n

Limit and next token are not applicable if you specify organization Config rule names. \n\t\t\tIt is only applicable, when you request all the organization Config rules.

\n

\n For accounts within an organization\n

\n

If you deploy an organizational rule or conformance pack in an organization\n\t\t\t\tadministrator account, and then establish a delegated administrator and deploy an\n\t\t\t\torganizational rule or conformance pack in the delegated administrator account, you\n\t\t\t\twon't be able to see the organizational rule or conformance pack in the organization\n\t\t\t\tadministrator account from the delegated administrator account or see the organizational\n\t\t\t\trule or conformance pack in the delegated administrator account from organization\n\t\t\t\tadministrator account. The DescribeOrganizationConfigRules and \n\t\t\t\tDescribeOrganizationConformancePacks APIs can only see and interact with\n\t\t\t\tthe organization-related resource that were deployed from within the account calling\n\t\t\t\tthose APIs.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4783,7 +4783,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of organization conformance packs.

\n \n

When you specify the limit and the next token, you receive a paginated response.

\n

Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable,\n\t\t\twhen you request all the organization conformance packs.

\n

\n For accounts within an organzation\n

\n

If you deploy an organizational rule or conformance pack in an organization\n\t\t\t\tadministrator account, and then establish a delegated administrator and deploy an\n\t\t\t\torganizational rule or conformance pack in the delegated administrator account, you\n\t\t\t\twon't be able to see the organizational rule or conformance pack in the organization\n\t\t\t\tadministrator account from the delegated administrator account or see the organizational\n\t\t\t\trule or conformance pack in the delegated administrator account from organization\n\t\t\t\tadministrator account. The DescribeOrganizationConfigRules and \n\t\t\t\tDescribeOrganizationConformancePacks APIs can only see and interact with\n\t\t\t\tthe organization-related resource that were deployed from within the account calling\n\t\t\t\tthose APIs.

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

Returns a list of organization conformance packs.

\n \n

When you specify the limit and the next token, you receive a paginated response.

\n

Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable,\n\t\t\twhen you request all the organization conformance packs.

\n

\n For accounts within an organization\n

\n

If you deploy an organizational rule or conformance pack in an organization\n\t\t\t\tadministrator account, and then establish a delegated administrator and deploy an\n\t\t\t\torganizational rule or conformance pack in the delegated administrator account, you\n\t\t\t\twon't be able to see the organizational rule or conformance pack in the organization\n\t\t\t\tadministrator account from the delegated administrator account or see the organizational\n\t\t\t\trule or conformance pack in the delegated administrator account from organization\n\t\t\t\tadministrator account. The DescribeOrganizationConfigRules and \n\t\t\t\tDescribeOrganizationConformancePacks APIs can only see and interact with\n\t\t\t\tthe organization-related resource that were deployed from within the account calling\n\t\t\t\tthose APIs.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5507,7 +5507,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies whether the configuration recorder excludes certain resource types from being recorded.\n\t\t\tUse the resourceTypes field to enter a comma-separated list of resource types you want to exclude from recording.

\n

By default, when Config adds support for a new resource type in the Region where you set up the configuration recorder,\n\t\t\tincluding global resource types, Config starts recording resources of that type automatically.

\n \n

\n How to use the exclusion recording strategy \n

\n

To use this option, you must set the useOnly\n\t\t\t\tfield of RecordingStrategy\n\t\t\t\tto EXCLUSION_BY_RESOURCE_TYPES.

\n

Config will then record configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded.

\n

\n Global resource types and the exclusion recording strategy \n

\n

Unless specifically listed as exclusions,\n\t\t\t\tAWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.

\n

IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022.\n\t\t\t\tYou cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

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

Specifies whether the configuration recorder excludes certain resource types from being recorded.\n\t\t\tUse the resourceTypes field to enter a comma-separated list of resource types you want to exclude from recording.

\n

By default, when Config adds support for a new resource type in the Region where you set up the configuration recorder,\n\t\t\tincluding global resource types, Config starts recording resources of that type automatically.

\n \n

\n How to use the exclusion recording strategy \n

\n

To use this option, you must set the useOnly\n\t\t\t\tfield of RecordingStrategy\n\t\t\t\tto EXCLUSION_BY_RESOURCE_TYPES.

\n

Config will then record configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded.

\n

\n Global resource types and the exclusion recording strategy \n

\n

Unless specifically listed as exclusions,\n\t\t\t\tAWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.

\n

IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022.\n\t\t\t\tYou cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

\n \n " } }, "com.amazonaws.configservice#ExecutionControls": { @@ -10280,7 +10280,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or updates the remediation configuration with a specific Config rule with the \n\t\t\tselected target or action. \n\t\t\tThe API creates the RemediationConfiguration object for the Config rule. \n\t\tThe Config rule must already exist for you to add a remediation configuration. \n\t\tThe target (SSM document) must exist and have permissions to use the target.

\n \n

If you make backward incompatible changes to the SSM document, \n\t\t\tyou must call this again to ensure the remediations can run.

\n

This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, \n\t\t\t\tthe rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.

\n \n \n

For manual remediation configuration, you need to provide a value for automationAssumeRole or use a value in the assumeRolefield to remediate your resources. The SSM automation document can use either as long as it maps to a valid parameter.

\n

However, for automatic remediation configuration, the only valid assumeRole field value is AutomationAssumeRole and you need to provide a value for AutomationAssumeRole to remediate your resources.

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

Adds or updates the remediation configuration with a specific Config rule with the \n\t\t\tselected target or action. \n\t\t\tThe API creates the RemediationConfiguration object for the Config rule. \n\t\tThe Config rule must already exist for you to add a remediation configuration. \n\t\tThe target (SSM document) must exist and have permissions to use the target.

\n \n

\n Be aware of backward incompatible changes\n

\n

If you make backward incompatible changes to the SSM document, \n\t\t\tyou must call this again to ensure the remediations can run.

\n

This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, \n\t\t\t\tthe rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.

\n \n \n

\n Required fields\n

\n

For manual remediation configuration, you need to provide a value for automationAssumeRole or use a value in the assumeRolefield to remediate your resources. The SSM automation document can use either as long as it maps to a valid parameter.

\n

However, for automatic remediation configuration, the only valid assumeRole field value is AutomationAssumeRole and you need to provide a value for AutomationAssumeRole to remediate your resources.

\n \n \n

\n Auto remediation can be initiated even for compliant resources\n

\n

If you enable auto remediation for a specific Config rule using the PutRemediationConfigurations API or the Config console,\n\t\t\t\tit initiates the remediation process for all non-compliant resources for that specific rule.\n\t\t\t\tThe auto remediation process relies on the compliance data snapshot which is captured on a periodic basis.\n\t\t\t\tAny non-compliant resource that is updated between the snapshot schedule will continue to be remediated based on the last known compliance data snapshot.

\n

This means that in some cases auto remediation can be initiated even for compliant resources, since the bootstrap processor uses a database that can have stale evaluation results based on the last known compliance data snapshot.

\n " } }, "com.amazonaws.configservice#PutRemediationConfigurationsRequest": { @@ -10329,7 +10329,7 @@ } ], "traits": { - "smithy.api#documentation": "

A remediation exception is when a specified resource is no longer considered for auto-remediation. \n\t\t\tThis API adds a new exception or updates an existing exception for a specified resource with a specified Config rule.

\n \n

Config generates a remediation exception when a problem occurs running a remediation action for a specified resource. \n\t\t\tRemediation exceptions blocks auto-remediation until the exception is cleared.

\n \n \n

When placing an exception on an Amazon Web Services resource, it is recommended that remediation is set as manual remediation until\n\t\t\tthe given Config rule for the specified resource evaluates the resource as NON_COMPLIANT.\n\t\t\tOnce the resource has been evaluated as NON_COMPLIANT, you can add remediation exceptions and change the remediation type back from Manual to Auto if you want to use auto-remediation.\n\t\t\tOtherwise, using auto-remediation before a NON_COMPLIANT evaluation result can delete resources before the exception is applied.

\n \n \n

Placing an exception can only be performed on resources that are NON_COMPLIANT.\n\t\t\tIf you use this API for COMPLIANT resources or resources that are NOT_APPLICABLE, a remediation exception will not be generated.\n\t\t\tFor more information on the conditions that initiate the possible Config evaluation results,\n\t\t\tsee Concepts | Config Rules in the Config Developer Guide.

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

A remediation exception is when a specified resource is no longer considered for auto-remediation. \n\t\t\tThis API adds a new exception or updates an existing exception for a specified resource with a specified Config rule.

\n \n

\n Exceptions block auto remediation\n

\n

Config generates a remediation exception when a problem occurs running a remediation action for a specified resource. \n\t\t\tRemediation exceptions blocks auto-remediation until the exception is cleared.

\n \n \n

\n Manual remediation is recommended when placing an exception\n

\n

When placing an exception on an Amazon Web Services resource, it is recommended that remediation is set as manual remediation until\n\t\t\tthe given Config rule for the specified resource evaluates the resource as NON_COMPLIANT.\n\t\t\tOnce the resource has been evaluated as NON_COMPLIANT, you can add remediation exceptions and change the remediation type back from Manual to Auto if you want to use auto-remediation.\n\t\t\tOtherwise, using auto-remediation before a NON_COMPLIANT evaluation result can delete resources before the exception is applied.

\n \n \n

\n Exceptions can only be performed on non-compliant resources\n

\n

Placing an exception can only be performed on resources that are NON_COMPLIANT.\n\t\t\tIf you use this API for COMPLIANT resources or resources that are NOT_APPLICABLE, a remediation exception will not be generated.\n\t\t\tFor more information on the conditions that initiate the possible Config evaluation results,\n\t\t\tsee Concepts | Config Rules in the Config Developer Guide.

\n \n \n

\n Auto remediation can be initiated even for compliant resources\n

\n

If you enable auto remediation for a specific Config rule using the PutRemediationConfigurations API or the Config console,\n\t\t\t\tit initiates the remediation process for all non-compliant resources for that specific rule.\n\t\t\t\tThe auto remediation process relies on the compliance data snapshot which is captured on a periodic basis.\n\t\t\t\tAny non-compliant resource that is updated between the snapshot schedule will continue to be remediated based on the last known compliance data snapshot.

\n

This means that in some cases auto remediation can be initiated even for compliant resources, since the bootstrap processor uses a database that can have stale evaluation results based on the last known compliance data snapshot.

\n " } }, "com.amazonaws.configservice#PutRemediationExceptionsRequest": { @@ -10688,7 +10688,7 @@ "target": "com.amazonaws.configservice#IncludeGlobalResourceTypes", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

This option is a bundle which only applies to the global IAM resource types:\n\t\t\tIAM users, groups, roles, and customer managed policies. These global IAM resource types can only be recorded\n\t\t\tby Config in Regions where Config was available before February 2022.\n\t\t\tYou cannot be record the global IAM resouce types in Regions supported by Config after February 2022.\n\t\t\tThis list where you cannot record the global IAM resource types includes the following Regions:

\n \n \n

\n Aurora global clusters are recorded in all enabled Regions\n

\n

The AWS::RDS::GlobalCluster resource type will be recorded in all supported Config Regions where the configuration recorder is enabled, even if includeGlobalResourceTypes is not set to true.\n\t\t\t\tThe includeGlobalResourceTypes option is a bundle which only applies to IAM users, groups, roles, and customer managed policies.\n\t\t\t

\n

If you do not want to record AWS::RDS::GlobalCluster in all enabled Regions, use one of the following recording strategies:

\n
    \n
  1. \n

    \n Record all current and future resource types with exclusions (EXCLUSION_BY_RESOURCE_TYPES), or

    \n
    2. \n
  2. \n

    \n Record specific resource types (INCLUSION_BY_RESOURCE_TYPES).

    \n
    3. \n
\n

For more information, see Selecting Which Resources are Recorded in the Config developer guide.

\n \n \n

Before you set this field to true,\n\t\t\tset the allSupported field of RecordingGroup to\n\t\t\ttrue. Optionally, you can set the useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES.

\n \n \n

\n Overriding fields\n

\n

If you set this field to false but list global IAM resource types in the resourceTypes field of RecordingGroup,\n\t\t\tConfig will still record configuration changes for those specified resource types regardless of if you set the includeGlobalResourceTypes field to false.

\n

If you do not want to record configuration changes to the global IAM resource types (IAM users, groups, roles, and customer managed policies), make sure to not list them in the resourceTypes field\n\t\t\tin addition to setting the includeGlobalResourceTypes field to false.

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

This option is a bundle which only applies to the global IAM resource types:\n\t\t\tIAM users, groups, roles, and customer managed policies. These global IAM resource types can only be recorded\n\t\t\tby Config in Regions where Config was available before February 2022.\n\t\t\tYou cannot be record the global IAM resouce types in Regions supported by Config after February 2022.\n\t\t\tThis list where you cannot record the global IAM resource types includes the following Regions:

\n \n \n

\n Aurora global clusters are recorded in all enabled Regions\n

\n

The AWS::RDS::GlobalCluster resource type will be recorded in all supported Config Regions where the configuration recorder is enabled, even if includeGlobalResourceTypes is setfalse.\n\t\t\t\tThe includeGlobalResourceTypes option is a bundle which only applies to IAM users, groups, roles, and customer managed policies.\n\t\t\t

\n

If you do not want to record AWS::RDS::GlobalCluster in all enabled Regions, use one of the following recording strategies:

\n
    \n
  1. \n

    \n Record all current and future resource types with exclusions (EXCLUSION_BY_RESOURCE_TYPES), or

    \n
    2. \n
  2. \n

    \n Record specific resource types (INCLUSION_BY_RESOURCE_TYPES).

    \n
    3. \n
\n

For more information, see Selecting Which Resources are Recorded in the Config developer guide.

\n \n \n

\n includeGlobalResourceTypes and the exclusion recording strategy\n

\n

The includeGlobalResourceTypes field has no impact on the EXCLUSION_BY_RESOURCE_TYPES recording strategy.\n\t\t\t\tThis means that the global IAM resource types (IAM users, groups, roles, and customer managed policies) will\n\t\t\t\tnot be automatically added as exclusions for exclusionByResourceTypes when includeGlobalResourceTypes is set to false.

\n

The includeGlobalResourceTypes field should only be used to modify the AllSupported field, as the default for\n\t\t\t\tthe AllSupported field is to record configuration changes for all supported resource types excluding the global\n\t\t\t\tIAM resource types. To include the global IAM resource types when AllSupported is set to true, make sure to set includeGlobalResourceTypes to true.

\n

To exclude the global IAM resource types for the EXCLUSION_BY_RESOURCE_TYPES recording strategy, you need to manually add them to the resourceTypes field of exclusionByResourceTypes.

\n \n \n

\n Required and optional fields\n

\n

Before you set this field to true,\n\t\t\tset the allSupported field of RecordingGroup to\n\t\t\ttrue. Optionally, you can set the useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES.

\n \n \n

\n Overriding fields\n

\n

If you set this field to false but list global IAM resource types in the resourceTypes field of RecordingGroup,\n\t\t\tConfig will still record configuration changes for those specified resource types regardless of if you set the includeGlobalResourceTypes field to false.

\n

If you do not want to record configuration changes to the global IAM resource types (IAM users, groups, roles, and customer managed policies), make sure to not list them in the resourceTypes field\n\t\t\tin addition to setting the includeGlobalResourceTypes field to false.

\n " } }, "resourceTypes": { @@ -10706,7 +10706,7 @@ "recordingStrategy": { "target": "com.amazonaws.configservice#RecordingStrategy", "traits": { - "smithy.api#documentation": "

An object that specifies the recording strategy for the configuration recorder.

\n \n \n

\n Required and optional fields\n

\n

The recordingStrategy field is optional when you set the\n\t\t\tallSupported field of RecordingGroup to true.

\n

The recordingStrategy field is optional when you list resource types in the\n\t\t\t\tresourceTypes field of RecordingGroup.

\n

The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.

\n \n \n

\n Overriding fields\n

\n

If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.

\n

For example, even if you set includeGlobalResourceTypes to false, global IAM resource types will still be automatically\n\t\t\trecorded in this option unless those resource types are specifically listed as exclusions in the resourceTypes field of exclusionByResourceTypes.

\n \n \n

\n Global resources types and the resource exclusion recording strategy\n

\n

By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy,\n\t\t\twhen Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types,\n\t\t\tConfig starts recording resources of that type automatically.

\n

Unless specifically listed as exclusions,\n\t\t\t\tAWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.

\n

IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022.\n\t\t\t\tYou cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

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

An object that specifies the recording strategy for the configuration recorder.

\n \n \n

\n Required and optional fields\n

\n

The recordingStrategy field is optional when you set the\n\t\t\tallSupported field of RecordingGroup to true.

\n

The recordingStrategy field is optional when you list resource types in the\n\t\t\t\tresourceTypes field of RecordingGroup.

\n

The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.

\n \n \n

\n Overriding fields\n

\n

If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.

\n

For example, even if you set includeGlobalResourceTypes to false, global IAM resource types will still be automatically\n\t\t\trecorded in this option unless those resource types are specifically listed as exclusions in the resourceTypes field of exclusionByResourceTypes.

\n \n \n

\n Global resources types and the resource exclusion recording strategy\n

\n

By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy,\n\t\t\twhen Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types,\n\t\t\tConfig starts recording resources of that type automatically.

\n

Unless specifically listed as exclusions,\n\t\t\t\tAWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.

\n

IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022.\n\t\t\t\tYou cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

\n \n " } } }, @@ -10787,7 +10787,7 @@ "useOnly": { "target": "com.amazonaws.configservice#RecordingStrategyType", "traits": { - "smithy.api#documentation": "

The recording strategy for the configuration recorder.

\n \n \n

\n Required and optional fields\n

\n

The recordingStrategy field is optional when you set the\n\t\t\tallSupported field of RecordingGroup to true.

\n

The recordingStrategy field is optional when you list resource types in the\n\t\t\t\tresourceTypes field of RecordingGroup.

\n

The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.

\n \n \n

\n Overriding fields\n

\n

If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.

\n

For example, even if you set includeGlobalResourceTypes to false, global IAM resource types will still be automatically\n\t\t\trecorded in this option unless those resource types are specifically listed as exclusions in the resourceTypes field of exclusionByResourceTypes.

\n \n \n

\n Global resource types and the exclusion recording strategy\n

\n

By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy,\n\t\t\t\twhen Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types,\n\t\t\t\tConfig starts recording resources of that type automatically.

\n

Unless specifically listed as exclusions,\n\t\t\t\tAWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.

\n

IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022.\n\t\t\t\tYou cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

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

The recording strategy for the configuration recorder.

\n \n \n

\n Required and optional fields\n

\n

The recordingStrategy field is optional when you set the\n\t\t\tallSupported field of RecordingGroup to true.

\n

The recordingStrategy field is optional when you list resource types in the\n\t\t\t\tresourceTypes field of RecordingGroup.

\n

The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.

\n \n \n

\n Overriding fields\n

\n

If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.

\n

For example, even if you set includeGlobalResourceTypes to false, global IAM resource types will still be automatically\n\t\t\trecorded in this option unless those resource types are specifically listed as exclusions in the resourceTypes field of exclusionByResourceTypes.

\n \n \n

\n Global resource types and the exclusion recording strategy\n

\n

By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy,\n\t\t\t\twhen Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types,\n\t\t\t\tConfig starts recording resources of that type automatically.

\n

Unless specifically listed as exclusions,\n\t\t\t\tAWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.

\n

IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022.\n\t\t\t\tYou cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

\n \n " } } }, @@ -16563,7 +16563,7 @@ "DocumentName": { "target": "com.amazonaws.configservice#SSMDocumentName", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack.\n\t\t\tIf you use the document name, Config checks only your account and Amazon Web Services Region for the SSM document. If you want to use an SSM document from another Region or account, you must provide the ARN.

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

The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack.\n\t\t\tIf you use the document name, Config checks only your account and Amazon Web Services Region for the SSM document.

", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/dynamodb.json b/codegen/sdk/aws-models/dynamodb.json index 803f6d0f4bb..b9f38b80d5d 100644 --- a/codegen/sdk/aws-models/dynamodb.json +++ b/codegen/sdk/aws-models/dynamodb.json @@ -3732,6 +3732,9 @@ }, "aws.protocols#awsJson1_0": {}, "smithy.api#documentation": "Amazon DynamoDB\n

Amazon DynamoDB is a fully managed NoSQL database service that provides fast\n and predictable performance with seamless scalability. DynamoDB lets you\n offload the administrative burdens of operating and scaling a distributed database, so\n that you don't have to worry about hardware provisioning, setup and configuration,\n replication, software patching, or cluster scaling.

\n

With DynamoDB, you can create database tables that can store and retrieve\n any amount of data, and serve any level of request traffic. You can scale up or scale\n down your tables' throughput capacity without downtime or performance degradation, and\n use the Amazon Web Services Management Console to monitor resource utilization and performance\n metrics.

\n

DynamoDB automatically spreads the data and traffic for your tables over\n a sufficient number of servers to handle your throughput and storage requirements, while\n maintaining consistent and fast performance. All of your data is stored on solid state\n disks (SSDs) and automatically replicated across multiple Availability Zones in an\n Amazon Web Services Region, providing built-in high availability and data\n durability.

", + "smithy.api#suppress": [ + "RuleSetAwsBuiltIn.AWS::Auth::AccountId" + ], "smithy.api#title": "Amazon DynamoDB", "smithy.api#xmlNamespace": { "uri": "http://dynamodb.amazonaws.com/doc/2012-08-10/" @@ -11975,7 +11978,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB\n Streams settings for a given table.

\n \n

This operation only applies to Version 2019.11.21 (Current) \n of global tables.\n

\n \n

You can only perform one of the following operations at once:

\n \n

\n UpdateTable is an asynchronous operation; while it is executing, the table\n status changes from ACTIVE to UPDATING. While it is\n UPDATING, you cannot issue another UpdateTable request.\n When the table returns to the ACTIVE state, the UpdateTable\n operation is complete.

" + "smithy.api#documentation": "

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB\n Streams settings for a given table.

\n \n

This operation only applies to Version 2019.11.21 (Current) \n of global tables.\n

\n \n

You can only perform one of the following operations at once:

\n \n

\n UpdateTable is an asynchronous operation; while\n it's\n executing, the table status changes from ACTIVE to UPDATING.\n While it's UPDATING, you can't issue another UpdateTable\n request on the\n base table nor any replicas. When the table returns to the\n ACTIVE state, the UpdateTable operation is\n complete.

" } }, "com.amazonaws.dynamodb#UpdateTableInput": { diff --git a/codegen/sdk/aws-models/ivs.json b/codegen/sdk/aws-models/ivs.json index 3bfb89710a7..1492749818f 100644 --- a/codegen/sdk/aws-models/ivs.json +++ b/codegen/sdk/aws-models/ivs.json @@ -1185,7 +1185,7 @@ "latencyMode": { "target": "com.amazonaws.ivs#ChannelLatencyMode", "traits": { - "smithy.api#documentation": "

Channel latency mode. Use NORMAL to broadcast and deliver live video up to\n Full HD. Use LOW for near-real-time interaction with viewers. Default:\n LOW. (Note: In the Amazon IVS console, LOW and NORMAL\n correspond to Ultra-low and Standard, respectively.)

" + "smithy.api#documentation": "

Channel latency mode. Use NORMAL to broadcast and deliver live video up to\n Full HD. Use LOW for near-real-time interaction with viewers. Default:\n LOW.

" } }, "type": { @@ -1356,7 +1356,7 @@ "latencyMode": { "target": "com.amazonaws.ivs#ChannelLatencyMode", "traits": { - "smithy.api#documentation": "

Channel latency mode. Use NORMAL to broadcast and deliver live video up to\n Full HD. Use LOW for near-real-time interaction with viewers. Default:\n LOW. (Note: In the Amazon IVS console, LOW and NORMAL\n correspond to Ultra-low and Standard, respectively.)

" + "smithy.api#documentation": "

Channel latency mode. Use NORMAL to broadcast and deliver live video up to\n Full HD. Use LOW for near-real-time interaction with viewers. Default:\n LOW.

" } }, "authorized": { @@ -1504,7 +1504,7 @@ "latencyMode": { "target": "com.amazonaws.ivs#ChannelLatencyMode", "traits": { - "smithy.api#documentation": "

Channel latency mode. Use NORMAL to broadcast and deliver live video up to\n Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the\n Amazon IVS console, LOW and NORMAL correspond to Ultra-low and\n Standard, respectively.) Default: LOW.

" + "smithy.api#documentation": "

Channel latency mode. Use NORMAL to broadcast and deliver live video up to\n Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.

" } }, "type": { @@ -4673,7 +4673,7 @@ "latencyMode": { "target": "com.amazonaws.ivs#ChannelLatencyMode", "traits": { - "smithy.api#documentation": "

Channel latency mode. Use NORMAL to broadcast and deliver live video up to\n Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the\n Amazon IVS console, LOW and NORMAL correspond to Ultra-low and\n Standard, respectively.)

" + "smithy.api#documentation": "

Channel latency mode. Use NORMAL to broadcast and deliver live video up to\n Full HD. Use LOW for near-real-time interaction with viewers.

" } }, "type": { diff --git a/codegen/sdk/aws-models/keyspaces.json b/codegen/sdk/aws-models/keyspaces.json index 0c024d5c0ca..663b39ae1e3 100644 --- a/codegen/sdk/aws-models/keyspaces.json +++ b/codegen/sdk/aws-models/keyspaces.json @@ -75,7 +75,7 @@ } }, "traits": { - "smithy.api#documentation": "

The optional auto scaling settings for a table with provisioned throughput capacity.

\n

To turn on auto scaling for a table in throughputMode:PROVISIONED, \n you must specify the following parameters.

\n

Configure the minimum and maximum units for write and read capacity. The auto scaling policy ensures that capacity never goes below the \n minimum or above the maximum range.

\n \n

For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

The optional auto scaling settings for a table with provisioned throughput capacity.

\n

To turn on auto scaling for a table in throughputMode:PROVISIONED, \n you must specify the following parameters.

\n

Configure the minimum and maximum capacity units. The auto scaling policy ensures that\n capacity never goes below the minimum or above the maximum range.

\n \n

For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer\n Guide.

" } }, "com.amazonaws.keyspaces#AutoScalingSpecification": { @@ -95,7 +95,7 @@ } }, "traits": { - "smithy.api#documentation": "

The optional auto scaling settings for read and write capacity of a table in provisioned capacity mode.

" + "smithy.api#documentation": "

The optional auto scaling capacity settings for a table in provisioned capacity mode.

" } }, "com.amazonaws.keyspaces#BooleanObject": { @@ -466,7 +466,7 @@ "autoScalingSpecification": { "target": "com.amazonaws.keyspaces#AutoScalingSpecification", "traits": { - "smithy.api#documentation": "

The optional auto scaling settings for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity \n automatically on your behalf.

\n

Auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing \n your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer\n Guide.

\n

By default, auto scaling is disabled for a table.

" + "smithy.api#documentation": "

The optional auto scaling settings for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity \n automatically on your behalf.

\n

Auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing \n your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer\n Guide.

\n

By default, auto scaling is disabled for a table.

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

Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the \n Amazon Web Services Region specific auto scaling settings of the table are included.

\n

Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing \n your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer\n Guide.

" + "smithy.api#documentation": "

Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the \n Amazon Web Services Region specific auto scaling settings of the table are included.

\n

Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing \n your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer\n Guide.

\n \n

\n GetTableAutoScalingSettings can't be used as an action in an IAM policy.

\n \n

To define permissions for GetTableAutoScalingSettings, you must allow the following two actions in the IAM policy statement's \n Action element:

\n " } }, "com.amazonaws.keyspaces#GetTableAutoScalingSettingsRequest": { diff --git a/codegen/sdk/aws-models/lambda.json b/codegen/sdk/aws-models/lambda.json index fefe7524719..ba2cafd1339 100644 --- a/codegen/sdk/aws-models/lambda.json +++ b/codegen/sdk/aws-models/lambda.json @@ -3998,7 +3998,7 @@ "DestinationConfig": { "target": "com.amazonaws.lambda#DestinationConfig", "traits": { - "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

" + "smithy.api#documentation": "

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.

" } }, "Topics": { @@ -8667,7 +8667,7 @@ "Destination": { "target": "com.amazonaws.lambda#DestinationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination resource.

\n

To retain records of asynchronous invocations,\n you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function,\n or Amazon EventBridge event bus as the destination.

\n

To retain records of failed invocations from Kinesis and\n DynamoDB event sources, you can configure an Amazon SNS topic or\n Amazon SQS queue as the destination.

\n

To retain records of failed invocations from self-managed Kafka or\n Amazon MSK,\n you can configure an Amazon SNS topic or Amazon SQS queue as the destination.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination resource.

\n

To retain records of asynchronous invocations,\n you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function,\n or Amazon EventBridge event bus as the destination.

\n

To retain records of failed invocations from Kinesis and\n DynamoDB event sources, you can configure an Amazon SNS topic or\n Amazon SQS queue as the destination.

\n

To retain records of failed invocations from self-managed Kafka or\n Amazon MSK,\n you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.

" } } }, @@ -9999,6 +9999,12 @@ "smithy.api#enumValue": "dotnet6" } }, + "dotnet8": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dotnet8" + } + }, "nodejs43edge": { "target": "smithy.api#Unit", "traits": { diff --git a/codegen/sdk/aws-models/mediatailor.json b/codegen/sdk/aws-models/mediatailor.json index 95d76c2788b..0645faf66ce 100644 --- a/codegen/sdk/aws-models/mediatailor.json +++ b/codegen/sdk/aws-models/mediatailor.json @@ -57,7 +57,8 @@ "target": "com.amazonaws.mediatailor#__long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.

" + "smithy.api#documentation": "

How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.

", + "smithy.api#required": {} } }, "Slate": { diff --git a/codegen/sdk/packages.json b/codegen/sdk/packages.json index 35f2326f1df..1637843a782 100644 --- a/codegen/sdk/packages.json +++ b/codegen/sdk/packages.json @@ -2094,6 +2094,12 @@ "artifactName": "billingconductor", "brazilName": "AwsSdkKotlinBillingconductor" }, + { + "sdkId": "chatbot", + "namespace": "aws.sdk.kotlin.services.chatbot", + "artifactName": "chatbot", + "brazilName": "AwsSdkKotlinChatbot" + }, { "sdkId": "codeartifact", "namespace": "aws.sdk.kotlin.services.codeartifact", diff --git a/gradle.properties b/gradle.properties index 2c4c9881bc8..3d0eda541ea 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.60-SNAPSHOT +sdkVersion=1.0.62-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 37c2af98f90..88a30d55c61 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -9,8 +9,8 @@ coroutines-version = "1.7.3" atomicfu-version = "0.23.1" # smithy-kotlin codegen and runtime are versioned separately -smithy-kotlin-runtime-version = "1.0.15-SNAPSHOT" -smithy-kotlin-codegen-version = "0.30.16-SNAPSHOT" +smithy-kotlin-runtime-version = "1.0.16-SNAPSHOT" +smithy-kotlin-codegen-version = "0.30.17-SNAPSHOT" # codegen smithy-version = "1.42.0"